org.opensaml.ws.soap.client.http
Interface HTTPSOAPTransport

All Superinterfaces:
SOAPTransport<X509Credential>
All Known Implementing Classes:
AbstractHTTPSOAPTransport

public interface HTTPSOAPTransport
extends SOAPTransport<X509Credential>

A transport for moving SOAP messages over HTTP. Note, the authentication credentials provided by this interface are credentials used to authenticate the entity to the HTTP server. The SOAPTransport connection authentication credentials are used when performing mutual TLS authentication with the server.


Nested Class Summary
static class HTTPSOAPTransport.AuthenticationScheme
          Authentication schemes supported by HTTP transports.
static interface HTTPSOAPTransport.HTTPEntityCredential
          Marker interface for HTTP connection credentials.
static interface HTTPSOAPTransport.NTLMCredential
          NTLM credentials.
static interface HTTPSOAPTransport.UsernamePasswordCredential
          User name and password credentals.
 
Method Summary
 HTTPSOAPTransport.HTTPEntityCredential getEntityAuthenticationCredential()
          Gets the credentials to use to authenticate to the HTTP server.
 HTTPSOAPTransport.AuthenticationScheme getEntityAuthenticationScheme()
          Gets the type of authentication to perform with the HTTP server.
 boolean isChunkEncoding()
          Gets whether content should be sent using HTTP 1.1 and chunk encoded.
 void setChunkEncoding(boolean isChunkEncoding)
          Sets whether content should be sent using HTTP 1.1 and chunk encoded.
 void setEntityAuthenticationCredentials(HTTPSOAPTransport.HTTPEntityCredential credentials)
          Sets the credentials to use to authenticate to the HTTP server.
 void setEntityAuthenticationScheme(HTTPSOAPTransport.AuthenticationScheme authnScheme)
          Sets the type of authentication to perform with the HTTP server.
 
Methods inherited from interface org.opensaml.ws.soap.client.SOAPTransport
getConnectionAuthenticationCredential, getPeerConnectionAuthenticatingTrustEngine, getRequestTimeout, getTrustedCredentialCriteria, getTrustedCredentialResolver, send, setConnectionAuthenticationCredential, setPeerConnectionAuthenticatingTrustEngine, setRequestTimeout, setTrustedCredentialResolver, supportsConfidential
 

Method Detail

isChunkEncoding

boolean isChunkEncoding()
Gets whether content should be sent using HTTP 1.1 and chunk encoded. If the implemenation does not support HTTP 1.1 this method will always return false.

Returns:
whether content should be sent using HTTP 1.1 and chunk encoded

setChunkEncoding

void setChunkEncoding(boolean isChunkEncoding)
Sets whether content should be sent using HTTP 1.1 and chunk encoded. If the implemenation does not support HTTP 1.1 call to this method will be ignored.

Parameters:
isChunkEncoding - whether content should be sent using HTTP 1.1 and chunk encoded

getEntityAuthenticationScheme

HTTPSOAPTransport.AuthenticationScheme getEntityAuthenticationScheme()
Gets the type of authentication to perform with the HTTP server.

Returns:
type of authentication to perform with the HTTP server

setEntityAuthenticationScheme

void setEntityAuthenticationScheme(HTTPSOAPTransport.AuthenticationScheme authnScheme)
Sets the type of authentication to perform with the HTTP server.

Parameters:
authnScheme - type of authentication to perform with the HTTP server

getEntityAuthenticationCredential

HTTPSOAPTransport.HTTPEntityCredential getEntityAuthenticationCredential()
Gets the credentials to use to authenticate to the HTTP server.

Returns:
credentials to use to authenticate to the HTTP server

setEntityAuthenticationCredentials

void setEntityAuthenticationCredentials(HTTPSOAPTransport.HTTPEntityCredential credentials)
Sets the credentials to use to authenticate to the HTTP server.

Parameters:
credentials - credentials to use to authenticate to the HTTP server