org.opensaml.ws.soap.client
Class AbstractSOAPTransport<CredentialType extends Credential>

java.lang.Object
  extended by org.opensaml.ws.soap.client.AbstractSOAPTransport<CredentialType>
Type Parameters:
CredentialType - type of credential used during connection authentication
All Implemented Interfaces:
SOAPTransport<CredentialType>
Direct Known Subclasses:
AbstractHTTPSOAPTransport

public abstract class AbstractSOAPTransport<CredentialType extends Credential>
extends java.lang.Object
implements SOAPTransport<CredentialType>

SOAPTransport base class handling a lot of boilerplate code.


Constructor Summary
protected AbstractSOAPTransport()
          Constructor.
 
Method Summary
 CredentialType getConnectionAuthenticationCredential()
          Gets the credential used to authenticate to the peer when connecting.
 TrustEngine<CredentialType> getPeerConnectionAuthenticatingTrustEngine()
          Gets the trust engine to use to evaluate a peer's connection credentials.
 long getRequestTimeout()
          Gets the time to wait for a response in seconds.
 CredentialCriteriaSet getTrustedCredentialCriteria()
          Gets the criteria that will be used, or was used, to retrieve the credential from the trusted credential resolver.
 CredentialResolver getTrustedCredentialResolver()
          Gets the credential resolver used to retrieve trusted credential information for the peer.
 void setConnectionAuthenticationCredential(CredentialType credential)
          Sets the credential used to authenticate to the peer when connecting.
 void setPeerConnectionAuthenticatingTrustEngine(TrustEngine<CredentialType> trustEngine)
          Sets the trust engine to use to evaluate a peer's connection credentials.
 void setRequestTimeout(long timeout)
          Sets the time to wait for a response in seconds.
 void setTrustedCredentialResolver(CredentialResolver resolver)
          Sets the credential resolver used to retrieve trusted credential information for the peer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opensaml.ws.soap.client.SOAPTransport
send, supportsConfidential
 

Constructor Detail

AbstractSOAPTransport

protected AbstractSOAPTransport()
Constructor.

Method Detail

getConnectionAuthenticationCredential

public CredentialType getConnectionAuthenticationCredential()
Gets the credential used to authenticate to the peer when connecting.

Specified by:
getConnectionAuthenticationCredential in interface SOAPTransport<CredentialType extends Credential>
Returns:
credential used to authenticate to the peer

getPeerConnectionAuthenticatingTrustEngine

public TrustEngine<CredentialType> getPeerConnectionAuthenticatingTrustEngine()
Gets the trust engine to use to evaluate a peer's connection credentials.

Specified by:
getPeerConnectionAuthenticatingTrustEngine in interface SOAPTransport<CredentialType extends Credential>
Returns:
trust engine to use to evaluate a peer's connection credentials

getRequestTimeout

public long getRequestTimeout()
Gets the time to wait for a response in seconds.

Specified by:
getRequestTimeout in interface SOAPTransport<CredentialType extends Credential>
Returns:
time to wait for a response in seconds

setConnectionAuthenticationCredential

public void setConnectionAuthenticationCredential(CredentialType credential)
Sets the credential used to authenticate to the peer when connecting.

Specified by:
setConnectionAuthenticationCredential in interface SOAPTransport<CredentialType extends Credential>
Parameters:
credential - credential used to authenticate to the peer

setPeerConnectionAuthenticatingTrustEngine

public void setPeerConnectionAuthenticatingTrustEngine(TrustEngine<CredentialType> trustEngine)
Sets the trust engine to use to evaluate a peer's connection credentials.

Specified by:
setPeerConnectionAuthenticatingTrustEngine in interface SOAPTransport<CredentialType extends Credential>
Parameters:
trustEngine - trust engine to use to evaluate a peer's connection credentials

setRequestTimeout

public void setRequestTimeout(long timeout)
Sets the time to wait for a response in seconds.

Specified by:
setRequestTimeout in interface SOAPTransport<CredentialType extends Credential>
Parameters:
timeout - time to wait for a response in seconds

getTrustedCredentialCriteria

public CredentialCriteriaSet getTrustedCredentialCriteria()
Gets the criteria that will be used, or was used, to retrieve the credential from the trusted credential resolver. This must never return null.

Specified by:
getTrustedCredentialCriteria in interface SOAPTransport<CredentialType extends Credential>
Returns:
criteria that will be used, or was used, to retrieve the credential from the trusted credential resolver

getTrustedCredentialResolver

public CredentialResolver getTrustedCredentialResolver()
Gets the credential resolver used to retrieve trusted credential information for the peer.

Specified by:
getTrustedCredentialResolver in interface SOAPTransport<CredentialType extends Credential>
Returns:
credential resolver used to retrieve trusted credential information for the peer

setTrustedCredentialResolver

public void setTrustedCredentialResolver(CredentialResolver resolver)
Sets the credential resolver used to retrieve trusted credential information for the peer.

Specified by:
setTrustedCredentialResolver in interface SOAPTransport<CredentialType extends Credential>
Parameters:
resolver - credential resolver used to retrieve trusted credential information for the peer