Package org.forgerock.openig.filter

Class RetryFilter

java.lang.Object

org.forgerock.openig.filter.RetryFilter

All Implemented Interfaces:

Filter

public final class RetryFilter
extends Object
implements Filter

A RetryFilter is responsible for re-executing the incoming request should it fail with a runtime exception or if an optional condition expression evaluates to true.

Each retry is scheduled to be executed after a delay, without blocking the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RetryFilter.Builder	A RetryFilter builder.

Method Summary

Modifier and Type	Method	Description
static RetryFilter.Builder	builder(ScheduledExecutorService executorService, org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry)	Create a RetryFilter builder.
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

Method Details

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.

builder

public static RetryFilter.Builder builder(ScheduledExecutorService executorService,
 org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry)

Create a RetryFilter builder.

Parameters:

executorService - the executor service to use

meterRegistry - the meter registry

Returns:

a RetryFilter builder