Package net.shibboleth.oidc.profile.impl

Class AbstractBuildErrorResponseFromEvent<T extends ErrorResponse>

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.oidc.profile.impl.AbstractBuildErrorResponseFromEvent<T>

Type Parameters:

T - ErrorResponse implementation.

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

Direct Known Subclasses:

BuildJSONErrorResponseFromEvent

public abstract class AbstractBuildErrorResponseFromEvent<T extends ErrorResponse>
extends AbstractProfileAction

This action is extended by error response actions. Action reads an event from the configured EventContext lookup strategy, constructs an OIDC error response message and attaches it as the outbound message, if outbound message context was found.

Since:

2.2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ERROR_CODE	Default value for the error code in the error response messages.
static final int	DEFAULT_HTTP_STATUS_CODE	Default value for the HTTP response status code in the HTTP responses.
private String	defaultCode	The code for unmapped events.
private int	defaultStatusCode	The status code for unmapped events.
private Function<ProfileRequestContext,EventContext>	eventContextLookupStrategy	Strategy function for access to EventContext to check.
private final org.slf4j.Logger	log	Class logger.
private Map<String,ErrorObject>	mappedErrors	Map of eventIds to pre-configured error objects.

Constructor Summary

Constructors

Constructor	Description
AbstractBuildErrorResponseFromEvent()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract T	buildErrorResponse(ErrorObject error, ProfileRequestContext profileRequestContext)	Method implemented by the extending class to create ErrorResponse.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setDefaultCode(String code)	Set the code for unmapped events.
void	setDefaultStatusCode(int code)	Set the status code for unmapped events.
void	setEventContextLookupStrategy(Function<ProfileRequestContext,EventContext> strategy)	Set lookup strategy for EventContext to check.
void	setMappedErrors(Map<String,ErrorObject> errors)	Set map of eventIds to pre-configured error objects.

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

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

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, 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

DEFAULT_ERROR_CODE

public static final String DEFAULT_ERROR_CODE

Default value for the error code in the error response messages.

See Also:

• Constant Field Values

DEFAULT_HTTP_STATUS_CODE

public static final int DEFAULT_HTTP_STATUS_CODE

Default value for the HTTP response status code in the HTTP responses.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

eventContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,EventContext> eventContextLookupStrategy

Strategy function for access to EventContext to check.

mappedErrors

private Map<String,ErrorObject> mappedErrors

Map of eventIds to pre-configured error objects.

defaultStatusCode

private int defaultStatusCode

The status code for unmapped events.

defaultCode

private String defaultCode

The code for unmapped events.

Constructor Details

AbstractBuildErrorResponseFromEvent

public AbstractBuildErrorResponseFromEvent()

Constructor.

Method Details

setDefaultStatusCode

public void setDefaultStatusCode(int code)

Set the status code for unmapped events.

Parameters:

code - The default status code for unmapped events.

setDefaultCode

public void setDefaultCode(@Nonnull
 String code)

Set the code for unmapped events.

Parameters:

code - The default status code for unmapped events.

setEventContextLookupStrategy

public void setEventContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,EventContext> strategy)

Set lookup strategy for EventContext to check.

Parameters:

strategy - lookup strategy

setMappedErrors

public void setMappedErrors(@Nonnull
 Map<String,ErrorObject> errors)

Set map of eventIds to pre-configured error objects.

Parameters:

errors - map of eventIds to pre-configured error objects.

buildErrorResponse

@Nullable
protected abstract T buildErrorResponse(@Nonnull
 ErrorObject error,
 @Nonnull
 ProfileRequestContext profileRequestContext)

Method implemented by the extending class to create ErrorResponse.

Parameters:

error - error object to build the response from.

profileRequestContext - profile request context.

Returns:

ErrorResponse

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction