Package org.mapfish.print.config.access

Class RoleAccessAssertion

java.lang.Object

org.mapfish.print.config.access.RoleAccessAssertion

All Implemented Interfaces:

AccessAssertion, ConfigurationObject

public final class RoleAccessAssertion
extends java.lang.Object
implements AccessAssertion

An access assertion that verifies that the current user has the required roles.

Constructor Summary

Constructors

Constructor	Description
RoleAccessAssertion()

Method Summary

Modifier and Type	Method	Description
void	assertAccess(java.lang.String resourceDescription, java.lang.Object protectedResource)	Checks that the user can access the resource.
AccessAssertion	copy()	Deep copy of this access assertion.
boolean	equals(java.lang.Object o)
int	hashCode()
org.json.JSONObject	marshal()	Encode the assertion as JSON for later loading.
AccessAssertion	setRequiredRoles(java.util.Collection<java.lang.String> assertionRequiredRoles)	Set the roles required to allow access.
void	unmarshal(org.json.JSONObject encodedAssertion)	Load the assertion properties from the JSON data.
void	validate(java.util.List<java.lang.Throwable> validationErrors, Configuration configuration)	validate that the configuration was correct.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleAccessAssertion

public RoleAccessAssertion()

Method Detail

setRequiredRoles

public AccessAssertion setRequiredRoles(java.util.Collection<java.lang.String> assertionRequiredRoles)

Set the roles required to allow access. If not roles then the user must be logged in but does not have to have any particular role.

This method may only be called once, any subsequent calls will result in errors.

Parameters:

assertionRequiredRoles - the roles required to access the protected resource

assertAccess

public void assertAccess(java.lang.String resourceDescription,
                         java.lang.Object protectedResource)

Description copied from interface: AccessAssertion

Checks that the user can access the resource.

Will throw AuthenticationCredentialsNotFoundException if the user has not logged in or supplied credentials.

Will throw AccessDeniedException if the user is logged in but may not access the resource.

Specified by:

assertAccess in interface AccessAssertion

Parameters:

resourceDescription - a string describing the resource for logging and exception throwing purposes

protectedResource - the resource being protected.

marshal

public org.json.JSONObject marshal()

Description copied from interface: AccessAssertion

Encode the assertion as JSON for later loading. Each call should return a unique JSON object.

Specified by:

marshal in interface AccessAssertion

unmarshal

public void unmarshal(org.json.JSONObject encodedAssertion)

Description copied from interface: AccessAssertion

Load the assertion properties from the JSON data.

Specified by:

unmarshal in interface AccessAssertion

Parameters:

encodedAssertion - the assertion encoded as JSON.

validate

public void validate(java.util.List<java.lang.Throwable> validationErrors,
                     Configuration configuration)

Description copied from interface: ConfigurationObject

validate that the configuration was correct.

Specified by:

validate in interface ConfigurationObject

Parameters:

validationErrors - a list to add any detected errors to.

configuration - the containing configuration

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

copy

public AccessAssertion copy()

Description copied from interface: AccessAssertion

Deep copy of this access assertion.

Specified by:

copy in interface AccessAssertion

Returns:

the copy