Class MirrorAuthenticator

java.lang.Object

org.deltava.security.SQLAuthenticator

org.deltava.security.MultiAuthenticator

org.deltava.security.MirrorAuthenticator

All Implemented Interfaces:

Closeable, AutoCloseable, Authenticator

public class MirrorAuthenticator
extends MultiAuthenticator

An Authenticator used to mirror data from one authenticator to another. When a user is sucessfully authenticated by the first ("source") Authenticator, the directory name and password are written into the second ("destination") Authenticator.

Since:

1.0

Version:

11.1

Author:

Luke

Field Summary

Fields inherited from class MultiAuthenticator

_dst, _src, log

Modifier and Type	Field	Description
protected final SequencedCollection<Authenticator>	_dst	The "destination" authenticators.
protected Authenticator	_src	The "source" authenticator.
protected final Logger	log	The log4j logger.

Fields inherited from class SQLAuthenticator

_props

Modifier and Type	Field	Description
protected final Properties	_props

Fields inherited from interface Authenticator

DEFAULT_PROPS_FILE

Modifier and Type	Field	Description
static final String	DEFAULT_PROPS_FILE	Default properties file used for authenticator configuration options.

Constructor Summary

Constructors

Constructor	Description
MirrorAuthenticator()	Creates the Authenticator.

Method Summary

Modifier and Type	Method	Description
void	add(Person usr, String pwd)	Adds the user to all authenticators.
void	authenticate(Person usr, String pwd)	Authenticates the user against the source authenticator.
boolean	contains(Person usr)	Returns if the source and destination authenticators contain a particular directory name.
void	disable(Person usr)	Disables a User's account in all authenticators.
void	init(String propsFile)	Initializes the Authenticator.
void	remove(Person usr)	Removes the user from all authenticators.
void	rename(Person usr, String newName)	Renames the user in all authenticators.
void	updatePassword(Person usr, String pwd)	Updates the user's password in all authenticators.

Methods inherited from class MultiAuthenticator

accepts, clearConnection, getDestination, getSource, init, removeDestination, setConnection, sync

Modifier and Type	Method	Description
boolean	accepts(Person usr)	Returns whether this Authenticator will accept a new User.
protected static void	clearConnection(Authenticator... auths)	Checks if authenticators are a SQLAuthenticator and if so clears the an explicit Connection to use.
final Collection<Authenticator>	getDestination()	Returns the Destination Authenticators.
final Authenticator	getSource()	Returns the Source Authenticator.
protected void	init(String propsFile, String authPrefix)	Initializes the authenticator.
void	removeDestination(Person usr)	Removes the specified user from any destination Authenticators, while retaining the user in the source directory.
protected void	setConnection(Authenticator... auths)	Checks if authenticators are a SQLAuthenticator and if so passes in an explicit Connection to use.
protected void	sync(Person usr, String pwd)	Synchronizes user information between the source and destination authenticators.

Methods inherited from class SQLAuthenticator

close, getConnection, setConnection

Modifier and Type	Method	Description
void	close()	Clears the JDBC connection for an Authenticator to use.
protected Connection	getConnection()	Helper method to return a JDBC connection to the data source.
void	setConnection(Connection c)	Provides the JDBC connection for this Authenticator to use.

Methods inherited from class Object

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

Constructor Details

MirrorAuthenticator

public MirrorAuthenticator()

Creates the Authenticator.

Method Details

init

public void init(String propsFile)
          throws SecurityException

Initializes the Authenticator.

Specified by:

init in interface Authenticator

Overrides:

init in class SQLAuthenticator

Parameters:

propsFile - the name of the proeprties file to load

Throws:

SecurityException - if an error occurs

authenticate

public void authenticate(Person usr,
 String pwd)
                  throws SecurityException

Authenticates the user against the source authenticator. This then synchronizes credentials information with the destination authenticator.

Parameters:

usr - the User bean

pwd - the user's supplied password

Throws:

SecurityException - if authentication fails

See Also:

• Authenticator.authenticate(Person, String)
• MultiAuthenticator.sync(Person, String)

contains

public boolean contains(Person usr)
                 throws SecurityException

Returns if the source and destination authenticators contain a particular directory name.

Parameters:

usr - the user bean

Returns:

TRUE if the source authenticator contains the user, otherwise FALSE

Throws:

SecurityException - if an error occurs

See Also:

• Authenticator.contains(Person)

updatePassword

public void updatePassword(Person usr,
 String pwd)
                    throws SecurityException

Updates the user's password in all authenticators. If this operation fails, no guarantee of transaction atomicity is given.

Parameters:

usr - the user bean

pwd - the user's new password

Throws:

SecurityException - if either update operation fails

add

public void add(Person usr,
 String pwd)
         throws SecurityException

Adds the user to all authenticators. If this operation fails, no guarantee of transaction atomicity is given.

Parameters:

usr - the User bean

pwd - the user's password

Throws:

SecurityException - if either add operation fails

rename

public void rename(Person usr,
 String newName)
            throws SecurityException

Renames the user in all authenticators. If this operation fails, no guarantee of transaction atomicity is given.

Parameters:

usr - the user bean

newName - the new directory name

Throws:

SecurityException - if an error occurs

disable

public void disable(Person usr)
             throws SecurityException

Disables a User's account in all authenticators. If this operation fails, no guarantee of transaction atomicity is given.

Parameters:

usr - the user bean

Throws:

SecurityException - if an error occurs

remove

public void remove(Person usr)
            throws SecurityException

Removes the user from all authenticators. If this operation fails, no guarantee of transaction atomicity is given.

Parameters:

usr - the user bean

Throws:

SecurityException - if an error occurs