com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface Class Reference

This class contains all the configuration required by the Nirvana Realm server to start and control the HTTPS interface. More...

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

com.pcbsys.nirvana.nAdminAPI.nHTTPInterface com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI com.pcbsys.nirvana.nAdminAPI.nInterface

Public Member Functions

String getAlias ()
 Returns the certificate name/alias that this interface uses as its primary certificate.
boolean 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.
 nHTTPSInterface (String adapter, int port, boolean autostart) throws nAdminIllegalArgumentException
 Creates a new HTTPS interface bound to the adapter and port supplied.
 nHTTPSInterface (String adapter, int port) throws nAdminIllegalArgumentException
 Creates a new HTTPS interface bound to the adapter and port supplied.
void setAlias (String alias) throws nAdminIllegalArgumentException
 Sets the certificate name/alias that this interface will use to select its certificate from a keystore with multpiple entries.
void setCertRequired (boolean 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, boolean checkSupported) throws nAdminIllegalArgumentException
 Specifies the names of the ciphers enabled for use by this interface.
void setEnabledCiphers (String[] ciphers) throws nAdminIllegalArgumentException
 Specifies the names of the ciphers enabled for use by this interface.
void setKeyStore (String keyStore) throws nAdminIllegalArgumentException
 Sets the keystore file that this interface uses to load the certificate from.
void setKeyStorePassword (String keyStorePassword) throws nAdminIllegalArgumentException
 Sets the keystore password that this interface will use to access the keystore file specified.
void setPrivateKeyPassword (String password) throws nAdminIllegalArgumentException
 Sets the private key password so that the key can be loaded from the key store.
void setProvider (String provider)
 Set the name of the JSSE provider to use.
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) throws nAdminIllegalArgumentException
 Sets the truststore file that this interface uses to validate the client certificate against.
void setTrustStorePassword (String trustStorePassword) throws nAdminIllegalArgumentException
 Changes the truststore's password that the server uses to access the trust store.

Detailed Description

This class contains all the configuration required by the Nirvana Realm server to start and control the HTTPS interface.

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.nHTTPSInterface ( String  adapter,
int  port 
) throws nAdminIllegalArgumentException

Creates a new HTTPS interface bound to the adapter and port supplied.

Parameters:
adapter to bind to
port to bind to

com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.nHTTPSInterface ( String  adapter,
int  port,
boolean  autostart 
) throws nAdminIllegalArgumentException

Creates a new HTTPS interface bound to the adapter and port supplied.

Parameters:
adapter to bind to
port to bind to
autostart Shoud it be autostarted

Member Function Documentation

String com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.getAlias (  ) 

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

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

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

boolean com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.getCRLFile (  ) 

Returns the Certificate revocation list that the server uses.

Returns:
the CRL file name that the interface uses

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String [] com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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
See also:
nSSLInterface

nHTTPSInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String [] com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

String com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setAlias ( String  alias  )  throws nAdminIllegalArgumentException

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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setCertRequired ( boolean  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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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 full path of the CRL file to use

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.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

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setEnabledCiphers ( String[]  ciphers,
boolean  checkSupported 
) throws nAdminIllegalArgumentException

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

Parameters:
ciphers a String[] of ciphers enabled for use by this interface
checkSupported a boolean to indicate whether to validate the list against those ciphers supported by the server
Exceptions:
nAdminIllegalArgumentException if an empty or null array is specified
See also:
nSSLInterface

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setEnabledCiphers ( String[]  ciphers  )  throws nAdminIllegalArgumentException

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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setKeyStore ( String  keyStore  )  throws nAdminIllegalArgumentException

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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setKeyStorePassword ( String  keyStorePassword  )  throws nAdminIllegalArgumentException

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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setPrivateKeyPassword ( String  password  )  throws nAdminIllegalArgumentException

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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setProvider ( String  provider  ) 

Set the name of the JSSE provider to use.

Parameters:
provider the name of the JSSE provider to use

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setRandomAlgorithm ( String  alg  ) 

Sets the SecureRandom algorithm to use for this interface.

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

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setRandomProvider ( String  prov  ) 

Sets the SecureRandom provider to use for this interface.

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

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setTrustStore ( String  trustStore  )  throws nAdminIllegalArgumentException

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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.

void com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.setTrustStorePassword ( String  trustStorePassword  )  throws nAdminIllegalArgumentException

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
See also:
nSSLInterface

Implements com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.