org.opensaml.profile.action

Class AbstractProfileAction<InboundMessageType,OutboundMessageType>

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

Type Parameters:

InboundMessageType - type of in-bound message

OutboundMessageType - type of out-bound message

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, ProfileAction<InboundMessageType,OutboundMessageType>

Direct Known Subclasses:

AbstractConditionalProfileAction

@Prototype
public abstract class AbstractProfileAction<InboundMessageType,OutboundMessageType>
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
implements ProfileAction<InboundMessageType,OutboundMessageType>

Base class for profile actions. This base class is annotated with Prototype to indicate that it is stateful.

Field Summary

Fields

Modifier and Type	Field and Description
private HttpServletRequest	httpServletRequest Current HTTP request, if available.
private HttpServletResponse	httpServletResponse Current HTTP response, if available.
private String	logPrefix Cached log prefix.

Constructor Summary

Constructors

Constructor and Description
AbstractProfileAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext) Performs this action.
protected void	doPostExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext) Called after execution, actions may override this method to perform post-processing for a request.
protected void	doPostExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext, Exception e) Called after execution, actions may override this method to perform post-processing for a request.
protected boolean	doPreExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext) Called prior to execution, actions may override this method to perform pre-processing for a request.
void	execute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext) Performs this action.
HttpServletRequest	getHttpServletRequest() Get the current HTTP request if available.
HttpServletResponse	getHttpServletResponse() Get the current HTTP response.
protected String	getLogPrefix() Return a prefix for logging messages for this component.
void	setHttpServletRequest(HttpServletRequest request) Set the current HTTP request.
void	setHttpServletResponse(HttpServletResponse response) Set the current HTTP response.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

logPrefix

@Nullable
private String logPrefix

Cached log prefix.

httpServletRequest

@Nullable
private HttpServletRequest httpServletRequest

Current HTTP request, if available.

httpServletResponse

@Nullable
private HttpServletResponse httpServletResponse

Current HTTP response, if available.

Constructor Detail

AbstractProfileAction

public AbstractProfileAction()

Method Detail

getHttpServletRequest

@Nullable
public HttpServletRequest getHttpServletRequest()

Get the current HTTP request if available.

Returns:

current HTTP request

setHttpServletRequest

public void setHttpServletRequest(@Nullable
                         HttpServletRequest request)

Set the current HTTP request.

Parameters:

request - current HTTP request

getHttpServletResponse

@Nullable
public HttpServletResponse getHttpServletResponse()

Get the current HTTP response.

Returns:

current HTTP response

setHttpServletResponse

public void setHttpServletResponse(@Nullable
                          HttpServletResponse response)

Set the current HTTP response.

Parameters:

response - current HTTP response

execute

public void execute(@Nonnull
           ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Performs this action.

Specified by:

execute in interface ProfileAction<InboundMessageType,OutboundMessageType>

Parameters:

profileRequestContext - the current IdP profile request context

doPreExecute

protected boolean doPreExecute(@Nonnull
                   ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Called prior to execution, actions may override this method to perform pre-processing for a request.

If false is returned, execution will not proceed, and the action should attach an EventContext to the context tree to signal how to continue with overall workflow processing.

If returning successfully, the last step should be to return the result of the superclass version of this method.

Parameters:

profileRequestContext - the current IdP profile request context

Returns:

true iff execution should proceed

doExecute

protected void doExecute(@Nonnull
             ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Performs this action. Actions must override this method to perform their work.

Parameters:

profileRequestContext - the current IdP profile request context

doPostExecute

protected void doPostExecute(@Nonnull
                 ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Called after execution, actions may override this method to perform post-processing for a request.

Actions must not "fail" during this step and will not have the opportunity to signal events at this stage. This method will not be called if doPreExecute(org.opensaml.profile.context.ProfileRequestContext<InboundMessageType, OutboundMessageType>) fails, but is called if an exception is raised by doExecute(org.opensaml.profile.context.ProfileRequestContext<InboundMessageType, OutboundMessageType>).

Parameters:

profileRequestContext - the current IdP profile request context

doPostExecute

protected void doPostExecute(@Nonnull
                 ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext,
                 @Nonnull
                 Exception e)

Called after execution, actions may override this method to perform post-processing for a request.

Actions must not "fail" during this step and will not have the opportunity to signal events at this stage. This method will not be called if doPreExecute(org.opensaml.profile.context.ProfileRequestContext<InboundMessageType, OutboundMessageType>) fails, but is called if an exception is raised by doExecute(org.opensaml.profile.context.ProfileRequestContext<InboundMessageType, OutboundMessageType>).

This version of the method will be called if an exception is raised during execution of the action. The overall action result will be to raise this error, so any errors inadvertently raised by this method will be logged and superseded.

The default implementation simply calls the error-less version of this method.

Parameters:

profileRequestContext - the current IdP profile request context

e - an exception raised by the doExecute(org.opensaml.profile.context.ProfileRequestContext<InboundMessageType, OutboundMessageType>) method

getLogPrefix

@Nonnull
@NotEmpty
protected String getLogPrefix()

Return a prefix for logging messages for this component.

Returns:

a string for insertion at the beginning of any log messages