com.pingidentity.pa.sdk.policy

Class AccessExceptionContext

java.lang.Object

com.pingidentity.pa.sdk.policy.AccessExceptionContext

public final class AccessExceptionContext
extends Object

Context data builder used to create an AccessException.

Method Summary

Modifier and Type	Method and Description
AccessExceptionContext	cause(Throwable cause) Sets the AccessException cause.
static AccessExceptionContext	create(HttpStatus status) Creates a new AccessExceptionContext with a specific HTTP response status.
AccessExceptionContext	errorDescription(LocalizedMessage message) Sets the localized error description.
AccessExceptionContext	exceptionMessage(String exceptionMessage) Sets the AccessException message (for logging purposes).

Methods inherited from class java.lang.Object

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

Method Detail

errorDescription

public AccessExceptionContext errorDescription(LocalizedMessage message)

Sets the localized error description.

Parameters:

message - the localized error description (optional, may be null)

Returns:

this context (for method chaining)

See Also:

AccessException.getErrorMessage()

exceptionMessage

public AccessExceptionContext exceptionMessage(String exceptionMessage)

Sets the AccessException message (for logging purposes).

If not explicitly specified, the non-localized status message (HttpStatus.getMessage() will be used for the exception message.

Parameters:

exceptionMessage - the exception message (optional, may be null)

Returns:

this context (for method chaining)

cause

public AccessExceptionContext cause(Throwable cause)

Sets the AccessException cause.

Parameters:

cause - the cause of the exception (optional, may be null)

Returns:

this context (for method chaining)

create

public static AccessExceptionContext create(HttpStatus status)

Creates a new AccessExceptionContext with a specific HTTP response status.

Parameters:

status - the HTTP response status; see AccessException.getErrorStatus()

Returns:

a new AccessExceptionContext