Package org.cumulus4j.keymanager.api

API for accessing the key manager.

See:
Description

Interface Summary

CryptoSession	A CryptoSession is a session in which key transfers can be performed.
KeyManagerAPI	Entry point for the key management API.

Class Summary

DateDependentKeyStrategyInitParam	Options controlling how org.cumulus4j.keymanager.DateDependentKeyStrategy.init(...) should behave.
DateDependentKeyStrategyInitResult	Result of the operation org.cumulus4j.keymanager.DateDependentKeyStrategy.init(...).
DefaultKeyManagerAPI	Implementation of KeyManagerAPI that delegates to a specific implementation.
KeyManagerAPIConfiguration	Configuration of the KeyManagerAPI.

Exception Summary

AuthenticationException	Wrapper for AuthenticationException.
CannotDeleteLastUserException	Wrapper for CannotDeleteLastUserException.
KeyManagerAPIInstantiationException	Thrown if a KeyManagerAPI implementation cannot be instantiated.
KeyManagerException	Base class for all checked exceptions thrown by KeyManagerAPI (and related API).
KeyStoreNotEmptyException	Thrown, if an empty KeyStore is expected, but the key-store is not empty.

Package org.cumulus4j.keymanager.api Description

API for accessing the key manager.

The entry point into this API is the KeyManagerAPI. It provides a generic way to manage a KeyStore either in the local file system or on a remote key-server (as shown in Deployment scenarios).

An application server using Cumulus4j is only able to read or write data, when the key manager grants access to keys. In order to control this access, crypto-sessions are used (not to be confused with a servlet's session): An application server can only request a key from a key manager, when the crypto-session exists and is unlocked. Usually, a client will first unlock the session, then send a request to the app server and when the app server responded, lock the session, again. Thus most of the time, a key manager will reject access to keys, even while a connection between app server and key manager exists.