com.pmease.quickbuild.security
Class Authenticator
java.lang.Object
com.pmease.quickbuild.extensionpoint.support.TypeInstance
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
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Authenticator
public Authenticator()
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 checkpassword
- password to check. If this parameter is null, this method should
return information about the user without checking the password
- Returns:
- authentication result if successful. Null should be returned if
user not found or password is incorrect.
Copyright © 2005-2010 PMEase Inc. All Rights Reserved.