Package org.opensaml.soap.client.http
Class HttpSOAPClient
java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
org.opensaml.soap.client.http.HttpSOAPClient
- All Implemented Interfaces:
Component,DestructableComponent,InitializableComponent,SOAPClient
@ThreadSafe
@Deprecated
public class HttpSOAPClient
extends AbstractInitializableComponent
implements SOAPClient
Deprecated.
SOAP client that uses HTTP as the underlying transport and POST as the binding.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.opensaml.soap.client.SOAPClient
SOAPClient.SOAPRequestParameters -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.apache.hc.client5.http.classic.HttpClientDeprecated.HTTP client used to send requests and receive responses.private final org.slf4j.LoggerDeprecated.Class logger.private ParserPoolDeprecated.Pool of XML parsers used to parser incoming responses.private Function<MessageContext,SOAP11Context> Deprecated.Strategy used to look up theSOAP11Contextassociated with the outbound message context.private Function<MessageContext,SOAPClientContext> Deprecated.Strategy used to look up theSOAPClientContextassociated with the outbound message context. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected org.apache.hc.client5.http.classic.methods.HttpPostcreatePostMethod(String endpoint, HttpSOAPRequestParameters requestParams, Envelope message) Deprecated.Create the post method used to send the SOAP request.protected org.apache.hc.core5.http.HttpEntitycreateRequestEntity(Envelope message, Charset charset) Deprecated.Create the request entity that makes up the POST message body.protected voidDeprecated.Deprecated.Get the strategy used to look up theSOAP11Contextassociated with the outbound message context.Deprecated.Get the strategy used to look up theSOAPClientContextassociated with the outbound message context.protected voidprocessFaultResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse, InOutOperationContext context) Deprecated.Process a SOAP fault, as determined by an HTTP 500 status code, response.protected voidprocessSuccessfulResponse(org.apache.hc.core5.http.ClassicHttpResponse httpResponse, InOutOperationContext context) Deprecated.Process a successful, as determined by an HTTP 200 status code, response.voidsend(String endpoint, InOutOperationContext context) Deprecated.Sends a message and waits for a response.voidsetHttpClient(org.apache.hc.client5.http.classic.HttpClient client) Deprecated.Set the client used to make outbound HTTP requests.voidsetParserPool(ParserPool parser) Deprecated.Set the pool of XML parsers used to parse incoming responses.voidDeprecated.Set the strategy used to look up theSOAP11Contextassociated with the outbound message context.voidDeprecated.Set the strategy used to look up theSOAPClientContextassociated with the outbound message context.protected EnvelopeunmarshallResponse(InputStream responseStream) Deprecated.Unmarshall the incoming response from a POST request.Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent
checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized
-
Field Details
-
log
@Nonnull private final org.slf4j.Logger logDeprecated.Class logger. -
httpClient
Deprecated.HTTP client used to send requests and receive responses. -
parserPool
Deprecated.Pool of XML parsers used to parser incoming responses. -
soapClientContextLookupStrategy
Deprecated.Strategy used to look up theSOAPClientContextassociated with the outbound message context. -
soap11ContextLookupStrategy
Deprecated.Strategy used to look up theSOAP11Contextassociated with the outbound message context.
-
-
Constructor Details
-
HttpSOAPClient
public HttpSOAPClient()Deprecated.Constructor.
-
-
Method Details
-
doInitialize
Deprecated.- Overrides:
doInitializein classAbstractInitializableComponent- Throws:
ComponentInitializationException
-
setHttpClient
public void setHttpClient(@Nonnull org.apache.hc.client5.http.classic.HttpClient client) Deprecated.Set the client used to make outbound HTTP requests.This client SHOULD employ a thread-safe
HttpClientand may be shared with other objects.- Parameters:
client- client object
-
getSOAPClientContextLookupStrategy
Deprecated.Get the strategy used to look up theSOAPClientContextassociated with the outbound message context.- Returns:
- strategy used to look up the
SOAPClientContextassociated with the outbound message context
-
setSOAPClientContextLookupStrategy
public void setSOAPClientContextLookupStrategy(@Nonnull Function<MessageContext, SOAPClientContext> strategy) Deprecated.Set the strategy used to look up theSOAPClientContextassociated with the outbound message context.- Parameters:
strategy- strategy used to look up theSOAPClientContextassociated with the outbound message context
-
getSOAP11ContextLookupStrategy
Deprecated.Get the strategy used to look up theSOAP11Contextassociated with the outbound message context.- Returns:
- strategy used to look up the
SOAP11Contextassociated with the outbound message context
-
setSOAP11ContextLookupStrategy
public void setSOAP11ContextLookupStrategy(@Nonnull Function<MessageContext, SOAP11Context> strategy) Deprecated.Set the strategy used to look up theSOAP11Contextassociated with the outbound message context.- Parameters:
strategy- strategy used to look up theSOAP11Contextassociated with the outbound message context
-
send
public void send(@Nonnull @NotEmpty String endpoint, @Nonnull InOutOperationContext context) throws SOAPException, SecurityException Deprecated.Sends a message and waits for a response.- Specified by:
sendin interfaceSOAPClient- Parameters:
endpoint- the endpoint to which to send the messagecontext- the operation context containing the outbound SOAP message- Throws:
SOAPException- thrown if there is a problem sending the message or receiving the response or if the response is a SOAP faultSecurityException- thrown if the response does not meet any security policy associated with the message context
-
createPostMethod
protected org.apache.hc.client5.http.classic.methods.HttpPost createPostMethod(@Nonnull @NotEmpty String endpoint, @Nullable HttpSOAPRequestParameters requestParams, @Nonnull Envelope message) throws SOAPClientException Deprecated.Create the post method used to send the SOAP request.- Parameters:
endpoint- endpoint to which the message is sentrequestParams- HTTP request parametersmessage- message to be sent- Returns:
- the post method to be used to send this message
- Throws:
SOAPClientException- thrown if the message could not be marshalled
-
createRequestEntity
@Nonnull protected org.apache.hc.core5.http.HttpEntity createRequestEntity(@Nonnull Envelope message, @Nullable Charset charset) throws SOAPClientException Deprecated.Create the request entity that makes up the POST message body.- Parameters:
message- message to be sentcharset- character set used for the message- Returns:
- request entity that makes up the POST message body
- Throws:
SOAPClientException- thrown if the message could not be marshalled
-
processSuccessfulResponse
protected void processSuccessfulResponse(@Nonnull org.apache.hc.core5.http.ClassicHttpResponse httpResponse, @Nonnull InOutOperationContext context) throws SOAPClientException Deprecated.Process a successful, as determined by an HTTP 200 status code, response.- Parameters:
httpResponse- the HTTP responsecontext- current operation context- Throws:
SOAPClientException- thrown if there is a problem reading the response from theHttpPost
-
processFaultResponse
protected void processFaultResponse(@Nonnull org.apache.hc.core5.http.ClassicHttpResponse httpResponse, @Nonnull InOutOperationContext context) throws SOAPClientException, SOAPFaultException Deprecated.Process a SOAP fault, as determined by an HTTP 500 status code, response.- Parameters:
httpResponse- the HTTP responsecontext- current operation context- Throws:
SOAPClientException- thrown if the response can not be read from theHttpPostSOAPFaultException- an exception containing the SOAP fault
-
unmarshallResponse
@Nonnull protected Envelope unmarshallResponse(@Nonnull InputStream responseStream) throws SOAPClientException Deprecated.Unmarshall the incoming response from a POST request.- Parameters:
responseStream- input stream bearing the response- Returns:
- the response
- Throws:
SOAPClientException- thrown if the incoming response can not be unmarshalled into anEnvelope
-
AbstractPipelineHttpSOAPClient, such asPipelineFactoryHttpSOAPClient