com.iplanet.trustbase.initiator
Interface ConfigAdapter

All Known Implementing Classes:

PropertyConfigAdapter, ConfigAdapterImpl

public interface ConfigAdapter

Interface to the host property system.

See Also:

ConfigAdapterException

Method Summary

java.security.cert.X509Certificate[]	completeChain(java.security.cert.X509Certificate certificate) Completes a chain given a supplied certificate.
java.lang.Object	getObjectProperty(java.lang.String property) Get an object property from the system.
java.lang.String	getProperty(java.lang.String property) Get a property from the system
java.security.PrivateKey	getSignerKey() Get the private key used to sign the request message
java.security.cert.X509Certificate[]	getSignerPath() Get the certificate path that will be included in the request as the signer's certificate path.
java.security.PrivateKey	getSSLSignerKey() Get the signing key for SSL Client Transactions
java.security.cert.X509Certificate[]	getSSLSignerPath() Get the SSL Client Certificate to use for SSL negotiation.
java.security.cert.X509Certificate[][]	getVerificationPaths() Get the set of certificate paths that will be used to verify the response message.
void	validateChain(java.security.cert.X509Certificate[] chain) Validate a supplied certificate chain.

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String property)
                             throws ConfigAdapterException

Get a property from the system

Parameters:

property - the name of the property required

Returns:

the value of the property or null if it is not present

Throws:

ConfigAdapterException - if the property could not be found and processing should not continue.

getObjectProperty

public java.lang.Object getObjectProperty(java.lang.String property)
                                   throws ConfigAdapterException

Get an object property from the system. all object properties are optional. A null return signifies that the object is not present in the system.

Parameters:

property - the name of the property required.

Returns:

the value of the property or null if the property is not present in the system.

Throws:

ConfigAdapterException - if the property could not be found and processing should not continue.

getSignerPath

public java.security.cert.X509Certificate[] getSignerPath()
                                                   throws ConfigAdapterException

Get the certificate path that will be included in the request as the signer's certificate path. This is the certificate that will be used to sign requests.

Returns:

the signing certificate path or null if not found

Throws:

ConfigAdapterException - if the path could not be retrieved and processing should not continue.

getVerificationPaths

public java.security.cert.X509Certificate[][] getVerificationPaths()
                                                            throws ConfigAdapterException

Get the set of certificate paths that will be used to verify the response message.

Returns:

the verification paths or null if not found

Throws:

CSCConfigException - if the paths could not be retrieved and processing should not continue.

getSignerKey

public java.security.PrivateKey getSignerKey()
                                      throws ConfigAdapterException

Get the private key used to sign the request message

Returns:

the signing key or null if not found

Throws:

ConfigAdapterException - if the key could not be retrieved and processing should not continue.

getSSLSignerPath

public java.security.cert.X509Certificate[] getSSLSignerPath()
                                                      throws ConfigAdapterException

Get the SSL Client Certificate to use for SSL negotiation.

Returns:

the SSL client signing certificate chain.

Throws:

ConfigAdapterException - if the certificate chain could not be returned.

getSSLSignerKey

public java.security.PrivateKey getSSLSignerKey()
                                         throws ConfigAdapterException

Get the signing key for SSL Client Transactions

Returns:

the private for SSL Client signing.

Throws:

ConfigAdapterException - if the key could not be returned.

validateChain

public void validateChain(java.security.cert.X509Certificate[] chain)
                   throws ConfigAdapterException

Validate a supplied certificate chain.

Parameters:

certificateChain - is the certificate chain to check.

completeChain

public java.security.cert.X509Certificate[] completeChain(java.security.cert.X509Certificate certificate)
                                                   throws ConfigAdapterException

Completes a chain given a supplied certificate.

Parameters:

certificate - The certificate to try and complete

Returns:

The chain

Throws:

ConfigAdapterException - if it is unable to complete the chain