Package org.nuxeo.ecm.platform.web.common.idempotency

Class NuxeoIdempotentFilter

java.lang.Object

javax.servlet.GenericFilter

javax.servlet.http.HttpFilter

org.nuxeo.ecm.platform.web.common.idempotency.NuxeoIdempotentFilter

All Implemented Interfaces:

Serializable, javax.servlet.Filter, javax.servlet.FilterConfig

public class NuxeoIdempotentFilter
extends javax.servlet.http.HttpFilter

Filter handling an idempotency key in POST requests.

If HEADER_KEY is found in the request header, will intercept request handling to:

• mark the request as being processed
• capture the response when request was processed without any error and store it
• return the stored response if a subsequent request with the same key is processed again
• return a conflict response if a request with the same key is processed while the first request is still in progress.

Since:

11.5

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_STORE
protected static final Duration	DEFAULT_TTL
protected static final ByteSize	DEFERRED_OUTPUT_STREAM_THRESHOLD
static final String	HEADER_KEY
protected static final Set<String>	IDEMPOTENT_METHODS
static final String	INFO_SUFFIX
static final String	INPROGRESS_MARKER
protected static final ByteSize	MAX_CONTENT_SIZE
static final String	STORE_PROPERTY
static final String	TTL_DURATION_PROPERTY

Constructor Summary

Constructors

Constructor	Description
NuxeoIdempotentFilter()

Method Summary

Modifier and Type	Method	Description
protected void	doFilter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
protected boolean	doFilterIdempotent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
protected String	getStoreName()
protected Duration	getTTL()

Methods inherited from class javax.servlet.http.HttpFilter

doFilter

Methods inherited from class javax.servlet.GenericFilter

getFilterConfig, getFilterName, getInitParameter, getInitParameterNames, getServletContext, init, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.Filter

destroy

Field Details

HEADER_KEY

public static final String HEADER_KEY

See Also:

• Constant Field Values

STORE_PROPERTY

public static final String STORE_PROPERTY

See Also:

• Constant Field Values

DEFAULT_STORE

public static final String DEFAULT_STORE

See Also:

• Constant Field Values

DEFAULT_TTL

protected static final Duration DEFAULT_TTL

TTL_DURATION_PROPERTY

public static final String TTL_DURATION_PROPERTY

See Also:

• Constant Field Values

INPROGRESS_MARKER

public static final String INPROGRESS_MARKER

See Also:

• Constant Field Values

INFO_SUFFIX

public static final String INFO_SUFFIX

See Also:

• Constant Field Values

DEFERRED_OUTPUT_STREAM_THRESHOLD

protected static final ByteSize DEFERRED_OUTPUT_STREAM_THRESHOLD

MAX_CONTENT_SIZE

protected static final ByteSize MAX_CONTENT_SIZE

IDEMPOTENT_METHODS

protected static final Set<String> IDEMPOTENT_METHODS

Constructor Details

NuxeoIdempotentFilter

public NuxeoIdempotentFilter()

Method Details

getTTL

protected Duration getTTL()

getStoreName

protected String getStoreName()

doFilter

protected void doFilter(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.FilterChain chain)
                 throws IOException,
javax.servlet.ServletException

Overrides:

doFilter in class javax.servlet.http.HttpFilter

Throws:

IOException

javax.servlet.ServletException

doFilterIdempotent

protected boolean doFilterIdempotent(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.FilterChain chain)
                              throws IOException,
javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException