Package net.officefloor.web.security

Class AuthenticationRequiredException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.officefloor.web.security.AuthenticationRequiredException

All Implemented Interfaces:

Serializable

public class AuthenticationRequiredException
extends RuntimeException

Escalation indicating authentication is required.

This may be thrown by any functionality as the WebArchitect is expected to catch this Escalation at the Office level and issue a challenge to the client.

Author:

Daniel Sagenschneider

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationRequiredException()	Initiate for any HttpSecurity.
AuthenticationRequiredException(String requiredHttpSecurityName)	Initiate for a specific HttpSecurity.

Method Summary

Modifier and Type	Method	Description
String	getRequiredHttpSecurityName()	Obtains the required HttpSecurity name.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationRequiredException

public AuthenticationRequiredException()

Initiate for any HttpSecurity.

AuthenticationRequiredException

public AuthenticationRequiredException(String requiredHttpSecurityName)

Initiate for a specific HttpSecurity.

Parameters:

requiredHttpSecurityName - Name of the specific HttpSecurity required. May be null to indicate any configured HttpSecurity.

Method Details

getRequiredHttpSecurityName

public String getRequiredHttpSecurityName()

Obtains the required HttpSecurity name.

Returns:

Required HttpSecurity name or null if any HttpSecurity.