com.uwyn.rife.authentication
Class SessionValidatorRetriever

java.lang.Object
  com.uwyn.rife.authentication.SessionValidatorRetriever

public abstract class SessionValidatorRetriever
extends Object

This abstract class provides the functionalities to retrieve a SessionValidator from a particular Authenticated element in a site.

Since you can have many authentication schemes and backends being active in a single web application. it's quite verbose to retrieve a SessionValidator when you want to perform some operations on its stored credentials. This class provides the functionalities to quickly perform this retrieval.

Since:

1.0

Version:

$Revision: 3643 $

Author:

Geert Bevin (gbevin[remove] at uwyn dot com), JR Boyens (gnu-jrb[remove] at gmx dot net)

See Also:

SessionValidator, Authenticated

Constructor Summary

SessionValidatorRetriever()

Method Summary

static SessionValidator	getSessionValidator(ElementInfo authElementInfo) Retrieves a SessionValidator manager from an Authenticated element in a Site.
static SessionValidator	getSessionValidator(Site site, String authElementId, ElementInfo reference) Retrieves a SessionValidator manager from an Authenticated element in a Site.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionValidatorRetriever

public SessionValidatorRetriever()

Method Detail

getSessionValidator

public static SessionValidator getSessionValidator(Site site,
                                                   String authElementId,
                                                   ElementInfo reference)

Retrieves a SessionValidator manager from an Authenticated element in a Site.

Parameters:

site - the site in which the authenticated element is declared

authElementId - the absolute ID of the authenticated element that provides all the authentication related managers

reference - a reference element against which to resolve the id; or null if the provided id is absolute

Throws:

AuthenticatedElementNotFoundException - when the element ID couldn't be found in the site

NotAuthenticatedElementException - when the element ID doesn't refer to an Authenticated element

Since:

1.0

getSessionValidator

public static SessionValidator getSessionValidator(ElementInfo authElementInfo)

Retrieves a SessionValidator manager from an Authenticated element in a Site.

Parameters:

authElementInfo - the ElementInfo of the authenticated element that provides all the authentication related managers

Throws:

NotAuthenticatedElementException - when the provided element info doesn't refer to an Authenticated element

Since:

1.4