com.pingidentity.pa.sdk.policy

Class RuleInterceptorBase<T extends PluginConfiguration>

java.lang.Object

com.pingidentity.pa.sdk.policy.RuleInterceptorBase<T>

Type Parameters:

T - the plugin configuration class

All Implemented Interfaces:

Interceptor, RequestInterceptor, ResponseInterceptor, ConfigurablePlugin<T>, DescribesUIConfigurable, RuleInterceptor<T>

public abstract class RuleInterceptorBase<T extends PluginConfiguration>
extends Object
implements RuleInterceptor<T>

A base class to simplify implementing RuleInterceptor.

Constructor Summary

Constructors

Constructor and Description
RuleInterceptorBase()

Method Summary

Modifier and Type	Method and Description
void	configure(T pluginConfiguration) Default implementation of ConfigurablePlugin.configure(PluginConfiguration).
T	getConfiguration() Returns the provided implementation of PluginConfiguration
TemplateRenderer	getRenderer() Accessor for injected TemplateRenderer
Outcome	handleRequest(Exchange exchange) Default implementation of RequestInterceptor.handleRequest(Exchange) that always returns Outcome.CONTINUE.
void	handleResponse(Exchange exchange) Default implementation of ResponseInterceptor.handleResponse(Exchange) that does nothing.
void	setRenderer(TemplateRenderer renderer) Allows Inject to be used to set the TemplateRenderer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pingidentity.pa.sdk.policy.RuleInterceptor

getErrorHandlingCallback

Methods inherited from interface com.pingidentity.pa.sdk.plugins.DescribesUIConfigurable

getConfigurationFields

Constructor Detail

RuleInterceptorBase

public RuleInterceptorBase()

Method Detail

configure

public void configure(T pluginConfiguration)
               throws javax.validation.ValidationException

Default implementation of ConfigurablePlugin.configure(PluginConfiguration). Acquires configuration for use with getConfiguration() and RuleInterceptor.getErrorHandlingCallback()

Specified by:

configure in interface ConfigurablePlugin<T extends PluginConfiguration>

Parameters:

pluginConfiguration - The expected configuration.

Throws:

javax.validation.ValidationException - Does not validate.

getConfiguration

public T getConfiguration()

Returns the provided implementation of PluginConfiguration

Specified by:

getConfiguration in interface ConfigurablePlugin<T extends PluginConfiguration>

Returns:

the Rule configuration

handleRequest

public Outcome handleRequest(Exchange exchange)
                      throws AccessException

Default implementation of RequestInterceptor.handleRequest(Exchange) that always returns Outcome.CONTINUE.

Specified by:

handleRequest in interface RequestInterceptor

Parameters:

exchange - the Exchange representing the current HTTP transaction

Returns:

an Outcome. Outcome.CONTINUE to proceed to the next interceptor or Outcome.RETURN to indicate processing of the HTTP transaction should not continue. PingAccess may choose to ignore this result for unspecified reasons.

Throws:

AccessException - an alternative to returning an Outcome.RETURN value. The AccessException indicates metadata that may be used to generate a HTTP response.

handleResponse

public void handleResponse(Exchange exchange)
                    throws AccessException

Default implementation of ResponseInterceptor.handleResponse(Exchange) that does nothing.

Specified by:

handleResponse in interface ResponseInterceptor

Parameters:

exchange - Current exchange for processing and manipulation

Throws:

AccessException - to indicate that a specific error response should be generated

setRenderer

@Inject
public void setRenderer(TemplateRenderer renderer)

Allows Inject to be used to set the TemplateRenderer.

Parameters:

renderer - the TemplateRenderer to render the error response

getRenderer

public TemplateRenderer getRenderer()

Accessor for injected TemplateRenderer

Returns:

the TemplateRenderer to render the error response