xmltooling::OpenSSLSOAPTransport Class Reference

Encapsulates OpenSSL-capable SOAP transport layer. More...

#include <xmltooling/soap/OpenSSLSOAPTransport.h>

Inheritance diagram for xmltooling::OpenSSLSOAPTransport:

Public Types
typedef bool(*	ssl_ctx_callback_fn )(OpenSSLSOAPTransport *transport, SSL_CTX *ssl_ctx, void *userptr)
	OpenSSL context callback for manipulating credentials and validation behavior. More...
Public Types inherited from xmltooling::SOAPTransport
enum	transport_auth_t {   transport_auth_none = 0, transport_auth_basic = 1, transport_auth_digest = 2, transport_auth_ntlm = 3,   transport_auth_gss = 4 }
	Common types of transport authentication that may be supported.

Public Member Functions
virtual bool	setSSLCallback (ssl_ctx_callback_fn fn, void *userptr=0)=0
	Sets a callback function to invoke against the SSL_CTX before the handshake. More...
virtual void	setAuthenticated (bool auth)=0
	Sets indicator that the transport peer has been authenticated. More...
Public Member Functions inherited from xmltooling::SOAPTransport
virtual bool	isConfidential () const =0
	Indicates whether transport provides confidentiality. More...
virtual bool	setConnectTimeout (long timeout)=0
	Sets the connection timeout. More...
virtual bool	setTimeout (long timeout)=0
	Sets the request timeout. More...
virtual bool	setAuth (transport_auth_t authType, const char *username=0, const char *password=0)=0
	Sets a particular form of transport authentication and credentials. More...
virtual bool	setVerifyHost (bool verify)=0
	Determines whether TLS/SSL connections include a check of the server's certificate against the expected hostname or address. More...
virtual bool	setCredential (const Credential *credential=0)=0
	Supplies transport credentials. More...
virtual bool	setTrustEngine (const X509TrustEngine *trustEngine=0, const CredentialResolver *credResolver=0, CredentialCriteria *criteria=0, bool mandatory=true)=0
	Provides an X509TrustEngine to the transport to authenticate the transport peer. More...
virtual bool	setCacheTag (std::string *cacheTag=0)
	Installs (or clears) a pointer to an object used for cache management of the content being accessed. More...
virtual bool	setProviderOption (const char *provider, const char *option, const char *value)
	Sets an implementation-specific transport provider option. More...
virtual void	send (std::istream &in)=0
	Sends a stream of data over the transport. More...
virtual void	send (std::istream *in=0)
	Sends an optional stream of data over the transport. More...
virtual std::istream &	receive ()=0
	Returns reference to response stream. More...
virtual bool	isAuthenticated () const =0
	Returns result of authenticating transport peer. More...
virtual std::string	getContentType () const =0
	Returns the MIME type of the response, if any. More...
virtual long	getStatusCode () const
	Returns the status code of the response. More...

Detailed Description

Encapsulates OpenSSL-capable SOAP transport layer.

Member Typedef Documentation

typedef bool(* xmltooling::OpenSSLSOAPTransport::ssl_ctx_callback_fn)(OpenSSLSOAPTransport *transport, SSL_CTX *ssl_ctx, void *userptr)

OpenSSL context callback for manipulating credentials and validation behavior.

Member Function Documentation

virtual void xmltooling::OpenSSLSOAPTransport::setAuthenticated ( bool  auth )

pure virtual

Sets indicator that the transport peer has been authenticated.

Parameters

auth	flag to set

virtual bool xmltooling::OpenSSLSOAPTransport::setSSLCallback ( ssl_ctx_callback_fn  fn, void *  userptr = 0  )

pure virtual

Sets a callback function to invoke against the SSL_CTX before the handshake.

Parameters

fn	callback function
userptr	a caller-supplied value to pass to the callback function

Returns

true iff the callback was set

---

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

• xmltooling/soap/OpenSSLSOAPTransport.h