com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI Interface Reference

This interface is used to expose the SSL attributes for all interfaces that are SSL enabled. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI:

com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface com.pcbsys.nirvana.nAdminAPI.nSSLInterface

Public Member Functions

string getAlias ()
 Returns the certificate name/alias that this interface uses as its primary certificate.
bool getCertRequired ()
 Returns whether this interface requires SSL client authentication or not.
string getCRLFile ()
 Returns the Certificate revocation list that the server uses.
string getCRLValidationClassName ()
 Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management.
string[] getEnabledCiphers ()
 Returns an array of strings which represent the current Ciphers enabled for use by this interface.
string getKeyStore ()
 Returns the name of the keystore file that this interface uses to load the certificate from.
string getProvider ()
 Get the name of the JSSE provider used by this SSL interface.
string getRandomAlgorithm ()
 Returns the SecureRandom algoritm used for this interface.
string getRandomProvider ()
 Returns the SecureRandom provider used by this interface.
string[] getSupportedCiphers ()
 Returns an array of ciphers this this interface can be configured for use by this interface.
string getTrustStore ()
 Returns the current truststore file that this interface uses to validate the client certificate chain against.
void setAlias (string alias)
 Sets the certificate name/alias that this interface will use to select its certificate from a keystore with multpiple entries.
void setCertRequired (bool required)
 Specifies whether this interface requires SSL client authentication or not.
void setCRLFile (string fileName)
 Sets the Certificate revocation list file name that the interface should use to check the incomming ssl connections.
void setCRLValidationClassName (string className)
 Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management.
void setEnabledCiphers (string[] ciphers)
 Specifies the names of the ciphers enabled for use by this interface.
void setKeyStore (string keyStore)
 Sets the keystore file that this interface uses to load the certificate from.
void setKeyStorePassword (string keyStorePassword)
 Sets the keystore password that this interface will use to access the keystore file specified.
void setPrivateKeyPassword (string password)
 Sets the private key password so that the key can be loaded from the key store.
void setProvider (string providerName)
 Sets the name of the JSSE provider to use for the interface.
void setRandomAlgorithm (string alg)
 Sets the SecureRandom algorithm to use for this interface.
void setRandomProvider (string prov)
 Sets the SecureRandom provider to use for this interface.
void setTrustStore (string trustStore)
 Sets the truststore file that this interface uses to validate the client certificate against.
void setTrustStorePassword (string trustStorePassword)
 Changes the truststore's password that the server uses to access the trust store.

Detailed Description

This interface is used to expose the SSL attributes for all interfaces that are SSL enabled.

If a class implements this interface it means that they support the listed API's and that SSL is active.

Member Function Documentation

string com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getAlias (  ) 

Returns the certificate name/alias that this interface uses as its primary certificate.

Returns:
the Name/Alias of the certificate as a String
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

bool com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getCertRequired (  ) 

Returns whether this interface requires SSL client authentication or not.

If this is set to false then this interface allows anonymous connections using SSL. Otherwise the client must have and present a valid certificate chain during the SSL handshake.

Returns:
a boolean specifying the SSL client authentication setting
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getCRLFile (  ) 

Returns the Certificate revocation list that the server uses.

Returns:
the CRL file name that the interface uses

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getCRLValidationClassName (  ) 

Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management.

The class name can be supplied per interface and then when a client connects a callout is issued to this class to validate the connection.

Returns:
current class name of the CRL validation

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string [] com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getEnabledCiphers (  ) 

Returns an array of strings which represent the current Ciphers enabled for use by this interface.

Returns:
a String[] containing the names of the ciphers enabled for use by this interface
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getKeyStore (  ) 

Returns the name of the keystore file that this interface uses to load the certificate from.

Returns:
The name of the keystore file to use as a String
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getProvider (  ) 

Get the name of the JSSE provider used by this SSL interface.

Returns:
The name of the JSSE provider being used for the interface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getRandomAlgorithm (  ) 

Returns the SecureRandom algoritm used for this interface.

If it is null it uses the system default algorithm.

Returns:
a String specifying the Random Algorithm used by this interface
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getRandomProvider (  ) 

Returns the SecureRandom provider used by this interface.

If it is null it uses the system default provider.

Returns:
a String specifying the Secure Random provider used by this interface
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string [] com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getSupportedCiphers (  ) 

Returns an array of ciphers this this interface can be configured for use by this interface.

If the cipher is not in this list then the interface can not support it.

Returns:
String[] of ciphers which can be configured for use by this interface
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

string com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getTrustStore (  ) 

Returns the current truststore file that this interface uses to validate the client certificate chain against.

Returns:
the Truststore file name as a String
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setAlias ( string  alias  ) 

Sets the certificate name/alias that this interface will use to select its certificate from a keystore with multpiple entries.

Parameters:
alias the name/alias to use as a String
Exceptions:
nAdminIllegalArgumentException if an illegal argument is specified
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setCertRequired ( bool  required  ) 

Specifies whether this interface requires SSL client authentication or not.

If this is set to false then this interface allows anonymous connections using SSL. Otherwise the client must have and present a valid certificate chain during the SSL handshake.

Parameters:
required a boolean specifying if this interface will force client authentication
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setCRLFile ( string  fileName  ) 

Sets the Certificate revocation list file name that the interface should use to check the incomming ssl connections.

Is only used when client certificates are required.

The file should be in a standard X.509 Certificate Revocation List (CRL)

Parameters:
fileName the CRL file name that the interface uses

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setCRLValidationClassName ( string  className  ) 

Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management.

The class name can be supplied per interface and then when a client connects a callout is issued to this class to validate the connection.

Parameters:
className the classname of the certificate validator to use within this interface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setEnabledCiphers ( string[]  ciphers  ) 

Specifies the names of the ciphers enabled for use by this interface.

Parameters:
ciphers a String[] of ciphers enabled for use by this interface
Exceptions:
nAdminIllegalArgumentException if an empty or null array is specified
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setKeyStore ( string  keyStore  ) 

Sets the keystore file that this interface uses to load the certificate from.

Parameters:
keyStore the new keystore name as a String
Exceptions:
nAdminIllegalArgumentException if an illegal argument is specified
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setKeyStorePassword ( string  keyStorePassword  ) 

Sets the keystore password that this interface will use to access the keystore file specified.

Parameters:
keyStorePassword the new password as a string
Exceptions:
nAdminIllegalArgumentException if an illegal argument is specified
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setPrivateKeyPassword ( string  password  ) 

Sets the private key password so that the key can be loaded from the key store.

Parameters:
password for the private key as a String
Exceptions:
nAdminIllegalArgumentException if an illegal argument is specified
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setProvider ( string  providerName  ) 

Sets the name of the JSSE provider to use for the interface.

Parameters:
providerName the name of the JSSE provider to use

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setRandomAlgorithm ( string  alg  ) 

Sets the SecureRandom algorithm to use for this interface.

Parameters:
alg the name of the new SecureRandom algorithm to use
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setRandomProvider ( string  prov  ) 

Sets the SecureRandom provider to use for this interface.

Parameters:
prov the name of the new SecureRandom provider to use
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setTrustStore ( string  trustStore  ) 

Sets the truststore file that this interface uses to validate the client certificate against.

Parameters:
trustStore the new truststore file to use
Exceptions:
nAdminIllegalArgumentException if an illegal argument is specified
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.

void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setTrustStorePassword ( string  trustStorePassword  ) 

Changes the truststore's password that the server uses to access the trust store.

Parameters:
trustStorePassword the new password to use as a String
Exceptions:
nAdminIllegalArgumentException if an illegal argument is specified
nSSLInterface nHTTPSInterface

Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.