com.pmease.quickbuild.security
Class Authenticator

java.lang.Object
  extended by com.pmease.quickbuild.extensionpoint.support.TypeInstance
      extended by com.pmease.quickbuild.security.Authenticator
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
FailSafeAuthenticator

public abstract class Authenticator
extends TypeInstance

The authenticator base class. All authenticator classes should extend from this class.

See Also:
Serialized Form

Constructor Summary
Authenticator()
           
 
Method Summary
abstract  AuthenticationResult authenticate(java.lang.String userName, java.lang.String password)
          Authenticate specified user name and password against the authentication system represented by this authenticator.
 java.lang.String getDefaultGroupName()
           
 java.lang.String getDescription()
          Get description of the authenticator.
abstract  java.lang.String getEmail(java.lang.String userName)
          Get email address of specified user in the authentication system represented by this authenticator.
 java.lang.String getName()
          Get name of the authenticator.
 boolean isDisabled()
           
 void setDefaultGroupName(java.lang.String defaultGroupName)
           
 void setDescription(java.lang.String description)
           
 void setDisabled(boolean disabled)
           
 void setName(java.lang.String name)
           
 
Methods inherited from class com.pmease.quickbuild.extensionpoint.support.TypeInstance
getPlugin
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Authenticator

public Authenticator()
Method Detail

getName

@NotEmpty
public java.lang.String getName()
Get name of the authenticator.

Returns:

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()
Get description of the authenticator.

Returns:

setDescription

public void setDescription(java.lang.String description)

isDisabled

public boolean isDisabled()

setDisabled

public void setDisabled(boolean disabled)

getDefaultGroupName

public java.lang.String getDefaultGroupName()

setDefaultGroupName

public void setDefaultGroupName(java.lang.String defaultGroupName)

authenticate

public abstract AuthenticationResult authenticate(java.lang.String userName,
                                                  java.lang.String password)
Authenticate specified user name and password against the authentication system represented by this authenticator.

Parameters:
userName - user name to check
password - password to check
Returns:
authentication result if successful. Null should be returned if user not found or password is incorrect.

getEmail

public abstract java.lang.String getEmail(java.lang.String userName)
Get email address of specified user in the authentication system represented by this authenticator.

Parameters:
userName -
Returns:
null if user of specified name does not exist in the authentication


Copyright © 2005-2010 PMEase Inc. All Rights Reserved.