- com
- pcbsys
- nirvana
- nAdminAPI
- nSSLInterfaceAPI
This interface is used to expose the SSL attributes for all interfaces that are SSL enabled. More...
Public Member Functions | |
String | getAlias () |
Returns the certificate name/alias that this interface uses as its primary certificate. More... | |
boolean | getCertRequired () |
Returns whether this interface requires SSL client authentication or not. More... | |
String | getCRLFile () |
Returns the Certificate revocation list that the server uses. More... | |
String | getCRLValidationClassName () |
Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management. More... | |
String[] | getEnabledCiphers () |
Returns an array of strings which represent the current Ciphers enabled for use by this interface. More... | |
String | getKeyStore () |
Returns the name of the keystore file that this interface uses to load the certificate from. More... | |
String | getProvider () |
Get the name of the JSSE provider used by this SSL interface. More... | |
String | getRandomAlgorithm () |
Returns the SecureRandom algoritm used for this interface. More... | |
String | getRandomProvider () |
Returns the SecureRandom provider used by this interface. More... | |
String[] | getSupportedCiphers () |
Returns an array of ciphers this this interface can be configured for use by this interface. More... | |
String | getTrustStore () |
Returns the current truststore file that this interface uses to validate the client certificate chain against. More... | |
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. More... | |
void | setCertRequired (boolean required) |
Specifies whether this interface requires SSL client authentication or not. More... | |
void | setCRLFile (String fileName) |
Sets the Certificate revocation list file name that the interface should use to check the incomming ssl connections. More... | |
void | setCRLValidationClassName (String className) |
Any class that extends com.pcbsys.nirvana.server.api.nSSLCertficateValidator can be used by the server to perform CRL management. More... | |
void | setEnabledCiphers (String[] ciphers) throws nAdminIllegalArgumentException |
Specifies the names of the ciphers enabled for use by this interface. More... | |
void | setKeyStore (String keyStore) throws nAdminIllegalArgumentException |
Sets the keystore file that this interface uses to load the certificate from. More... | |
void | setKeyStorePassword (String keyStorePassword) throws nAdminIllegalArgumentException |
Sets the keystore password that this interface will use to access the keystore file specified. More... | |
void | setPrivateKeyPassword (String password) throws nAdminIllegalArgumentException |
Sets the private key password so that the key can be loaded from the key store. More... | |
void | setProvider (String providerName) |
Sets the name of the JSSE provider to use for the interface. More... | |
void | setRandomAlgorithm (String alg) |
Sets the SecureRandom algorithm to use for this interface. More... | |
void | setRandomProvider (String prov) |
Sets the SecureRandom provider to use for this interface. More... | |
void | setTrustStore (String trustStore) throws nAdminIllegalArgumentException |
Sets the truststore file that this interface uses to validate the client certificate against. More... | |
void | setTrustStorePassword (String trustStorePassword) throws nAdminIllegalArgumentException |
Changes the truststore's password that the server uses to access the trust store. More... | |
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.
String com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getAlias | ( | ) |
Returns the certificate name/alias that this interface uses as its primary certificate.
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
boolean 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.
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
String com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getCRLFile | ( | ) |
Returns the Certificate revocation list that the server 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.
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.
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
String com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getKeyStore | ( | ) |
Returns the name of the keystore file that this interface uses to load the certificate from.
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.
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.
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
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.
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
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.
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
String com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.getTrustStore | ( | ) |
Returns the current truststore file that this interface uses to validate the client certificate chain against.
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.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.
alias | the name/alias to use as a String |
nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.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.
required | a boolean specifying if this interface will force client authentication |
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)
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.
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 | ) | throws nAdminIllegalArgumentException |
Specifies the names of the ciphers enabled for use by this interface.
ciphers | a String[] of ciphers enabled for use by this interface |
nAdminIllegalArgumentException | if an empty or null array is specified |
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setKeyStore | ( | String | keyStore | ) | throws nAdminIllegalArgumentException |
Sets the keystore file that this interface uses to load the certificate from.
keyStore | the new keystore name as a String |
nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setKeyStorePassword | ( | String | keyStorePassword | ) | throws nAdminIllegalArgumentException |
Sets the keystore password that this interface will use to access the keystore file specified.
keyStorePassword | the new password as a string |
nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface, and com.pcbsys.nirvana.nAdminAPI.nSSLInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setPrivateKeyPassword | ( | String | password | ) | throws nAdminIllegalArgumentException |
Sets the private key password so that the key can be loaded from the key store.
password | for the private key as a String |
nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setProvider | ( | String | providerName | ) |
Sets the name of the JSSE provider to use for the interface.
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.
alg | the name of the new SecureRandom algorithm to use |
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setRandomProvider | ( | String | prov | ) |
Sets the SecureRandom provider to use for this interface.
prov | the name of the new SecureRandom provider to use |
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setTrustStore | ( | String | trustStore | ) | throws nAdminIllegalArgumentException |
Sets the truststore file that this interface uses to validate the client certificate against.
trustStore | the new truststore file to use |
nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.
void com.pcbsys.nirvana.nAdminAPI.nSSLInterfaceAPI.setTrustStorePassword | ( | String | trustStorePassword | ) | throws nAdminIllegalArgumentException |
Changes the truststore's password that the server uses to access the trust store.
trustStorePassword | the new password to use as a String |
nAdminIllegalArgumentException | if an illegal argument is specified |
Implemented in com.pcbsys.nirvana.nAdminAPI.nSSLInterface, and com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface.