oracle.security.xmlsec.keys.retrieval

Class KeyStoreKeyRetriever

java.lang.Object

oracle.security.xmlsec.keys.retrieval.KeyRetriever

oracle.security.xmlsec.keys.retrieval.KeyStoreKeyRetriever

public class KeyStoreKeyRetriever
extends KeyRetriever

Keystore key and certificates retrieval utility class.

Since:

release specific (what release of product did this appear in)

Version:

$Header: entsec_ldap/java/src/oracle/security/xmlsec/keys/retrieval/KeyStoreKeyRetriever.java sandeer_bug-37183808_osdt_javadoc/4 2024/11/08 10:29:20 sandeer Exp $

Constructor Summary

Constructors

Constructor and Description
KeyStoreKeyRetriever(java.security.KeyStore ks, char[] keyPassword)

Method Summary

Modifier and Type	Method and Description
protected java.security.cert.X509Certificate	retrieveCertificate(KeyInfoData keyInfo) Retrieves the certificate identified by the given KeyInfoData.
protected java.security.PrivateKey	retrievePrivateKey(KeyInfoData keyInfo) Retrieves the private key identified by the given KeyInfoData.
protected java.security.PublicKey	retrievePublicKey(KeyInfoData keyInfo) Retrieves the public key identified by the given KeyInfoData.

Methods inherited from class oracle.security.xmlsec.keys.retrieval.KeyRetriever

addKeyRetriever, getAuthenticator, getCertificate, getCertificate, getPrivateKey, getPrivateKey, getPublicKey, getPublicKey, getSymmetricKey, getSymmetricKey, removeKeyRetriever, retrieveCertificate, retrievePrivateKey, retrievePublicKey, retrieveSymmetricKey, retrieveSymmetricKey, setAuthenticator, setCertificateValidator, validateCertificate, validateCertificate, validateCertificate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStoreKeyRetriever

public KeyStoreKeyRetriever(java.security.KeyStore ks,
                            char[] keyPassword)

Method Detail

retrieveCertificate

protected java.security.cert.X509Certificate retrieveCertificate(KeyInfoData keyInfo)
                                                          throws KeyRetrievalException

Description copied from class: KeyRetriever

Retrieves the certificate identified by the given KeyInfoData. If this method is not overridden it always returns null.

Overrides:

retrieveCertificate in class KeyRetriever

Parameters:

keyInfo - A KeyInfoData to be used to locate the certificate.

Returns:

A X509Certificate, or null if none could be located.

Throws:

StorageAuthenticationException - If an error occurs authenticating to the key source.

KeyRetrievalException

retrievePrivateKey

protected java.security.PrivateKey retrievePrivateKey(KeyInfoData keyInfo)
                                               throws KeyRetrievalException

Description copied from class: KeyRetriever

Retrieves the private key identified by the given KeyInfoData. If this method is not overridden it always returns null.

Overrides:

retrievePrivateKey in class KeyRetriever

Parameters:

keyInfo - A KeyInfoData to be used to locate the private key.

Returns:

A PrivateKey, or null if none could be located.

Throws:

StorageAuthenticationException - If an error occurs authenticating to the key source.

KeyRetrievalException

retrievePublicKey

protected java.security.PublicKey retrievePublicKey(KeyInfoData keyInfo)
                                             throws KeyRetrievalException

Description copied from class: KeyRetriever

Retrieves the public key identified by the given KeyInfoData. If this method is not overridden it always returns null.

Overrides:

retrievePublicKey in class KeyRetriever

Parameters:

keyInfo - A KeyInfoData to be used to locate the public key.

Returns:

A PublicKey, or null if none could be located.

Throws:

StorageAuthenticationException - If an error occurs authenticating to the key source.

KeyRetrievalException