net.shibboleth.idp.profile

Class RequestContextBuilder

java.lang.Object

net.shibboleth.idp.profile.RequestContextBuilder

public class RequestContextBuilder
extends Object

Builder used to construct RequestContext used in Action executions.

Field Summary

Fields

Modifier and Type	Field and Description
private HttpServletRequest	httpRequest The HttpServletRequest used when building the request context.
private HttpServletResponse	httpResponse The HttpServletResponse used when building the request context.
private Object	inboundMessage The inbound message.
private String	inboundMessageId The ID of the inbound message.
private long	inboundMessageIssueInstant The issue instant of the inbound message in milliseconds.
private String	inboundMessageIssuer The issuer of the inbound message.
private String	NO_VAL Value used to represent a string value that has not be set.
private Object	outboundMessage The outbound message.
private String	outboundMessageId The ID of the outbound message.
private long	outboundMessageIssueInstant The issue instant of the outbound message in milliseconds.
private String	outboundMessageIssuer The issuer of the outbound message.
private Collection<net.shibboleth.idp.profile.config.ProfileConfiguration>	relyingPartyProfileConfigurations The profile configurations associated with the relying party.
private ServletContext	servletContext The ServletContext used when building the request context.

Constructor Summary

Constructors

Constructor and Description
RequestContextBuilder() Constructor.
RequestContextBuilder(RequestContextBuilder prototype) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.opensaml.messaging.context.MessageContext	buildInboundMessageContext() Builds a inbound MessageContext.
protected org.opensaml.messaging.context.MessageContext	buildOutboundMessageContext() Builds a outbound MessageContext.
org.opensaml.profile.context.ProfileRequestContext	buildProfileRequestContext() Builds a ProfileRequestContext.
protected net.shibboleth.idp.relyingparty.RelyingPartyConfiguration	buildRelyingPartyConfiguration() Builds a RelyingPartyConfiguration.
protected net.shibboleth.idp.profile.context.RelyingPartyContext	buildRelyingPartyContext(org.opensaml.profile.context.ProfileRequestContext profileRequestContext) Builds RelyingPartyContext.
org.springframework.webflow.execution.RequestContext	buildRequestContext() Builds a MockRequestContext.
org.springframework.webflow.context.servlet.ServletExternalContext	buildServletExternalContext() Builds a ServletExternalContext.
protected net.shibboleth.idp.profile.config.ProfileConfiguration	selectProfileConfiguration(Map<String,net.shibboleth.idp.profile.config.ProfileConfiguration> rpProfileConfigs) Selects the active profile configurations from the set of registered profile configuration from the relying party configuration built by buildRelyingPartyConfiguration().
RequestContextBuilder	setHttpRequest(HttpServletRequest request) Sets the HttpServletRequest used when building the request context.
RequestContextBuilder	setHttpResponse(HttpServletResponse response) Sets the HttpServletResponse used when building the request context.
RequestContextBuilder	setInboundMessage(Object message) Sets the inbound message.
RequestContextBuilder	setInboundMessageId(String id) Sets the ID of the inbound message.
RequestContextBuilder	setInboundMessageIssueInstant(long instant) Sets the issue instant of the inbound message in milliseconds.
RequestContextBuilder	setInboundMessageIssuer(String issuer) Sets the issuer of the inbound message.
RequestContextBuilder	setOutboundMessage(Object message) Sets the outbound message.
RequestContextBuilder	setOutboundMessageId(String id) Sets the ID of the outbound message.
RequestContextBuilder	setOutboundMessageIssueInstant(long instant) Sets the issue instant of the outbound message in milliseconds.
RequestContextBuilder	setOutboundMessageIssuer(String issuer) Sets the issuer of the outbound message.
RequestContextBuilder	setRelyingPartyProfileConfigurations(Collection<net.shibboleth.idp.profile.config.ProfileConfiguration> configs) Sets the profile configurations associated with the relying party.
RequestContextBuilder	setServletContext(ServletContext context) Sets the ServletContext used when building the request context.

Methods inherited from class java.lang.Object

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

Field Detail

NO_VAL

private final String NO_VAL

Value used to represent a string value that has not be set.

See Also:

Constant Field Values

servletContext

private ServletContext servletContext

The ServletContext used when building the request context.

httpRequest

