opensaml-2.4.3
opensaml::SOAPClient Class Reference

Specialized SOAPClient for SAML SOAP bindings. More...

#include <saml/binding/SOAPClient.h>

Inheritance diagram for opensaml::SOAPClient:

Public Member Functions

 SOAPClient (SecurityPolicy &policy)
 Creates a SOAP client instance with a particular SecurityPolicy. More...
 
void forceTransportAuthentication (bool force=true)
 Controls whether to force transport/peer authentication via an X509TrustEngine. More...
 
virtual void send (const soap11::Envelope &env, const char *from, saml2md::MetadataCredentialCriteria &to, const char *endpoint)
 SAML-specific method uses metadata to determine the peer name and prepare the transport layer with peer credential information. More...
 
soap11::Envelope * receive ()
 Override applies SecurityPolicy to envelope before returning it. More...
 
void reset ()
 
SecurityPolicygetPolicy () const
 Returns the SecurityPolicy supplied to the client. More...
 

Protected Member Functions

void prepareTransport (xmltooling::SOAPTransport &transport)
 Override prepares transport by assigning an X509TrustEngine to it, if one is attached to the policy. More...
 

Protected Attributes

SecurityPolicym_policy
 Reference to security policy to apply. More...
 
bool m_force
 Flag controlling whether transport/peer authn is mandatory. More...
 
const saml2md::RoleDescriptor * m_peer
 Metadata-based peer identity. More...
 
saml2md::MetadataCredentialCriteriam_criteria
 Metadata-based CredentialCriteria for supplying credentials to TrustEngine. More...
 

Detailed Description

Specialized SOAPClient for SAML SOAP bindings.

Constructor & Destructor Documentation

opensaml::SOAPClient::SOAPClient ( SecurityPolicy policy)

Creates a SOAP client instance with a particular SecurityPolicy.

Parameters
policyreference to SecurityPolicy to apply

Member Function Documentation

void opensaml::SOAPClient::forceTransportAuthentication ( bool  force = true)

Controls whether to force transport/peer authentication via an X509TrustEngine.

Only makes sense if an X509TrustEngine is supplied by the SecurityPolicy.

Parameters
forcetrue iff the client should refuse to communicate without this protection
SecurityPolicy& opensaml::SOAPClient::getPolicy ( ) const

Returns the SecurityPolicy supplied to the client.

Returns
the associated SecurityPolicy
void opensaml::SOAPClient::prepareTransport ( xmltooling::SOAPTransport &  transport)
protected

Override prepares transport by assigning an X509TrustEngine to it, if one is attached to the policy.

Parameters
transportreference to transport layer
soap11::Envelope* opensaml::SOAPClient::receive ( )

Override applies SecurityPolicy to envelope before returning it.

Returns
response envelope after SecurityPolicy has been applied
virtual void opensaml::SOAPClient::send ( const soap11::Envelope &  env,
const char *  from,
saml2md::MetadataCredentialCriteria to,
const char *  endpoint 
)
virtual

SAML-specific method uses metadata to determine the peer name and prepare the transport layer with peer credential information.

The SecurityPolicy is also reset, in case the policy is reused.

Parameters
envSOAP envelope to send
fromidentity of sending application
topeer to send message to, expressed in metadata criteria terms
endpointURL of endpoint to recieve message

Member Data Documentation

saml2md::MetadataCredentialCriteria* opensaml::SOAPClient::m_criteria
protected

Metadata-based CredentialCriteria for supplying credentials to TrustEngine.

bool opensaml::SOAPClient::m_force
protected

Flag controlling whether transport/peer authn is mandatory.

const saml2md::RoleDescriptor* opensaml::SOAPClient::m_peer
protected

Metadata-based peer identity.

SecurityPolicy& opensaml::SOAPClient::m_policy
protected

Reference to security policy to apply.


The documentation for this class was generated from the following file: