Package net.shibboleth.sp.profile.impl

Class IssueDiscoveryRequest

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.sp.profile.AbstractAgentRequestAction

net.shibboleth.sp.profile.AbstractAgentAction

net.shibboleth.sp.profile.AbstractApplicationAction

net.shibboleth.sp.profile.impl.IssueDiscoveryRequest

All Implemented Interfaces:

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

public class IssueDiscoveryRequest
extends AbstractApplicationAction

Generates a request to a discovery service per the protocol defined originally by us under the SAML TC at OASIS.

While referred to as a "SAML" discovery mechanism, it is not SAML-specific or SAML-aware in any real sense and is just a generic, insecure, redirect-based mechanism to ask a web site to return a named parameter to a designated return location.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_MESSAGE, EventIds.MESSAGE_PROC_ERROR

Precondition:

The input message has been validated to ensure a InitiatorConstants.DISCOVERY_RETURN_URL parameter is present.,

AgentRequestContext.getOutput().isstruct()

,

AgentRequestContext.getRemotedServletResponse() != null

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	IssueDiscoveryRequest.ApplicationDefaultIssuerStrategy	Derives issuer value from application layer's default settings.
private class	IssueDiscoveryRequest.DefaultPassiveCondition	Default predicate aware of the two "known" protocols, would have to override for others.

Field Summary

Fields

Modifier and Type	Field	Description
private String	discoveryURL	The discovery URL to use.
private DDF	input	Input message.
private String	issuer	Value for "entityID" paremeter in request.
private Function<ProfileRequestContext,String>	issuerLookupStrategy	Strategy used to obtain the request issuer value.
private final org.slf4j.Logger	log	Class logger.
private Predicate<ProfileRequestContext>	passiveCondition	Condition to evaluate to determine passive use.
private String	returnURL	The agent handler URL to return control to.
private Function<ProfileRequestContext,StateDataContext>	stateDataContextLookupStrategy	Strategy used to create the StateDataContext to populate.

Constructor Summary

Constructors

Constructor	Description
IssueDiscoveryRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setIssuerLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the strategy used to locate the issuer value to use.
void	setStateDataContextLookupStrategy(Function<ProfileRequestContext,StateDataContext> strategy)	Sets the strategy used to lookup the StateDataContext.

Methods inherited from class net.shibboleth.sp.profile.AbstractApplicationAction

ensureApplication, getApplication

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentAction

ensureAgent, getAgent

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

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

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

stateDataContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,StateDataContext> stateDataContextLookupStrategy

Strategy used to create the StateDataContext to populate.

issuerLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> issuerLookupStrategy

Strategy used to obtain the request issuer value.

passiveCondition

@Nonnull
private Predicate<ProfileRequestContext> passiveCondition

Condition to evaluate to determine passive use.

input

@NonnullBeforeExec
private DDF input

Input message.

discoveryURL

@NonnullBeforeExec
private String discoveryURL

The discovery URL to use.

issuer

@NonnullBeforeExec
private String issuer

Value for "entityID" paremeter in request.

returnURL

@NonnullBeforeExec
private String returnURL

The agent handler URL to return control to.

Constructor Details

IssueDiscoveryRequest

public IssueDiscoveryRequest()

Constructor.

Method Details

setStateDataContextLookupStrategy

public void setStateDataContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,StateDataContext> strategy)

Sets the strategy used to lookup the StateDataContext.

Parameters:

strategy - lookup strategy

setIssuerLookupStrategy

public void setIssuerLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the strategy used to locate the issuer value to use.

Parameters:

strategy - lookup strategy

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractApplicationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction