public interface Module
This interface defines the methods that must be implemented to create a pluggable authentication module. Classes that implement this interface must contain all the logic needed to authenticate a user's credentails using an external authentication system.
If you implement a pluggable authentication module, you must also implement a corresponding factory for the module. At run time, the processToken(Token) method is invoked and the appropriate authentication token passed. A valid user ID must be returned from an authentication module if the supplied token is deemed valid.
For information about creating pluggable authentication modules, see "Customizing Authentication" in the webMethods Integration Server Administrator's Guide.
ModuleFactory
,
Token
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getMechanism()
Deprecated.
Indicates the type of authentication information (i.e., Token objects) that this module
processes.
|
java.lang.String |
processToken(Token token)
Deprecated.
Authenticates the user information in the specified Token.
|
java.lang.String getMechanism()
Note: The value returned by this method must match the value produced by the getType method in the Token objects that you want this Module to process.
Token.getType()
java.lang.String processToken(Token token)
Note: At run time, an authentication module will only receive Token objects that match the mechanism it supports. For example, if a module is registered as a "basic" mechanism, then it will only receive Token objects whose type is "basic".
token
- A Token containing the authentication information that is to be processed.