com.uwyn.rife.authentication.elements
Class AbstractPropertyAuthenticatedDeployer

java.lang.Object
  extended by com.uwyn.rife.engine.ElementDeployer
      extended by com.uwyn.rife.authentication.elements.AuthenticatedDeployer
          extended by com.uwyn.rife.authentication.elements.AbstractPropertyAuthenticatedDeployer
Direct Known Subclasses:
FactoryPropertyAuthenticatedDeployer

public abstract class AbstractPropertyAuthenticatedDeployer
extends AuthenticatedDeployer

Deployer for Authenticated elements that configures the various authentication managers through properties.

Element properties used:

"credentials_class" (required)
The fully qualified name of the class that will be used to store the credentials, this is typically RoleUser
"enable_purging"
When true, the appropriate authentication managers will be wrapped with proxy that purges outdated data on-the-fly without having to run an asynchronous purge thread.
"password_encryption"
The encryption method that will be used for the password, this has to be a valid identifier of a StringEncryptor
"session_duration"
The duration of an authentication session in milliseconds. This defaults to the global authentication session duration that has been setup in the configuration participant.
"remember_duration"
The duration that credential remember IDs are preserved in milliseconds. This defaults to the global remember duration that has been setup in the configuration participant.
"session_purge_frequency"
The purge frequency of the authentication session purging when purging is enabled.
"session_purge_scale"
The purge scale of the authentication session purging when purging is enabled.
"remember_purge_frequency"
The purge frequency of the remember-me purging when purging is enabled.
"remember_purge_scale"
The purge scale of the authentication session purging when purging is enabled.

The frequency of purging is controlled by two properties, "frequency" and "scale". Every (frequency / scale) requests, a purge is performed. For example, if frequency is 1 and scale is 2, a purge is performed on roughly half of requests. If frequency is 2 and scale is 100, a purge is performed on 2 percent of requests.

Since:
1.6
Version:
$Revision: 3643 $
Author:
Steven Grimm (koreth[remove] at midwinter dot com), Geert Bevin (gbevin[remove] at uwyn dot com)

Field Summary
static String PROPERTYNAME_CREDENTIALS_CLASS
           
static String PROPERTYNAME_ENABLE_PURGING
           
static String PROPERTYNAME_PASSWORD_ENCRYPTION
           
static String PROPERTYNAME_REMEMBER_DURATION
           
static String PROPERTYNAME_REMEMBER_PURGE_FREQUENCY
           
static String PROPERTYNAME_REMEMBER_PURGE_SCALE
           
static String PROPERTYNAME_SESSION_DURATION
           
static String PROPERTYNAME_SESSION_PURGE_FREQUENCY
           
static String PROPERTYNAME_SESSION_PURGE_SCALE
           
 
Constructor Summary
AbstractPropertyAuthenticatedDeployer()
           
 
Method Summary
abstract  CredentialsManager createCredentialsManager()
          Creates a CredentialsManager.
abstract  RememberManager createRememberManager()
          Creates a RememberManager.
abstract  SessionManager createSessionManager()
          Creates a SessionManager.
abstract  SessionValidator createSessionValidator()
          Creates a SessionValidator.
 void deploy()
          This method is executed when the deployment should be performed.
 
Methods inherited from class com.uwyn.rife.authentication.elements.AuthenticatedDeployer
getCredentialsClass, getSessionValidator, setCredentialsClass, setSessionValidator
 
Methods inherited from class com.uwyn.rife.engine.ElementDeployer
getElementInfo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTYNAME_CREDENTIALS_CLASS

public static final String PROPERTYNAME_CREDENTIALS_CLASS
See Also:
Constant Field Values

PROPERTYNAME_ENABLE_PURGING

public static final String PROPERTYNAME_ENABLE_PURGING
See Also:
Constant Field Values

PROPERTYNAME_PASSWORD_ENCRYPTION

public static final String PROPERTYNAME_PASSWORD_ENCRYPTION
See Also:
Constant Field Values

PROPERTYNAME_SESSION_DURATION

public static final String PROPERTYNAME_SESSION_DURATION
See Also:
Constant Field Values

PROPERTYNAME_REMEMBER_DURATION

public static final String PROPERTYNAME_REMEMBER_DURATION
See Also:
Constant Field Values

PROPERTYNAME_SESSION_PURGE_FREQUENCY

public static final String PROPERTYNAME_SESSION_PURGE_FREQUENCY
See Also:
Constant Field Values

PROPERTYNAME_SESSION_PURGE_SCALE

public static final String PROPERTYNAME_SESSION_PURGE_SCALE
See Also:
Constant Field Values

PROPERTYNAME_REMEMBER_PURGE_FREQUENCY

public static final String PROPERTYNAME_REMEMBER_PURGE_FREQUENCY
See Also:
Constant Field Values

PROPERTYNAME_REMEMBER_PURGE_SCALE

public static final String PROPERTYNAME_REMEMBER_PURGE_SCALE
See Also:
Constant Field Values
Constructor Detail

AbstractPropertyAuthenticatedDeployer

public AbstractPropertyAuthenticatedDeployer()
Method Detail

createSessionManager

public abstract SessionManager createSessionManager()
Creates a SessionManager.

Returns:
a SessionManager instance
Since:
1.6

createSessionValidator

public abstract SessionValidator createSessionValidator()
Creates a SessionValidator.

Returns:
a SessionValidator instance
Since:
1.6

createCredentialsManager

public abstract CredentialsManager createCredentialsManager()
Creates a CredentialsManager.

Returns:
a CredentialsManager instance
Since:
1.6

createRememberManager

public abstract RememberManager createRememberManager()
Creates a RememberManager.

Returns:
a RememberManager instance
Since:
1.6

deploy

public void deploy()
            throws EngineException
Description copied from class: ElementDeployer
This method is executed when the deployment should be performed.

Specified by:
deploy in class ElementDeployer
Throws:
EngineException


Copyright © 2001-2007 Uwyn sprl/bvba. All Rights Reserved.