org.deegree.portal.standard.security.control
Class SecurityHelper

java.lang.Object
  org.deegree.portal.standard.security.control.SecurityHelper

public class SecurityHelper
extends java.lang.Object

Helper class that performs common security access tasks and checks used in the Listener classes.

Version:

$Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $

Author:

Markus Schneider , last edited by: $Author: mschneider $

Constructor Summary

SecurityHelper()

Method Summary

static SecurityAccess	acquireAccess(AbstractListener listener) Tries to acquire a SecurityAccess for the credentials (username, password) stored in the associated HttpSesssion of the given AbstractListener.
static SecurityTransaction	acquireTransaction(AbstractListener listener) Tries to acquire a SecurityTransaction for the credentials (username, password) stored in the associated HttpSesssion.
static Role	checkForAdminOrSubadminRole(SecurityAccess access) Returns the associated 'Administrator'- or 'SUBADMIN:'-role of the token holder.
static void	checkForAdminRole(SecurityAccess access) Tests if the given token is associated with the 'Administrator'-role.
static void	checkSubadminRoleValidity(SecurityAccess access) Tests if the 'SUBADMIN:' and 'Administrator'-roles are all disjoint (so that there are no users that have more than 1 role).
static Role	findAdminForRole(SecurityAccess access, Role role) Returns the administrator (the 'Administrator'- or a 'SUBADMIN:'-role) for the given role.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityHelper

public SecurityHelper()

Method Detail

acquireAccess

public static SecurityAccess acquireAccess(AbstractListener listener)
                                    throws GeneralSecurityException

Tries to acquire a SecurityAccess for the credentials (username, password) stored in the associated HttpSesssion of the given AbstractListener.

Parameters:

listener -

Returns:

SecurityAccess

Throws:

GeneralSecurityException

acquireTransaction

public static SecurityTransaction acquireTransaction(AbstractListener listener)
                                              throws GeneralSecurityException

Tries to acquire a SecurityTransaction for the credentials (username, password) stored in the associated HttpSesssion.

Parameters:

listener -

Returns:

SecurityTransaction

Throws:

GeneralSecurityException

findAdminForRole

public static Role findAdminForRole(SecurityAccess access,
                                    Role role)
                             throws GeneralSecurityException

Returns the administrator (the 'Administrator'- or a 'SUBADMIN:'-role) for the given role.

Parameters:

access -

role -

Returns:

Role

Throws:

GeneralSecurityException

checkForAdminOrSubadminRole

public static Role checkForAdminOrSubadminRole(SecurityAccess access)
                                        throws GeneralSecurityException

Returns the associated 'Administrator'- or 'SUBADMIN:'-role of the token holder.

Parameters:

access -

Returns:

Role

Throws:

GeneralSecurityException

checkForAdminRole

public static void checkForAdminRole(SecurityAccess access)
                              throws GeneralSecurityException

Tests if the given token is associated with the 'Administrator'-role.

Parameters:

access -

Throws:

GeneralSecurityException - , this is an UnauthorizedException if the user does not have the 'Administrator'-role

checkSubadminRoleValidity

public static void checkSubadminRoleValidity(SecurityAccess access)
                                      throws GeneralSecurityException

Tests if the 'SUBADMIN:' and 'Administrator'-roles are all disjoint (so that there are no users that have more than 1 role).

Parameters:

access -

Throws:

GeneralSecurityException - if there is a user with more than one role