private HttpServletRequest httpRequest

The HttpServletRequest used when building the request context.

httpResponse

private HttpServletResponse httpResponse

The HttpServletResponse used when building the request context.

inboundMessageId

private String inboundMessageId

The ID of the inbound message.

inboundMessageIssueInstant

private long inboundMessageIssueInstant

The issue instant of the inbound message in milliseconds.

inboundMessageIssuer

private String inboundMessageIssuer

The issuer of the inbound message.

inboundMessage

private Object inboundMessage

The inbound message.

outboundMessageId

private String outboundMessageId

The ID of the outbound message.

outboundMessageIssueInstant

private long outboundMessageIssueInstant

The issue instant of the outbound message in milliseconds.

outboundMessageIssuer

private String outboundMessageIssuer

The issuer of the outbound message.

outboundMessage

private Object outboundMessage

The outbound message.

relyingPartyProfileConfigurations

private Collection<net.shibboleth.idp.profile.config.ProfileConfiguration> relyingPartyProfileConfigurations

The profile configurations associated with the relying party.

Constructor Detail

RequestContextBuilder

public RequestContextBuilder()

Constructor.

RequestContextBuilder

public RequestContextBuilder(RequestContextBuilder prototype)

Constructor.

Parameters:

prototype - prototype whose properties are copied onto this builder

Method Detail

setServletContext

@Nonnull
public RequestContextBuilder setServletContext(@Nullable
                                              ServletContext context)

Sets the ServletContext used when building the request context.

Parameters:

context - the ServletContext used when building the request context

Returns:

this builder

setHttpRequest

@Nonnull
public RequestContextBuilder setHttpRequest(@Nullable
                                           HttpServletRequest request)

Sets the HttpServletRequest used when building the request context.

Parameters:

request - the HttpServletRequest used when building the request context

Returns:

this builder

setHttpResponse

@Nonnull
public RequestContextBuilder setHttpResponse(@Nullable
                                            HttpServletResponse response)

Sets the HttpServletResponse used when building the request context.

Parameters:

response - the HttpServletResponse used when building the request context

Returns:

this builder

setInboundMessageId

@Nonnull
public RequestContextBuilder setInboundMessageId(@Nullable
                                                String id)

Sets the ID of the inbound message.

Parameters:

id - ID of the inbound message

Returns:

this builder

setInboundMessageIssueInstant

@Nonnull
public RequestContextBuilder setInboundMessageIssueInstant(long instant)

Sets the issue instant of the inbound message in milliseconds.

Parameters:

instant - issue instant of the inbound message in milliseconds

Returns:

this builder

setInboundMessageIssuer

@Nonnull
public RequestContextBuilder setInboundMessageIssuer(@Nullable
                                                    String issuer)

Sets the issuer of the inbound message.

Parameters:

issuer - issuer of the inbound message

Returns:

this builder

setInboundMessage

@Nonnull
public RequestContextBuilder setInboundMessage(@Nullable
                                              Object message)

Sets the inbound message.

Parameters:

message - the inbound message

Returns:

this builder

setOutboundMessageId

@Nonnull
public RequestContextBuilder setOutboundMessageId(@Nullable
                                                 String id)

Sets the ID of the outbound message.

Parameters:

id - ID of the outbound message

Returns:

this builder

setOutboundMessageIssueInstant

@Nonnull
public RequestContextBuilder setOutboundMessageIssueInstant(long instant)

Sets the issue instant of the outbound message in milliseconds.

Parameters:

instant - issue instant of the outbound message in milliseconds

Returns:

this builder

setOutboundMessageIssuer

public RequestContextBuilder setOutboundMessageIssuer(@Nullable
                                             String issuer)

Sets the issuer of the outbound message.

Parameters:

issuer - issuer of the outbound message

Returns:

this builder

setOutboundMessage

@Nonnull
public RequestContextBuilder setOutboundMessage(@Nullable
                                               Object message)

Sets the outbound message.

Parameters:

message - the outbound message

Returns:

this builder

setRelyingPartyProfileConfigurations

@Nonnull
public RequestContextBuilder setRelyingPartyProfileConfigurations(@Nullable
                                                                 Collection<net.shibboleth.idp.profile.config.ProfileConfiguration> configs)

Sets the profile configurations associated with the relying party.

Parameters:

