Package org.apereo.cas.configuration.model.core.authentication

Class AuthenticationExceptionsProperties

java.lang.Object

org.apereo.cas.configuration.model.core.authentication.AuthenticationExceptionsProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-core-authentication",
                automated=true)
public class AuthenticationExceptionsProperties
extends Object
implements Serializable

This is AuthenticationExceptionsProperties.

Since:

5.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationExceptionsProperties()

Method Summary

Modifier and Type	Method	Description
List<Class<? extends Throwable>>	getExceptions()	Define custom exceptions that can then be mapped to message bundles for custom error handling.
GroovyAuthenticationExceptionsProperties	getGroovy()	Handle exceptions using a groovy script.
AuthenticationExceptionsProperties	setExceptions(List<Class<? extends Throwable>> exceptions)	Define custom exceptions that can then be mapped to message bundles for custom error handling.
AuthenticationExceptionsProperties	setGroovy(GroovyAuthenticationExceptionsProperties groovy)	Handle exceptions using a groovy script.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationExceptionsProperties

public AuthenticationExceptionsProperties()

Method Details

getExceptions

public List<Class<? extends Throwable>> getExceptions()

Define custom exceptions that can then be mapped to message bundles for custom error handling.

By default CAS is configured to recognize and handle a number of exceptions for during authentication. Each exception has the specific message bundle mapping so that a specific message could be presented to end users on the login form. Any un-recognized or un-mapped exceptions results in a generic message. To map custom exceptions, one would need map the exception, they can be defined here and then linked to custom messages.

getGroovy

public GroovyAuthenticationExceptionsProperties getGroovy()

Handle exceptions using a groovy script.

setExceptions

public AuthenticationExceptionsProperties setExceptions(List<Class<? extends Throwable>> exceptions)

Define custom exceptions that can then be mapped to message bundles for custom error handling.

By default CAS is configured to recognize and handle a number of exceptions for during authentication. Each exception has the specific message bundle mapping so that a specific message could be presented to end users on the login form. Any un-recognized or un-mapped exceptions results in a generic message. To map custom exceptions, one would need map the exception, they can be defined here and then linked to custom messages.

Returns:

this.

setGroovy

public AuthenticationExceptionsProperties setGroovy(GroovyAuthenticationExceptionsProperties groovy)

Handle exceptions using a groovy script.

Returns:

this.