com.uwyn.rife.authentication.credentialsmanagers
Class RoleUsersManagerRetriever

java.lang.Object
  com.uwyn.rife.authentication.credentialsmanagers.RoleUsersManagerRetriever

public abstract class RoleUsersManagerRetriever
extends Object

This abstract class provides the functionalities to retrieve a RoleUsersManager 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 RoleUsersManager 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:

RoleUsersManager, Authenticated

Constructor Summary

RoleUsersManagerRetriever()

Method Summary

static RoleUsersManager

getRoleUsersManager(Site site, String authElementId, ElementInfo reference) Retrieves a RoleUsersManager 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

RoleUsersManagerRetriever

public RoleUsersManagerRetriever()

Method Detail

getRoleUsersManager

public static RoleUsersManager getRoleUsersManager(Site site,
                                                   String authElementId,
                                                   ElementInfo reference)

Retrieves a RoleUsersManager 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 the RoleUsersManager

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

NotRoleUsersManagedException - when the CredentialsManager of the Authenticated element is not a RoleUsersManager

Since:

1.0