Package org.soulwing.s2ks

Interface KeyStorage

All Known Subinterfaces:

MutableKeyStorage

public interface KeyStorage

A key storage provider.

Author:

Carl Harris

Method Summary

Modifier and Type	Method	Description
java.security.Key	retrieve(java.lang.String id)	Retrieves a key.
KeyWithMetadata	retrieveWithMetadata(java.lang.String id)	Retrieves a key and its associated metadata.

Method Detail

retrieve

java.security.Key retrieve(java.lang.String id)
                    throws NoSuchKeyException,
                           KeyUnwrapException,
                           KeyStorageException

Retrieves a key.

Parameters:

id - unique identifier of the subject key

Returns:

key object

Throws:

NoSuchKeyException - if there is no key in storage with the given identifier

KeyUnwrapException - if an error occurs in unwrapping the stored key; e.g. one of the myriad checked exceptions thrown by the JCA API

KeyStorageException - if the underlying storage mechanism cannot successfully read the wrapped key from persistent storage

retrieveWithMetadata

KeyWithMetadata retrieveWithMetadata(java.lang.String id)
                              throws NoSuchKeyException,
                                     KeyUnwrapException,
                                     MetadataUnwrapException,
                                     KeyStorageException

Retrieves a key and its associated metadata.

Parameters:

id - unique identifier of the subject key

Returns:

key-with-metadata object

Throws:

NoSuchKeyException - if there is no key in storage with the given identifier

KeyUnwrapException - if an error occurs in unwrapping the stored key; e.g. one of the myriad checked exceptions thrown by the JCA API

MetadataUnwrapException - if an error occurs in decoding the metadata

KeyStorageException - if the underlying storage mechanism cannot successfully read the wrapped key from persistent storage