de.xima.fc.interfaces.auth

Interface IFormAuthContext

All Superinterfaces:

Serializable

All Known Implementing Classes:

FormAuthContext

public interface IFormAuthContext
extends Serializable

Interface of an form based authentication context

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
void	authorize() Starts the authorization flow of the current context
void	authorize(javax.servlet.FilterChain chain) Starts the authorization flow of the current context
void	callback() Starts the callback handling of the current context
boolean	checkAuthorisation(org.pac4j.core.profile.CommonProfile profile) Checks the authorization of the given profiles against the current context
org.pac4j.core.config.Config	getAuthConfig() Returns the current configuration of the authentication context.
String	getAuthenticatorToken() Get the token of the current IAuthenticator or the name of an internal authenticator
String	getBaseUrl() Get the current base URL
Mandant	getClient() Get the client to which the form belongs.
FRQSession	getFRQSession() Get the current form request session to authenticate with
Locale	getLocale() Returns the locale of the auth context
Map<String,ProjectAuthenticatorConfig>	getProjectAuthConfig() Get the Map of project specific authenticator configurations.
javax.servlet.http.HttpServletRequest	getRequest() Returns the HTTP servlet request
javax.servlet.http.HttpServletResponse	getResponse() Returns the HTTP servlet response
void	logout() Starts the logout from the given authorizations
void	logout(javax.servlet.FilterChain chain) Starts the logout from the given authorizations
void	setAuthenticatorToken(String token) Set the token of the current IAuthenticator

Method Detail

getAuthenticatorToken

String getAuthenticatorToken()

Get the token of the current IAuthenticator or the name of an internal authenticator

Returns:

String token or name

setAuthenticatorToken

void setAuthenticatorToken(String token)

Set the token of the current IAuthenticator

Parameters:

token - The token of the current IAuthenticator or the name of an internal authenticator.

getProjectAuthConfig

Map<String,ProjectAuthenticatorConfig> getProjectAuthConfig()

Get the Map of project specific authenticator configurations.

Returns:

A Map that maps the name (if it is a system authenticator) or callback UUID (if it is a client authenticator) to the corresponding ProjectAuthenticatorConfig.

getClient

Mandant getClient()

Get the client to which the form belongs.

Returns:

The current Mandant to which the form belongs.

getBaseUrl

String getBaseUrl()

Get the current base URL

Returns:

String the base URL

getFRQSession

FRQSession getFRQSession()

Get the current form request session to authenticate with

Returns:

FRQSession to authenticate

getAuthConfig

org.pac4j.core.config.Config getAuthConfig()

Returns the current configuration of the authentication context. If no configuration is present, the configuration will be build and saved.

Returns:

The existing or newly created Config.

getLocale

Locale getLocale()

Returns the locale of the auth context

Returns:

Locale

getRequest

javax.servlet.http.HttpServletRequest getRequest()

Returns the HTTP servlet request

Returns:

HttpServletRequest

getResponse

javax.servlet.http.HttpServletResponse getResponse()

Returns the HTTP servlet response

Returns:

HttpServletResponse

checkAuthorisation

boolean checkAuthorisation(org.pac4j.core.profile.CommonProfile profile)

Checks the authorization of the given profiles against the current context

Parameters:

profile - A CommonProfile to check

Returns:

true if authorized, or false otherwise.

authorize

void authorize()

Starts the authorization flow of the current context

authorize

void authorize(javax.servlet.FilterChain chain)

Starts the authorization flow of the current context

Parameters:

chain - FilterChain to process after the authorization

logout

void logout()

Starts the logout from the given authorizations

logout

void logout(javax.servlet.FilterChain chain)
     throws IOException,
            javax.servlet.ServletException

Starts the logout from the given authorizations

Parameters:

chain - FilterChain to process after the logout

Throws:

IOException - IO-errors while processing the chain

javax.servlet.ServletException - Servlet-errors while processing the chain

callback

void callback()

Starts the callback handling of the current context