atg.userprofiling
Class AccessRightAccessController

java.lang.Object
  atg.userprofiling.AccessRightAccessController

All Implemented Interfaces:

AccessController

public class AccessRightAccessController
extends java.lang.Object
implements AccessController

This class grants or denies access based on whether the given profile has one of the configured access rights.

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

AccessRightAccessController()

Method Summary

boolean	allowAccess(Profile pProfile, DynamoHttpServletRequest pRequest) Returns true if a user (represented by the specified Profile) should be allowed access, false if not.
java.lang.String	getAccessRightNamePropertyName()
java.lang.String	getAccessRightsPropertyName()
java.util.List	getAllowedAccessRightNames()
java.lang.String	getDeniedAccessURL() Returns a URL the user should be redirected to if allowAccess returns false.
java.lang.String	getDeniedAccessURL(Profile pProfile) Returns a URL the user should be redirected to if allowAccess returns false.
void	setAccessRightNamePropertyName(java.lang.String pAccessRightNamePropertyName) The name of the name property of the accessRight item
void	setAccessRightsPropertyName(java.lang.String pAccessRightsPropertyName) The name of the accessRights property of the internalUser
void	setAllowedAccessRightNames(java.util.List pAllowedAccessRightNames) The names of the access rights that will allow access
void	setDeniedAccessURL(java.lang.String pDeniedAccessURL) A URL the user should be redirected to if allowAccess returns false

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

AccessRightAccessController

public AccessRightAccessController()

Method Detail

setAccessRightsPropertyName

public void setAccessRightsPropertyName(java.lang.String pAccessRightsPropertyName)

The name of the accessRights property of the internalUser

Parameters:

pAccessRightPropertyName - the name of the accessRights property of the internalUser

getAccessRightsPropertyName

public java.lang.String getAccessRightsPropertyName()

Returns:

the name of the accessRights property of the internalUser

setAccessRightNamePropertyName

public void setAccessRightNamePropertyName(java.lang.String pAccessRightNamePropertyName)

The name of the name property of the accessRight item

Parameters:

pAccessRightNamePropertyName - the name of the name property of the accessRight item

getAccessRightNamePropertyName

public java.lang.String getAccessRightNamePropertyName()

Returns:

the name of the name property of the accessRights item

setAllowedAccessRightNames

public void setAllowedAccessRightNames(java.util.List pAllowedAccessRightNames)

The names of the access rights that will allow access

Parameters:

pAccessRights - the names of the access rights that will allow access

getAllowedAccessRightNames

public java.util.List getAllowedAccessRightNames()

Returns:

the names of the access rights that will allow access

setDeniedAccessURL

public void setDeniedAccessURL(java.lang.String pDeniedAccessURL)

A URL the user should be redirected to if allowAccess returns false

Parameters:

pDeniedAccessURL - the URL the user should be redirected to if allowAccess returns false

getDeniedAccessURL

public java.lang.String getDeniedAccessURL()

Returns a URL the user should be redirected to if allowAccess returns false.

getDeniedAccessURL

public java.lang.String getDeniedAccessURL(Profile pProfile)

Returns a URL the user should be redirected to if allowAccess returns false.

Specified by:

getDeniedAccessURL in interface AccessController

allowAccess

public boolean allowAccess(Profile pProfile,
                           DynamoHttpServletRequest pRequest)

Returns true if a user (represented by the specified Profile) should be allowed access, false if not.

Specified by:

allowAccess in interface AccessController