Package net.officefloor.web.security.scheme

Class MockHttpRatifyContext<AC extends Serializable>

java.lang.Object

net.officefloor.web.security.scheme.MockHttpRatifyContext<AC>

All Implemented Interfaces:

AccessControlListener<AC>, HttpSecurityActionContext, RatifyContext<AC>

public class MockHttpRatifyContext<AC extends Serializable>
extends Object
implements RatifyContext<AC>

Mock RatifyContext for testing HttpSecuritySource instances.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
MockHttpRatifyContext()	Initiate with no authorization HttpHeader.
MockHttpRatifyContext(String authorizationHeaderValue)	Initiate.
MockHttpRatifyContext(ServerHttpConnection connection)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	accessControlChange(AC accessControl, Throwable escalation)	Notified of a change to access control.
AC	getAccessControl()	Obtains the access control.
ServerHttpConnection	getConnection()	Obtains the ServerHttpConnection.
Throwable	getEscalation()	Obtains the registered escalation.
String	getQualifiedAttributeName(String attributeName)	Qualifies the attribute name to this HttpSecurity instance.
HttpRequestState	getRequestState()	Obtains the HttpRequestState.
HttpSession	getSession()	Obtains the HttpSession.

Methods inherited from class java.lang.Object

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

Constructor Details

MockHttpRatifyContext

public MockHttpRatifyContext()

Initiate with no authorization HttpHeader.

MockHttpRatifyContext

public MockHttpRatifyContext(String authorizationHeaderValue)

Initiate.

Parameters:

authorizationHeaderValue - authorization HttpHeader value.

MockHttpRatifyContext

public MockHttpRatifyContext(ServerHttpConnection connection)

Initiate.

Parameters:

connection - ServerHttpConnection.

Method Details

getAccessControl

public AC getAccessControl()

Obtains the access control.

Returns:

Access control.

getEscalation

public Throwable getEscalation()

Obtains the registered escalation.

Returns:

Escalation.

getConnection

public ServerHttpConnection getConnection()

Description copied from interface: HttpSecurityActionContext

Obtains the ServerHttpConnection.

Specified by:

getConnection in interface HttpSecurityActionContext

Returns:

ServerHttpConnection.

getQualifiedAttributeName

public String getQualifiedAttributeName(String attributeName)

Description copied from interface: HttpSecurityActionContext

Qualifies the attribute name to this HttpSecurity instance.

Multiple HttpSecuritySource instances may be registered for the application. Potentially, some even of the same implementation - likely just configured differently for different needs.

Therefore, may use this method to provide a namespace on the attribute to keep its value isolated to just this instance use of the HttpSecurity.

Specified by:

getQualifiedAttributeName in interface HttpSecurityActionContext

Parameters:

attributeName - Name of the attribute.

Returns:

Qualified attribute name to the HttpSecurity instance.

getSession

public HttpSession getSession()

Description copied from interface: HttpSecurityActionContext

Obtains the HttpSession.

Specified by:

getSession in interface HttpSecurityActionContext

Returns:

HttpSession.

getRequestState

public HttpRequestState getRequestState()

Description copied from interface: HttpSecurityActionContext

Obtains the HttpRequestState.

Specified by:

getRequestState in interface HttpSecurityActionContext

Returns:

HttpRequestState.

accessControlChange

public void accessControlChange(AC accessControl,
 Throwable escalation)

Description copied from interface: AccessControlListener

Notified of a change to access control.

Specified by:

accessControlChange in interface AccessControlListener<AC extends Serializable>

Parameters:

accessControl - Access control. May be null if

• logging out
• failure in authenticating

escalation - Possible Escalation. Will be null if successfully obtain access control or logout.