decaf::net::ssl::SSLContextSpi Class Reference
Defines the interface that should be provided by an SSLContext provider. More...
#include <src/main/decaf/net/ssl/SSLContextSpi.h>
Public Member Functions | |
| virtual | ~SSLContextSpi () |
| virtual void | providerInit (security::SecureRandom *random)=0 |
| Perform the initialization of this Context. | |
| virtual SSLParameters * | providerGetDefaultSSLParameters () |
| Creates a returns a new SSLParameters instance that contains the default settings for this Providers SSLContext. | |
| virtual SSLParameters * | providerGetSupportedSSLParameters () |
| Creates and returns a new SSLParameters instance that contains the full set of supported parameters for this SSL Context. | |
| virtual SocketFactory * | providerGetSocketFactory ()=0 |
| Returns a SocketFactory instance that can be used to create new SSLSocket objects. | |
| virtual ServerSocketFactory * | providerGetServerSocketFactory ()=0 |
| Returns a ServerSocketFactory instance that can be used to create new SSLServerSocket objects. | |
Detailed Description
Defines the interface that should be provided by an SSLContext provider.
- Since:
- 1.0
Constructor & Destructor Documentation
| virtual decaf::net::ssl::SSLContextSpi::~SSLContextSpi | ( | ) | [virtual] |
Member Function Documentation
| virtual SSLParameters* decaf::net::ssl::SSLContextSpi::providerGetDefaultSSLParameters | ( | ) | [virtual] |
Creates a returns a new SSLParameters instance that contains the default settings for this Providers SSLContext.
The returned SSLParameters instance is requires to have non-empty values in its ciphersuites and protocols.
- Returns:
- new SSLParameters instance with the SSLContext defaults.
- Exceptions:
-
UnsupportedOperationException if the defaults cannot be obtained.
| virtual ServerSocketFactory* decaf::net::ssl::SSLContextSpi::providerGetServerSocketFactory | ( | ) | [pure virtual] |
Returns a ServerSocketFactory instance that can be used to create new SSLServerSocket objects.
The ServerSocketFactory is owned by the Service Provider and should not be destroyed by the caller.
- Returns:
- SocketFactory instance that can be used to create new SSLServerSockets.
- Exceptions:
-
IllegalStateException if the SSLContextSpi object requires initialization but has not been initialized yet.
Implemented in decaf::internal::net::ssl::openssl::OpenSSLContextSpi.
| virtual SocketFactory* decaf::net::ssl::SSLContextSpi::providerGetSocketFactory | ( | ) | [pure virtual] |
Returns a SocketFactory instance that can be used to create new SSLSocket objects.
The SocketFactory is owned by the Service Provider and should not be destroyed by the caller.
- Returns:
- SocketFactory instance that can be used to create new SSLSockets.
- Exceptions:
-
IllegalStateException if the SSLContextSpi object requires initialization but has not been initialized yet.
Implemented in decaf::internal::net::ssl::openssl::OpenSSLContextSpi.
| virtual SSLParameters* decaf::net::ssl::SSLContextSpi::providerGetSupportedSSLParameters | ( | ) | [virtual] |
Creates and returns a new SSLParameters instance that contains the full set of supported parameters for this SSL Context.
The returned SSLParameters instance is requires to have non-empty values in its ciphersuites and protocols.
- Returns:
- a new SSLParameters instance with the full set of settings that are supported.
- Exceptions:
-
UnsupportedOperationException if the supported parameters cannot be obtained.
| virtual void decaf::net::ssl::SSLContextSpi::providerInit | ( | security::SecureRandom * | random | ) | [pure virtual] |
Perform the initialization of this Context.
- Parameters:
-
random Pointer to an instance of a secure random number generator.
- Exceptions:
-
NullPointerException if the SecureRandom instance is NULL. KeyManagementException if an error occurs while initializing the context.
Implemented in decaf::internal::net::ssl::openssl::OpenSSLContextSpi.
The documentation for this class was generated from the following file:
- src/main/decaf/net/ssl/SSLContextSpi.h
