Package org.opensaml.messaging.handler.impl

Class HttpServletRequestValidationHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.messaging.handler.impl.HttpServletRequestValidationHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class HttpServletRequestValidationHandler
extends AbstractMessageHandler

Message handler that validates an HTTP request via an instance of HttpServletRequestValidator.

Field Summary

Fields

Modifier and Type	Field	Description
private NonnullSupplier<HttpServletRequest>	httpServletRequestSupplier	The HttpServletRequest being processed.
private org.slf4j.Logger	log	Logger.
private HttpServletRequestValidator	validator	Request validator.

Constructor Summary

Constructors

Constructor	Description
HttpServletRequestValidationHandler()

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext)	Performs the handler logic.
HttpServletRequest	getHttpServletRequest()	Get the HTTP servlet request being processed.
NonnullSupplier<HttpServletRequest>	getHttpServletRequestSupplier()	Get the supplier for HTTP request if available.
HttpServletRequestValidator	getValidator()	Get the request validator.
void	setHttpServletRequestSupplier(NonnullSupplier<HttpServletRequest> requestSupplier)	Set the current HTTP request Supplier.
void	setValidator(HttpServletRequestValidator newValidator)	Set the request validator.

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, doPreInvoke, getActivationCondition, getLogPrefix, invoke, isPreInvokeCalled, setActivationCondition

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
private org.slf4j.Logger log

Logger.

validator

@NonnullAfterInit
private HttpServletRequestValidator validator

Request validator.

httpServletRequestSupplier

@NonnullAfterInit
private NonnullSupplier<HttpServletRequest> httpServletRequestSupplier

The HttpServletRequest being processed.

Constructor Details

HttpServletRequestValidationHandler

public HttpServletRequestValidationHandler()

Method Details

getHttpServletRequest

@NonnullAfterInit
public HttpServletRequest getHttpServletRequest()

Get the HTTP servlet request being processed.

Returns:

Returns the request.

getHttpServletRequestSupplier

@NonnullAfterInit
public NonnullSupplier<HttpServletRequest> getHttpServletRequestSupplier()

Get the supplier for HTTP request if available.

Returns:

current HTTP request

setHttpServletRequestSupplier

public void setHttpServletRequestSupplier(@Nullable
 NonnullSupplier<HttpServletRequest> requestSupplier)

Set the current HTTP request Supplier.

Parameters:

requestSupplier - Supplier for the current HTTP request

getValidator

@NonnullAfterInit
public HttpServletRequestValidator getValidator()

Get the request validator.

Returns:

the validator

setValidator

public void setValidator(@Nullable
 HttpServletRequestValidator newValidator)

Set the request validator.

Parameters:

newValidator - the request validator

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doInvoke

protected void doInvoke(@Nonnull
 MessageContext messageContext)
                 throws MessageHandlerException

Performs the handler logic.

Specified by:

doInvoke in class AbstractMessageHandler

Parameters:

messageContext - the message context on which to invoke the handler

Throws:

MessageHandlerException - if there is an error invoking the handler on the message context