org.jboss.as.domain.management.plugin

Class AbstractPlugIn

java.lang.Object

org.jboss.as.domain.management.plugin.AbstractPlugIn

All Implemented Interfaces:

AuthenticationPlugIn<Credential>, AuthorizationPlugIn, PlugInConfigurationSupport

public abstract class AbstractPlugIn
extends Object
implements AuthenticationPlugIn<Credential>, AuthorizationPlugIn, PlugInConfigurationSupport

An abstract plug-in implementation that can be extended as an alternative to implementing the interfaces.

Author:

Darran Lofthouse

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	configuration
protected String[]	roles
protected Map<String,Object>	sharedState

Constructor Summary

Constructors

Constructor and Description
AbstractPlugIn()

Method Summary

Methods

Modifier and Type	Method and Description
void	init(Map<String,String> configuration, Map<String,Object> sharedState) Initialisation method called before any request to pass in plug-in configuration and a shared state map to share state between multiple plug-ins handling the same request.
Identity<Credential>	loadIdentity(String userName, String realm) Load the identity for the given username and realm.
String[]	loadRoles(String userName, String realm) Load and return a list of the roles for the given username and realm.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected Map<String,String> configuration

sharedState

protected Map<String,Object> sharedState

roles

protected String[] roles

Constructor Detail

AbstractPlugIn

public AbstractPlugIn()

Method Detail

init

public void init(Map<String,String> configuration,
        Map<String,Object> sharedState)
          throws IOException

Description copied from interface: PlugInConfigurationSupport

Initialisation method called before any request to pass in plug-in configuration and a shared state map to share state between multiple plug-ins handling the same request. This method will not be called until we are ready to use the plug-in so unless this method fails one of the plug-in methods will be used to retrieve information. Where an authentication plug-in and an authorization plug-in are defined init will be called on the authentication plug-in first and on the authorization plug-in second. The call on the authorization plug-in will only happen if the authentication step was a success. Updates to the shared state by the authentication plug-in will be visible by the authorization plug-in during the call to it's init method. We reserve the right to include generic items ourselves within the provided configuration, for this reason plug-ins should not reject a configuration just because some contents are not understood.

Specified by:

init in interface PlugInConfigurationSupport

Parameters:

configuration - - The defined configuration for this plug-in. This Map is shared between all instances of the plug-in and is not modifiable.

sharedState - - A Map of shared state to be shared by all plug-ins handling the same request.

Throws:

IOException - If the plug-in can not complete the initialisation successfully.

See Also:

PlugInConfigurationSupport.init(java.util.Map, java.util.Map)

loadIdentity

public Identity<Credential> loadIdentity(String userName,
                                String realm)
                                  throws IOException

Description copied from interface: AuthenticationPlugIn

Load the identity for the given username and realm. The returned identity contains the credential that will be used for verification of the remote user in the authentication process.

Specified by:

loadIdentity in interface AuthenticationPlugIn<Credential>

Parameters:

userName - - The username supplied by the user.

realm - - Either the realm supplied by the user or the name of the realm this plug-in is executing within.

Returns:

The identity requested.

Throws:

IOException - - If there is any problem loading the identity or if the identity is not found.

See Also:

AuthenticationPlugIn.loadIdentity(java.lang.String, java.lang.String)

loadRoles

public String[] loadRoles(String userName,
                 String realm)
                   throws IOException

Description copied from interface: AuthorizationPlugIn

Load and return a list of the roles for the given username and realm. The username and realm supplied here will be the same as supplied to the AuthenticationPlugIn, the reason they are supplied again is that plug-ins are not required to work together so there may be no shared state. For plug-ins working together or for when the same plug-in is used for authentication and authorization it is safe to assume that this method is being called for the same user.

Specified by:

loadRoles in interface AuthorizationPlugIn

Parameters:

userName - - The username supplied by the user.

realm - - Either the realm supplied by the user or the name of the realm this plug-in is executing within.

Returns:

A list of the users roles.

Throws:

IOException - - If an error occurs loading the roles or if the identity can not be found.

See Also:

AuthorizationPlugIn.loadRoles(java.lang.String, java.lang.String)