configs - profile configurations associated with the relying party

Returns:

this builder

buildRequestContext

@Nonnull
public org.springframework.webflow.execution.RequestContext buildRequestContext()
                                                                         throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Builds a MockRequestContext. The default implementation builds a MockRequestContext that contains a:

• ServletExternalContext, via RequestContext.getExternalContext(), created by buildServletExternalContext()
• ProfileRequestContext created by buildProfileRequestContext()

Returns:

the constructed MockRequestContext

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

buildServletExternalContext

@Nonnull
public org.springframework.webflow.context.servlet.ServletExternalContext buildServletExternalContext()

Builds a ServletExternalContext. The default implementations builds a ServletExternalContext that contains a:

• the ServletContext provided by setServletContext(ServletContext) or a MockServletContext if none was provided
• the HttpServletRequest provided by setHttpRequest(HttpServletRequest) or a MockHttpServletRequest if none was provided
• the HttpServletResponse provided by setHttpResponse(HttpServletResponse) or a MockHttpServletResponse if none was provided

Returns:

the constructed ServletContext

buildProfileRequestContext

@Nonnull
public org.opensaml.profile.context.ProfileRequestContext buildProfileRequestContext()
                                                                              throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Builds a ProfileRequestContext. The default implementation builds a ProfileRequestContext that contains a:

• inbound message context created by buildInboundMessageContext()
• outbound message context created by buildOutboundMessageContext()
• RelyingPartyContext created by #buildRelyingPartyContext()

Returns:

the constructed {

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException - @link ProfileRequestContext

buildInboundMessageContext

@Nonnull
protected org.opensaml.messaging.context.MessageContext buildInboundMessageContext()

Builds a inbound MessageContext. The default implementation builds a MessageContext that contains:

• the message provided by setInboundMessage(Object)
• a BasicMessageMetadataContext created by #buildInboudMessageMetadataContext(MessageContext)

Returns:

the constructed MessageContext

buildOutboundMessageContext

@Nonnull
protected org.opensaml.messaging.context.MessageContext buildOutboundMessageContext()

Builds a outbound MessageContext. The default implementation builds a MessageContext that contains:

• the message provided by setOutboundMessage(Object)
• a BasicMessageMetadataContext created by #buildOutboudMessageMetadataContext(MessageContext)

Returns:

the constructed MessageContext

buildRelyingPartyContext

@Nonnull
protected net.shibboleth.idp.profile.context.RelyingPartyContext buildRelyingPartyContext(@Nonnull
                                                                                      org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
                                                                                   throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Builds RelyingPartyContext. The default implementations builds a RelyingPartyContext with:

• a relying party ID provided by setInboundMessageIssuer(String) or ActionTestingSupport.INBOUND_MSG_ISSUER if none is given
• a relying party configuration built by buildRelyingPartyConfiguration()
• the active profile selected, out of the profiles registered with the built relying party configuration, by selectProfileConfiguration(Map)

Returns:

the constructed RelyingPartyContext

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

buildRelyingPartyConfiguration

@Nonnull
protected net.shibboleth.idp.relyingparty.RelyingPartyConfiguration buildRelyingPartyConfiguration()
                                                                                            throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Builds a RelyingPartyConfiguration. The default implementation of this method builds a RelyingPartyConfiguration such that:

• configuration ID is 'mock'
• the responder ID provided by setOutboundMessageIssuer(String) or ActionTestingSupport.OUTBOUND_MSG_ISSUER if none is given
• the activation criteria is Predicates.alwaysTrue()
• the profile configurations provided setRelyingPartyProfileConfigurations(Collection) or one MockProfileConfiguration if none is provided

Returns:

the constructed RelyingPartyConfiguration

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

selectProfileConfiguration

@Nullable
protected net.shibboleth.idp.profile.config.ProfileConfiguration selectProfileConfiguration(@Nonnull
                                                                                         Map<String,net.shibboleth.idp.profile.config.ProfileConfiguration> rpProfileConfigs)

Selects the active profile configurations from the set of registered profile configuration from the relying party configuration built by buildRelyingPartyConfiguration(). The default implementation of this method simply returns the first value of the Map.values() collection.

Parameters:

rpProfileConfigs - the set of profile configurations associated with the constructed relying party

Returns:

the active ProfileConfiguration