com.pingidentity.pa.sdk.policy.error

Class OAuthPolicyErrorHandlingCallback

java.lang.Object

com.pingidentity.pa.sdk.policy.error.OAuthPolicyErrorHandlingCallback

All Implemented Interfaces:

ErrorHandlingCallback

public class OAuthPolicyErrorHandlingCallback
extends Object
implements ErrorHandlingCallback

OAuthPolicyErrorHandlingCallback is used to respond to an OAuth policy failure. It will set the WWW-Authenticate header with the realm configured for the application and provided scope, error, error_description, and error_uri as defined in RFC6750.

Constructor Summary

Constructors

Constructor and Description
OAuthPolicyErrorHandlingCallback(ErrorHandlerConfiguration errorHandlerConfiguration, TemplateRenderer renderer, Set<String> scopes, String error, String errorDescription, String errorUri) Creates a new OAuthPolicyErrorHandlingCallback.

Method Summary

Modifier and Type	Method and Description
void	writeErrorResponse(Exchange exchange) This method implements writing responses when errors are encountered.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthPolicyErrorHandlingCallback

public OAuthPolicyErrorHandlingCallback(ErrorHandlerConfiguration errorHandlerConfiguration,
                                        TemplateRenderer renderer,
                                        Set<String> scopes,
                                        String error,
                                        String errorDescription,
                                        String errorUri)

Creates a new OAuthPolicyErrorHandlingCallback. All values added to the WWW-Authenticate header should be well formed as outlined by RFC6750. No validation is done.

Parameters:

errorHandlerConfiguration - the configuration for the response code, status message, content type, and template, must not be null

renderer - the TemplateRenderer, must not be null

scopes - the required scopes to add to the WWW-Authenticate header, must not be null

error - the error as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

errorDescription - the error_description as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

errorUri - the error_uri as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

Method Detail

writeErrorResponse

public void writeErrorResponse(Exchange exchange)
                        throws IOException

Description copied from interface: ErrorHandlingCallback

This method implements writing responses when errors are encountered.

Specified by:

writeErrorResponse in interface ErrorHandlingCallback

Parameters:

exchange - The exchange to read from and modify.

Throws:

IOException - Indicates when issues are encountered.