net.java.truecommons.key.spec.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truecommons-key-spec Show documentation

Specifies a pluggable API for key management.

The newest version!

/*
 * Copyright (C) 2005-2015 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
/**
 * Provides an extensible manager for generic keys required for writing or
 * reading protected resources, for example encrypted files.
 * The primary objective of this API is to decouple...
 * 
 * the algorithms to create and persist keys required for writing and
 *     reading protected resources from...
 * 
the algorithms to use and validate these keys.
 * 
 * 
 * The algorithms to create and persist keys are processed by the interfaces
 * and classes in this package.
 * 

 * The algorithms to use and optionally validate keys is executed by the users
 * of this package - called client applications or clients for
 * short.
 * 

 * A protected resource can be of any type which can be identified by a
 * {@link java.net.URI}:
 * As an example, it could be a URL to an encrypted file which the client
 * application is going to create or overwrite.
 * 

 * The key could also be of any type, but typically its a user selectable
 * password.
 * 

 * The sub-packages of this package provide partial implementations which can
 * be easily extended to adapt to different user interface or persistence
 * technologies, e.g. Java Swing or Apple's Keychain.
 * 
 * Complete implementations are provided by different plug-in modules.
 * These modules get located by the
 * {@link net.java.truecommons.key.spec.sl.KeyManagerMapLocator#SINGLETON} by
 * searching the class path at run time.
 *
 * @since  TrueCommons 2.2
 * @author Christian Schlichtherle
 */
@javax.annotation.Nonnull @javax.annotation.ParametersAreNonnullByDefault
package net.java.truecommons.key.spec;