com.opensymphony.user.authenticator
Class AbstractAuthenticator

java.lang.Object
  com.opensymphony.user.authenticator.AbstractAuthenticator

All Implemented Interfaces:

Authenticator, java.io.Serializable

Direct Known Subclasses:

JBossAuthenticator, OrionAuthenticator, SmartAuthenticator, WeblogicAuthenticator

public abstract class AbstractAuthenticator

extends java.lang.Object

implements Authenticator, java.io.Serializable

An abstract class which helps simplify the writing of authenticators for new app servers.

Author:

Mike Cannon-Brookes

See Also:

Serialized Form

Field Summary

protected java.util.Properties

properties

Constructor Summary

AbstractAuthenticator()

Method Summary

boolean	init(java.util.Properties properties) Simple method to init and store any passed properties You will probably want to override this in your subclass if you need initialisation
boolean	login(java.lang.String username, java.lang.String password) Implement your server specific login method here.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.user.authenticator.Authenticator

login

Field Detail

properties

protected java.util.Properties properties

Constructor Detail

AbstractAuthenticator

public AbstractAuthenticator()

Method Detail

init

public boolean init(java.util.Properties properties)

Simple method to init and store any passed properties You will probably want to override this in your subclass if you need initialisation

Specified by:

init in interface Authenticator

Parameters:

properties - Extra properties passed across by UserManager.

login

public boolean login(java.lang.String username,
                     java.lang.String password)
              throws AuthenticationException

Implement your server specific login method here.

Specified by:

login in interface Authenticator

Returns:

Whether or not login was successful.

Throws:

AuthenticationException