public interface PluginTools
com.sun.identity.sm.ServiceSchemaManager
Modifier and Type | Method and Description |
---|---|
void |
addAuthModule(Class<?> moduleClass,
InputStream inputStream)
Add a new Auth Module - also registers the SMS service.
|
void |
addNodeToRegistry(Class<?> nodeClass)
Adds the node to the registry of nodes.
|
void |
addSmsService(InputStream inputStream)
Add a new SMS service.
|
void |
installAuthNode(Class<?> nodeClass)
Installs a new authentication node.
|
void |
registerAuthNode(Class<?> nodeClass)
Deprecated.
|
void |
registerSecretsStoreType(Class<?> secretsStoreClass)
Installs and registers a secrets store type for use in obtaining secrets for services.
|
void |
registerService(Class<?> serviceClass)
Deprecated.
|
void |
startAuthNode(Class<?> nodeClass)
Starts an existing authentication node.
|
void |
upgradeAuthNode(Class<?> nodeClass)
Upgrades an existing authentication node.
|
void addSmsService(InputStream inputStream) throws PluginException
inputStream
- A stream from which the service schema XML can be read.PluginException
- If the service cannot be registered.void addAuthModule(Class<?> moduleClass, InputStream inputStream) throws PluginException
moduleClass
- The com.sun.identity.authentication.spi.AMLoginModule
class.inputStream
- A stream from which the service schema XML can be read.PluginException
- If either the auth module or the underlying service cannot be registered.@Deprecated void registerAuthNode(Class<?> nodeClass) throws PluginException
This method should be called both on plugin installation and on plugin startup.
nodeClass
- The org.forgerock.openam.auth.node.api.Node
class.PluginException
- If the auth node does not implement the Node
interface, or cannot be registered
for some other reason.IllegalArgumentException
- If the nodeClass is not annotated correctly.void registerSecretsStoreType(Class<?> secretsStoreClass) throws PluginException
This method should be called both on plugin installation and on plugin startup.
secretsStoreClass
- The org.forgerock.openam.annotations.sm.Config
-annotated class.PluginException
- If the class cannot be registered for some reason.@Deprecated void registerService(Class<?> serviceClass) throws PluginException
This method should be called both on plugin installation and on plugin startup.
serviceClass
- The org.forgerock.openam.annotations.sm.Config
-annotated class.PluginException
- If the class cannot be registered for some reason.void upgradeAuthNode(Class<?> nodeClass) throws PluginException
This method should be called both on plugin installation and on plugin startup.
nodeClass
- The org.forgerock.openam.annotations.sm.Config
-annotated class.PluginException
- If the class cannot be registered for some reason.IllegalArgumentException
- If the nodeClass is not annotated correctly.void installAuthNode(Class<?> nodeClass) throws PluginException
This method should be called both on plugin installation and on plugin startup.
nodeClass
- The org.forgerock.openam.annotations.sm.Config
-annotated class.PluginException
- If the class cannot be registered for some reason.IllegalArgumentException
- If the nodeClass is not annotated correctly.void addNodeToRegistry(Class<?> nodeClass)
nodeClass
- The org.forgerock.openam.annotations.sm.Config
-annotated class.IllegalArgumentException
- If the nodeClass is not annotated correctly.void startAuthNode(Class<?> nodeClass) throws PluginException
This method should be called both on plugin installation and on plugin startup.
nodeClass
- The org.forgerock.openam.annotations.sm.Config
-annotated class.PluginException
- If the class cannot be registered for some reason.IllegalArgumentException
- If the nodeClass is not annotated correctly.Copyright © 2010-2017, ForgeRock All Rights Reserved.