decaf::net::ssl::SSLContext Class Reference

Represents on implementation of the Secure Socket Layer for streaming based sockets. More...

#include <src/main/decaf/net/ssl/SSLContext.h>

Public Member Functions
	SSLContext (SSLContextSpi *contextImpl)
virtual	~SSLContext ()
SocketFactory *	getSocketFactory ()
	Returns an SocketFactory instance for use with this Context, the SocketFactory is owned by the Context and should not be deleted by the caller.
ServerSocketFactory *	getServerSocketFactory ()
	Returns an ServerSocketFactory instance for use with this Context, the ServerSocketFactory is owned by the Context and should not be deleted by the caller.
SSLParameters *	getDefaultSSLParameters ()
SSLParameters *	getSupportedSSLParameters ()
Static Public Member Functions
static SSLContext *	getDefault ()
	Gets the Default SSLContext.
static void	setDefault (SSLContext *context)
	Sets the default SSLContext to be returned from future calls to getDefault.

---

Detailed Description

Represents on implementation of the Secure Socket Layer for streaming based sockets.

This class servers a a source of factories to be used to create new SSL Socket instances.

Since:

1.0

---

Constructor & Destructor Documentation

decaf::net::ssl::SSLContext::SSLContext

(

SSLContextSpi *

contextImpl

)

virtual decaf::net::ssl::SSLContext::~SSLContext

(

)

[virtual]

---

Member Function Documentation

static SSLContext* decaf::net::ssl::SSLContext::getDefault

(

)

[static]

Gets the Default SSLContext.

The default instance of the SSLContext should be immediately usable without any need for the client to initialize this context.

Returns:

a pointer to the Default SSLContext instance.

SSLParameters* decaf::net::ssl::SSLContext::getDefaultSSLParameters

(

)

Returns:

a new instance of an SSLParameters object containing the default set of settings for this SSLContext.

Exceptions:

UnsupportedOperationException

if the parameters cannot be retrieved.

ServerSocketFactory* decaf::net::ssl::SSLContext::getServerSocketFactory

(

)

Returns an ServerSocketFactory instance for use with this Context, the ServerSocketFactory is owned by the Context and should not be deleted by the caller.

Returns:

a pointer to this SSLContext's ServerSocketFactory for creating SSLServerSocket objects.

Exceptions:

IllegalStateException

if the SSLContextSpi requires initialization but it has not yet been initialized.

SocketFactory* decaf::net::ssl::SSLContext::getSocketFactory

(

)

Returns an SocketFactory instance for use with this Context, the SocketFactory is owned by the Context and should not be deleted by the caller.

Returns:

a pointer to this SSLContext's SocketFactory for creating SSLSocket objects.

Exceptions:

IllegalStateException

if the SSLContextSpi requires initialization but it has not yet been initialized.

SSLParameters* decaf::net::ssl::SSLContext::getSupportedSSLParameters

(

)

Returns:

a new instance of an SSLParameters object containing the complete set of settings for this SSLContext.

Exceptions:

UnsupportedOperationException

if the parameters cannot be retrieved.

static void decaf::net::ssl::SSLContext::setDefault

(

SSLContext *

context

)

[static]

Sets the default SSLContext to be returned from future calls to getDefault.

The set SSLContext must be fully initialized and usable. The caller is responsible for deleting this object before the Library shutdown methods are called.

Exceptions:

NullPointerException

if the context passed is NULL.

---

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

• src/main/decaf/net/ssl/SSLContext.h