Package net.officefloor.web.security.build

Class AbstractHttpSecurable

java.lang.Object

net.officefloor.web.security.build.AbstractHttpSecurable

All Implemented Interfaces:

HttpSecurable, HttpSecurableBuilder

public abstract class AbstractHttpSecurable
extends java.lang.Object
implements HttpSecurable, HttpSecurableBuilder

Abstract HttpSecurable implementation to be configured as HttpSecurableBuilder.

This is useful to extend for configuration items requiring to be configured HTTP secure.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
AbstractHttpSecurable()

Method Summary

Modifier and Type	Method	Description
void	addRequiredRole(java.lang.String requiredRole)	Adds to listing of required roles that must have all for access.
void	addRole(java.lang.String anyRole)	Adds to listing of roles that must have at least one for access.
java.lang.String[]	getAnyRoles()	Obtains the list of roles that must have at least one for access.
java.lang.String	getHttpSecurityName()	Obtains the name for the HttpSecurity to use.
java.lang.String[]	getRequiredRoles()	Obtains the list of roles that must have all for access.
void	setHttpSecurityName(java.lang.String httpSecurityName)	Specifies the particular HttpSecurity.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHttpSecurable

public AbstractHttpSecurable()

Method Detail

getHttpSecurityName

public java.lang.String getHttpSecurityName()

Description copied from interface: HttpSecurable

Obtains the name for the HttpSecurity to use. May be null if generic HttpSecurity.

Specified by:

getHttpSecurityName in interface HttpSecurable

Returns:

Name of HttpSecurity or null for generic HttpSecurity.

getAnyRoles

public java.lang.String[] getAnyRoles()

Description copied from interface: HttpSecurable

Obtains the list of roles that must have at least one for access.

Empty/null list means needs only be authenticated.

Specified by:

getAnyRoles in interface HttpSecurable

Returns:

List of any roles.

getRequiredRoles

public java.lang.String[] getRequiredRoles()

Description copied from interface: HttpSecurable

Obtains the list of roles that must have all for access.

Empty/null list means needs only be authenticated.

Specified by:

getRequiredRoles in interface HttpSecurable

Returns:

List of required roles.

setHttpSecurityName

public void setHttpSecurityName(java.lang.String httpSecurityName)

Description copied from interface: HttpSecurableBuilder

Specifies the particular HttpSecurity.

Specified by:

setHttpSecurityName in interface HttpSecurableBuilder

Parameters:

httpSecurityName - Name of the HttpSecurity to use.

addRole

public void addRole(java.lang.String anyRole)

Description copied from interface: HttpSecurableBuilder

Adds to listing of roles that must have at least one for access.

Specified by:

addRole in interface HttpSecurableBuilder

Parameters:

anyRole - Any role.

addRequiredRole

public void addRequiredRole(java.lang.String requiredRole)

Description copied from interface: HttpSecurableBuilder

Adds to listing of required roles that must have all for access.

Specified by:

addRequiredRole in interface HttpSecurableBuilder

Parameters:

requiredRole - Required roles.