Package net.officefloor.web.spi.security

Interface HttpSecurityActionContext

All Known Subinterfaces:

AuthenticateContext<AC,O,F>, ChallengeContext<O,F>, LogoutContext<O,F>, RatifyContext<AC>

All Known Implementing Classes:

AbstractMockHttpSecurityActionContext, MockHttpAuthenticateContext, MockHttpChallengeContext, MockHttpLogoutContext, MockHttpRatifyContext

public interface HttpSecurityActionContext

Generic context for HttpSecurity actions.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
ServerHttpConnection	getConnection()	Obtains the ServerHttpConnection.
String	getQualifiedAttributeName(String attributeName)	Qualifies the attribute name to this HttpSecurity instance.
HttpRequestState	getRequestState()	Obtains the HttpRequestState.
HttpSession	getSession()	Obtains the HttpSession.

Method Details

getConnection

ServerHttpConnection getConnection()

Obtains the ServerHttpConnection.

Returns:

ServerHttpConnection.

getQualifiedAttributeName

String getQualifiedAttributeName(String attributeName)

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.

Parameters:

attributeName - Name of the attribute.

Returns:

Qualified attribute name to the HttpSecurity instance.

getSession

HttpSession getSession()

Obtains the HttpSession.

Returns:

HttpSession.

getRequestState

HttpRequestState getRequestState()

Obtains the HttpRequestState.

Returns:

HttpRequestState.