Package org.itracker.services.authentication

Class AbstractPluggableAuthenticator

java.lang.Object

org.itracker.services.authentication.AbstractPluggableAuthenticator

All Implemented Interfaces:

org.itracker.core.AuthenticationConstants, PluggableAuthenticator

Direct Known Subclasses:

DefaultAuthenticator

public abstract class AbstractPluggableAuthenticator
extends Object
implements PluggableAuthenticator, org.itracker.core.AuthenticationConstants

This class provides a skeleton implementation of the PluggableAuthenticator interface. It can be extended to provide a new authentication module for ITracker reducing the amount of effort to implement the PluggableAuthenticator interface.

Field Summary

Fields inherited from interface org.itracker.core.AuthenticationConstants

AUTH_TYPE_CERTIFICATE, AUTH_TYPE_PASSWORD_ENC, AUTH_TYPE_PASSWORD_PLAIN, AUTH_TYPE_REQUEST, AUTH_TYPE_SHARED_SECRET, AUTH_TYPE_UNKNOWN, REQ_SOURCE_API, REQ_SOURCE_UNKNOWN, REQ_SOURCE_WEB, UPDATE_TYPE_CORE, UPDATE_TYPE_PERMISSION_ADD, UPDATE_TYPE_PERMISSION_SET, UPDATE_TYPE_PREFERENCE

Constructor Summary

Constructors

Constructor	Description
AbstractPluggableAuthenticator()

Method Summary

Modifier and Type	Method	Description
ConfigurationService	getConfigurationService()	Returns an ConfigurationService session bean that can be used to retreive properties that have been set in the system.
UserService	getUserService()	Returns a UserService session bean that can be used to call needed methods such as retrieving a user.
void	initialize(Map<?,?> values)	This method is called after creating a new instance of the Authenticator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.itracker.services.authentication.PluggableAuthenticator

allowPasswordUpdates, allowPermissionUpdates, allowPreferenceUpdates, allowProfileCreation, allowProfileUpdates, allowRegistration, checkLogin, createProfile, getUserPermissions, getUsersWithProjectPermission, getUsersWithProjectPermission, updateProfile

Constructor Detail

AbstractPluggableAuthenticator

public AbstractPluggableAuthenticator()

Method Detail

initialize

public void initialize(Map<?,?> values)

This method is called after creating a new instance of the Authenticator. It supplies some default EJB objects that the authenticator can use.

Specified by:

initialize in interface PluggableAuthenticator

Parameters:

values - A HashMap that contains some default information. The current calls pass a UserService bean as userService, and an ConfigurationService bean as configurationService

getUserService

public UserService getUserService()
                           throws AuthenticatorException

Returns a UserService session bean that can be used to call needed methods such as retrieving a user.

Returns:

userService

Throws:

AuthenticatorException - an exception if an error occur

getConfigurationService

public ConfigurationService getConfigurationService()
                                             throws AuthenticatorException

Returns an ConfigurationService session bean that can be used to retreive properties that have been set in the system. These properties can be used to provide any needed configuration for the authenticator.

Returns:

configurationService

Throws:

AuthenticatorException - an exception if an error occur