Uses of Class
org.forgerock.openam.plugins.PluginException

Packages that use PluginException

Package	Description
org.forgerock.openam.auth.node.api	This package contains the API for writing authentication nodes.
org.forgerock.openam.plugins	This package contains the API for writing AM plugins.

Uses of PluginException in org.forgerock.openam.auth.node.api

Methods in org.forgerock.openam.auth.node.api that throw PluginException

Modifier and Type	Method and Description
void	AbstractNodeAmPlugin.onInstall()
void	AbstractNodeAmPlugin.onStartup(StartupType startupType)
void	AbstractNodeAmPlugin.upgrade(String fromVersion)

Uses of PluginException in org.forgerock.openam.plugins

Methods in org.forgerock.openam.plugins that throw PluginException

Modifier and Type	Method and Description
void	PluginTools.addAuthModule(Class<?> moduleClass, InputStream inputStream) Add a new Auth Module - also registers the SMS service.
void	PluginTools.addSmsService(InputStream inputStream) Add a new SMS service.
void	PluginTools.installAuthNode(Class<?> nodeClass) Installs a new authentication node.
void	PluginTools.installSecretsStoreType(Class<?> secretsStoreClass) Installs and registers a secrets store type for use in obtaining secrets for services.
void	PluginTools.installService(Class<?> serviceClass) Installs an annotated service class.
default void	AmPlugin.onAmUpgrade(String fromVersion, String toVersion) Handle AM system upgrade.
void	AmPlugin.onInstall() Handle plugin installation.
default void	AmPlugin.onStartup() Deprecated. Use AmPlugin.onStartup(StartupType) instead.
default void	AmPlugin.onStartup(StartupType startupType) Handle plugin startup.
default void	AmPlugin.onUnsatisfiedDependency(Set<String> missingDependencies) This method will be called if the plugin has previously been installed, but the dependencies cannot currently be satisfied.
void	PluginTools.registerAuthNode(Class<?> nodeClass) Deprecated. Use PluginTools.installAuthNode(Class) and PluginTools.startAuthNode(Class) as appropriate.
void	PluginTools.registerService(Class<?> serviceClass) Deprecated. Use PluginTools.installService(Class) and PluginTools.startService(Class) as appropriate.
void	PluginTools.startAuthNode(Class<?> nodeClass) Starts an existing authentication node.
void	PluginTools.startSecretsStoreType(Class<?> secretsStoreClass) Installs and registers a secrets store type for use in obtaining secrets for services.
void	PluginTools.startService(Class<?> serviceClass) Installs an annotated service class.
void	PluginTools.uninstallAuthNode(Class<?> nodeClass) Uninstalls and de-registers an authentication node for execution by trees.
default void	AmPlugin.upgrade(String fromVersion) This method will be called when the version returned by AmPlugin.getPluginVersion() is higher than the version already installed.
void	PluginTools.upgradeAuthNode(Class<?> nodeClass) Upgrades an existing authentication node.