org.opensaml.soap.client.http

Class PipelineFactoryHttpSOAPClient<OutboundMessageType,InboundMessageType>

java.lang.Object

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

org.opensaml.soap.client.http.AbstractPipelineHttpSOAPClient<OutboundMessageType,InboundMessageType>

org.opensaml.soap.client.http.PipelineFactoryHttpSOAPClient<OutboundMessageType,InboundMessageType>

Type Parameters:

OutboundMessageType - the outbound message type

InboundMessageType - the inbound message type

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, SOAPClient

@ThreadSafe
public class PipelineFactoryHttpSOAPClient<OutboundMessageType,InboundMessageType>
extends AbstractPipelineHttpSOAPClient<OutboundMessageType,InboundMessageType>

SOAP client that is based on HttpClientMessagePipeline, produced at runtime from an instance of HttpClientMessagePipelineFactory.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensaml.soap.client.SOAPClient

SOAPClient.SOAPRequestParameters

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Logger.
private HttpClientMessagePipelineFactory<InboundMessageType,OutboundMessageType>	pipelineFactory Factory for the client message pipeline.
private Function<InOutOperationContext<?,?>,String>	pipelineNameStrategy Strategy function used to resolve the pipeline name to execute.

Constructor Summary

Constructors

Constructor and Description
PipelineFactoryHttpSOAPClient()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doInitialize()
protected HttpClientMessagePipeline<InboundMessageType,OutboundMessageType>	newPipeline() Get a new instance of the HttpClientMessagePipeline to be processed.
protected HttpClientMessagePipeline<InboundMessageType,OutboundMessageType>	newPipeline(String name) Get a new instance of the HttpClientMessagePipeline to be processed.
protected HttpClientMessagePipeline<InboundMessageType,OutboundMessageType>	resolvePipeline(InOutOperationContext operationContext) Resolve and return a new instance of the HttpClientMessagePipeline to be processed.
protected String	resolvePipelineName(InOutOperationContext operationContext) Resolve the name of the pipeline to use.
void	setPipelineFactory(HttpClientMessagePipelineFactory<InboundMessageType,OutboundMessageType> factory) Set the message pipeline factory.
void	setPipelineNameStrategy(Function<InOutOperationContext<?,?>,String> function) Set the strategy function used to resolve the name of the pipeline to use.

Methods inherited from class org.opensaml.soap.client.http.AbstractPipelineHttpSOAPClient

buildHttpContext, buildHttpRequest, buildTLSCriteriaSet, checkTLSCredentialTrusted, getHttpClient, getHttpClientSecurityParameters, getTLSCriteriaSetStrategy, resolveClientContext, resolveContextSecurityParameters, send, setHttpClient, setHttpClientSecurityParameters, setTLSCriteriaSetStrategy

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

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

log

private Logger log

Logger.

pipelineFactory

private HttpClientMessagePipelineFactory<InboundMessageType,OutboundMessageType> pipelineFactory

Factory for the client message pipeline.

pipelineNameStrategy

private Function<InOutOperationContext<?,?>,String> pipelineNameStrategy

Strategy function used to resolve the pipeline name to execute.

Constructor Detail

PipelineFactoryHttpSOAPClient

public PipelineFactoryHttpSOAPClient()

Method Detail

setPipelineFactory

public void setPipelineFactory(@Nonnull
                      HttpClientMessagePipelineFactory<InboundMessageType,OutboundMessageType> factory)

Set the message pipeline factory.

Parameters:

factory - the message pipeline factory

setPipelineNameStrategy

public void setPipelineNameStrategy(@Nullable
                           Function<InOutOperationContext<?,?>,String> function)

Set the strategy function used to resolve the name of the pipeline to use. Null may be specified.

Parameters:

function - the strategy function, or null

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class AbstractPipelineHttpSOAPClient<OutboundMessageType,InboundMessageType>

Throws:

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

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractPipelineHttpSOAPClient<OutboundMessageType,InboundMessageType>

resolvePipeline

@Nonnull
protected HttpClientMessagePipeline<InboundMessageType,OutboundMessageType> resolvePipeline(InOutOperationContext operationContext)
                                                                                     throws SOAPException

Resolve and return a new instance of the HttpClientMessagePipeline to be processed.

Each call to this (factory) method MUST produce a new instance of the pipeline.

The behavior of this subclass specialization is to use a factory strategy using a configured instance of HttpClientMessagePipeline. See resolvePipelineName(InOutOperationContext) and newPipeline(String).

Overrides:

resolvePipeline in class AbstractPipelineHttpSOAPClient<OutboundMessageType,InboundMessageType>

Parameters:

operationContext - the current operation context

Returns:

a new pipeline instance

Throws:

SOAPException - if there is an error obtaining a new pipeline instance

newPipeline

@Nonnull
protected HttpClientMessagePipeline<InboundMessageType,OutboundMessageType> newPipeline()
                                                                                 throws SOAPException

Get a new instance of the HttpClientMessagePipeline to be processed.

Each call to this (factory) method MUST produce a new instance of the pipeline.

The behavior of this subclass specialization is to use a factory strategy using a configured instance of HttpClientMessagePipeline.

Specified by:

newPipeline in class AbstractPipelineHttpSOAPClient<OutboundMessageType,InboundMessageType>

Returns:

the new pipeline instance

Throws:

SOAPException - if there is an error obtaining a new pipeline instance

newPipeline

@Nullable
protected HttpClientMessagePipeline<InboundMessageType,OutboundMessageType> newPipeline(@Nullable
                                                                                     String name)
                                                                                 throws SOAPException

Get a new instance of the HttpClientMessagePipeline to be processed.

Each call to this (factory) method MUST produce a new instance of the pipeline.

The behavior of this subclass specialization is to use a factory strategy using a configured instance of HttpClientMessagePipeline.

Parameters:

name - the name of pipeline to return

Returns:

the new pipeline instance

Throws:

SOAPException - if there is an error obtaining a new pipeline instance

resolvePipelineName

@Nullable
protected String resolvePipelineName(@Nonnull
                                  InOutOperationContext operationContext)

Resolve the name of the pipeline to use.

Parameters:

operationContext - the current operation context

Returns:

the pipeline name, may be null