Modifier and Type | Field and Description |
---|---|
protected PluginTools |
pluginTools
An instance of the
PluginTools for use when setting up the plugin. |
Constructor and Description |
---|
AbstractNodeAmPlugin() |
Modifier and Type | Method and Description |
---|---|
protected Iterable<? extends Class<? extends Node>> |
getNodes()
Deprecated.
in favour of
AbstractNodeAmPlugin.getNodesByVersion() |
protected Map<String,Iterable<? extends Class<? extends Node>>> |
getNodesByVersion()
Retrieve the Map of list of node classes that the plugin is providing.
|
void |
onInstall()
Handle plugin installation.
|
void |
onStartup(StartupType startupType)
Handle plugin startup.
|
void |
setPluginTools(PluginTools pluginTools)
Guice setter for
pluginTools . |
void |
upgrade(String fromVersion)
This method will be called when the version returned by
AmPlugin.getPluginVersion() is higher than the version
already installed. |
getDependencies, getPluginVersion, onAmUpgrade, onShutdown, onStartup, onUnsatisfiedDependency
protected PluginTools pluginTools
PluginTools
for use when setting up the plugin.@Inject public void setPluginTools(PluginTools pluginTools)
pluginTools
.pluginTools
- The tools.public void onInstall() throws PluginException
AmPlugin
AmPlugin.onStartup()
method will be called after this one.onInstall
in interface AmPlugin
PluginException
public void onStartup(StartupType startupType) throws PluginException
AmPlugin
AmPlugin.onInstall()
,
AmPlugin.onAmUpgrade(String, String)
and AmPlugin.upgrade(String)
have been called (if relevant).onStartup
in interface AmPlugin
startupType
- The type of startup that is taking place.PluginException
public void upgrade(String fromVersion) throws PluginException
AmPlugin
AmPlugin.getPluginVersion()
is higher than the version
already installed. This method will be called before the AmPlugin.onStartup()
method.upgrade
in interface AmPlugin
fromVersion
- The old version of the plugin that has been installed.PluginException
protected Map<String,Iterable<? extends Class<? extends Node>>> getNodesByVersion()
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.
@Deprecated protected Iterable<? extends Class<? extends Node>> getNodes()
AbstractNodeAmPlugin.getNodesByVersion()
UnsupportedOperationException
- if called as this method is now deprecated.Copyright © 2010-2017, ForgeRock All Rights Reserved.