com.softwareag.um.io.ServerSSLTransportContext Class Reference

Constructed using the ServerSSLTransportContext.Builder. More...

Inheritance diagram for com.softwareag.um.io.ServerSSLTransportContext:
com.softwareag.um.io.ServerSocketTransportContext com.softwareag.um.io.ServerTransportContext com.softwareag.um.io.TransportContext

Public Member Functions

String getCertRevocationClassname ()
 Get the name of the class that is used to handle the revocation file. More...
 
String getCertRevocationListFile ()
 Get the location of the revocation list file. More...
 
String[] getEnabledCiphers ()
 Get the ciphers that will be enabled if supported by the SSL ServerTransport. More...
 
String getJSSEProvider ()
 Get the JSSEProvider that will be used by SSL ServerTransports created using this context. More...
 
String getKeyStore ()
 Get the location of the key store where the server certificate is stored. More...
 
String getKeyStorePassword ()
 Get the password that is used to access the key store. More...
 
String getPrivateKeyPassword ()
 Get the password that required for the private key. More...
 
String getRandomNumberAlgorithm ()
 Get the random number algorithm that will be used by SSL ServerTransports created using this context The String will be passed to java.security.SecureRandom.getInstance(). More...
 
String getRandomNumberProvider ()
 Get the random number provider that will be used by SSL ServerTransports created using this context. More...
 
String[] getSupportedCiphers ()
 Get the ciphers that will be supported by the SSL ServerTransport. More...
 
String getTrustStore ()
 Get the location of the trust store that is used to validate certificates. More...
 
String getTrustStorePassword ()
 Get the password used to access the trust store. More...
 
boolean isClientCertificateValidationRequired ()
 Used to determine whether or not the client is required to present a certificate. More...
 
- Public Member Functions inherited from com.softwareag.um.io.ServerSocketTransportContext
final String getAdapter ()
 Returns the adapter that will be bound to by ServerTransports created using this ServerContext. More...
 
final int getPort ()
 Returns the port that will be used by ServerTransports created using this ServerContext. More...
 
final int getReadBufferSize ()
 Get the read buffer size in bytes that will be used by ServerTransports created using this ServerContext. More...
 
final int getWriteBufferSize ()
 Get the write buffer size in bytes that will be used by ServerTransports created using this ServerContext. More...
 
boolean supportsAsync ()
 This ServerTransportContext supports Async which means that it can be used to create AsynchronousServerTransports using the TransportFactory.bind variant which takes callback objects. More...
 

Detailed Description

Constructed using the ServerSSLTransportContext.Builder.

All information must be set on the Builder so that when this object is built, it is validated. It is used to create Transport objects using TransportFactory.connect. Communication on the transport SSL encrypted and transmitted using Sockets.

Member Function Documentation

String com.softwareag.um.io.ServerSSLTransportContext.getCertRevocationClassname ( )

Get the name of the class that is used to handle the revocation file.

Returns
the class name of the revocation file handler
String com.softwareag.um.io.ServerSSLTransportContext.getCertRevocationListFile ( )

Get the location of the revocation list file.

This file contains a list of certificates that should not be seen as valid even if the trust store thinks they are.

Returns
String [] com.softwareag.um.io.ServerSSLTransportContext.getEnabledCiphers ( )

Get the ciphers that will be enabled if supported by the SSL ServerTransport.

Returns
an array of ciphers
String com.softwareag.um.io.ServerSSLTransportContext.getJSSEProvider ( )

Get the JSSEProvider that will be used by SSL ServerTransports created using this context.

The String will be passed to SSLContext.getInstance()

Returns
The JSSEProvider
String com.softwareag.um.io.ServerSSLTransportContext.getKeyStore ( )

Get the location of the key store where the server certificate is stored.

Returns
the path to the key store
String com.softwareag.um.io.ServerSSLTransportContext.getKeyStorePassword ( )

Get the password that is used to access the key store.

Returns
the password of the key store
String com.softwareag.um.io.ServerSSLTransportContext.getPrivateKeyPassword ( )

Get the password that required for the private key.

Returns
the password used to access the private key
String com.softwareag.um.io.ServerSSLTransportContext.getRandomNumberAlgorithm ( )

Get the random number algorithm that will be used by SSL ServerTransports created using this context The String will be passed to java.security.SecureRandom.getInstance().

Returns
The random number algorithm identifier
String com.softwareag.um.io.ServerSSLTransportContext.getRandomNumberProvider ( )

Get the random number provider that will be used by SSL ServerTransports created using this context.

Returns
The class name of the random number provider
String [] com.softwareag.um.io.ServerSSLTransportContext.getSupportedCiphers ( )

Get the ciphers that will be supported by the SSL ServerTransport.

Returns
an array of ciphers
String com.softwareag.um.io.ServerSSLTransportContext.getTrustStore ( )

Get the location of the trust store that is used to validate certificates.

Returns
the location of the trust store
String com.softwareag.um.io.ServerSSLTransportContext.getTrustStorePassword ( )

Get the password used to access the trust store.

Returns
the password used to access the trust store
boolean com.softwareag.um.io.ServerSSLTransportContext.isClientCertificateValidationRequired ( )

Used to determine whether or not the client is required to present a certificate.

Returns
true if the client needs to present a certificate to the server