Package org.forgerock.am.iot

Class IotPlugin

java.lang.Object

org.forgerock.openam.auth.node.api.AbstractNodeAmPlugin

org.forgerock.am.iot.IotPlugin

All Implemented Interfaces:

AmPlugin

public class IotPlugin
extends AbstractNodeAmPlugin

Installs the IoT authentication nodes and services.

Field Summary

Fields inherited from class org.forgerock.openam.auth.node.api.AbstractNodeAmPlugin

pluginTools

Constructor Summary

Constructors

Constructor	Description
IotPlugin()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Iterable<? extends Class<? extends Node>>>	getNodesByVersion()	Retrieve the Map of list of node classes that the plugin is providing.
String	getPluginVersion()	The plugin version.
void	upgrade(String fromVersion)	This method will be called when the version returned by AmPlugin.getPluginVersion() is higher than the version already installed.

Methods inherited from class org.forgerock.openam.auth.node.api.AbstractNodeAmPlugin

getNodes, onInstall, onStartup, setPluginTools

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.forgerock.openam.plugins.AmPlugin

getDependencies, getServiceSchemaXML, onAmUpgrade, onShutdown, onStartup, onUnsatisfiedDependency

Constructor Detail

IotPlugin

public IotPlugin()

Method Detail

getPluginVersion

public String getPluginVersion()

Description copied from interface: AmPlugin

The plugin version. This must be in semver (semantic version) format.

Returns:

The version of the plugin.

See Also:

Semantic Versioning

upgrade

public void upgrade(String fromVersion)
             throws PluginException

Description copied from interface: AmPlugin

This method will be called when the version returned by AmPlugin.getPluginVersion() is higher than the version already installed. This method will be called before the AmPlugin.onStartup() method.

Specified by:

upgrade in interface AmPlugin

Overrides:

upgrade in class AbstractNodeAmPlugin

Parameters:

fromVersion - The old version of the plugin that has been installed.

Throws:

PluginException

getNodesByVersion

protected Map<String,Iterable<? extends Class<? extends Node>>> getNodesByVersion()

Description copied from class: AbstractNodeAmPlugin

Retrieve the Map of list of node classes that the plugin is providing. The mappings returned describe which nodes have been introduced in which version of this plugin. For example:

     return ImmutableMap.of(
             "1.0.0", asList(ChoiceCollectorNode.class),
             "2.0.0", asList(SetPersistentCookieNode.class));
 

Tells that this node plugin's 1.0.0 version has introduced the ChoiceCollectorNode, the 2.0.0 version has introduced the SetPersistentCookieNode.

Overrides:

getNodesByVersion in class AbstractNodeAmPlugin

Returns:

The list of node classes.