Package org.forgerock.openig.openam

Class AbstractConditionAdviceFilter

java.lang.Object

org.forgerock.openig.openam.AbstractConditionAdviceFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

CdSsoConditionAdviceFilter

public abstract class AbstractConditionAdviceFilter
extends Object
implements Filter

Abstract Filter base class providing policy condition advice support.

Field Summary

Fields

Modifier and Type	Field	Description
protected AmService	amService	AmService instance supporting policy advice verification.
protected org.forgerock.openig.openam.AbstractConditionAdviceFilter.AdviceFormatter.Encoder	formatEncoder	Deprecated. Since 2023.6 - supports legacy behaviour only

Method Summary

Modifier and Type	Method	Description
protected Optional<Response>	customAdvicesResponse(Context context, Request request, List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices)	Provide extenders a change to provide a custom advices response.
protected abstract Promise<Response,NeverThrowsException>	doRedirect(Context context, Request request, Handler next, List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices, URI originalUri)	Handle redirect to the instance to verify the required advices.
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.

Methods inherited from class java.lang.Object

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

Field Detail

amService

protected final AmService amService

AmService instance supporting policy advice verification.

formatEncoder

@Deprecated(since="2023.6")
protected org.forgerock.openig.openam.AbstractConditionAdviceFilter.AdviceFormatter.Encoder formatEncoder

Deprecated.

Since 2023.6 - supports legacy behaviour only

AbstractConditionAdviceFilter.AdviceFormatter.Encoder to use to encode the advice XML.

Method Detail

filter

public Promise<Response,NeverThrowsException> filter(Context context,
                                                           Request request,
                                                           Handler next)

Description copied from interface: Filter

Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter calls next.handle(context, request).

This method may elect not to pass the request to the next filter or handler, and instead handle the request itself. It can achieve this by merely avoiding a call to next.handle(context, request) and creating its own response object. The filter is also at liberty to replace a response with another of its own by intercepting the response returned by the next handler.

Specified by:

filter in interface Filter

Parameters:

context - The request context.

request - The request.

next - The next filter or handler in the chain to handle the request.

Returns:

A Promise representing the response to be returned to the client.

customAdvicesResponse

protected Optional<Response> customAdvicesResponse(Context context,
                                                   Request request,
                                                   List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices)

Provide extenders a change to provide a custom advices response.

Parameters:

context - the Context.

request - the Request.

advices - a non-empty list of Advices for this request.

Returns:

a custom response or Optional.empty() if there isn't a custom response.

doRedirect

protected abstract Promise<Response,NeverThrowsException> doRedirect(Context context,
                                                                           Request request,
                                                                           Handler next,
                                                                           List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices,
                                                                           URI originalUri)

Handle redirect to the instance to verify the required advices.

Parameters:

context - the Context

request - the Request

next - the Handler

advices - the list of advices to be verified

originalUri - the originalUri, based on UriRouterContext#getOriginalUri, may have been updated based on a call to AuthRedirectContext#notifyImpendingIgRedirectAndUpdateUri

Returns:

a redirect response Promise