This class represents a scope for identities. It is an Identity * itself, and therefore has a name and can have a scope. It can also * optionally have a public key and associated certificates. * *
An {@code IdentityScope} can contain {@code Identity} objects of all * kinds, including signers. All types of {@code Identity} objects can be * retrieved, added, and removed using the same methods. Note that it is * possible, and in fact expected, that different types of identity scopes will * apply different policies for their various operations on the * various types of Identities. * *
There is a one-to-one mapping between keys and identities, and
* there can only be one copy of one key per scope. For example, suppose
* Acme Software, Inc is a software publisher known to a user.
* Suppose it is an Identity, that is, it has a public key, and a set of
* associated certificates. It is named in the scope using the name
* "Acme Software". No other named Identity in the scope has the same
* public key. Of course, none has the same name as well.
*
* @see Identity
* @see Signer
* @see Principal
* @see Key
*
* @author Benjamin Renaud
* @since 1.1
*
* @deprecated This class is deprecated and subject to removal in a future
* version of Java SE. It has been replaced by
* {@code java.security.KeyStore}, the {@code java.security.cert} package,
* and {@code java.security.Principal}.
*/
@Deprecated(since="1.2", forRemoval=true)
@SuppressWarnings("removal")
public abstract
class IdentityScope extends Identity {
@java.io.Serial
private static final long serialVersionUID = -2337346281189773310L;
/* The system's scope */
private static IdentityScope scope;
// initialize the system scope
private static void initializeSystemScope() {
String classname = Security.getProperty("system.scope");
if (classname == null) {
return;
} else {
try {
Class.forName(classname);
} catch (ClassNotFoundException e) {
System.err.println("unable to establish a system scope from " +
classname);
e.printStackTrace();
}
}
}
/**
* This constructor is used for serialization only and should not
* be used by subclasses.
*/
protected IdentityScope() {
this("restoring...");
}
/**
* Constructs a new identity scope with the specified name.
*
* @param name the scope name.
*/
public IdentityScope(String name) {
super(name);
}
/**
* Constructs a new identity scope with the specified name and scope.
*
* @param name the scope name.
* @param scope the scope for the new identity scope.
*
* @throws KeyManagementException if there is already an {@code Identity}
* with the same name in the scope.
*/
public IdentityScope(String name, IdentityScope scope)
throws KeyManagementException {
super(name, scope);
}
/**
* Returns the system's identity scope.
*
* @return the system's identity scope, or {@code null} if none has been
* set.
*
* @see #setSystemScope
*/
public static IdentityScope getSystemScope() {
if (scope == null) {
initializeSystemScope();
}
return scope;
}
/**
* Sets the system's identity scope.
*
* @param scope the scope to set.
*
* @see #getSystemScope
*/
protected static void setSystemScope(IdentityScope scope) {
IdentityScope.scope = scope;
}
/**
* Returns the number of identities within this identity scope.
*
* @return the number of identities within this identity scope.
*/
public abstract int size();
/**
* Returns the {@code Identity} in this scope with the specified
* name (if any).
*
* @param name the name of the {@code Identity} to be retrieved.
*
* @return the {@code Identity} named {@code name}, or {@code null}
* if there are no identities named {@code name} in this scope.
*/
public abstract Identity getIdentity(String name);
/**
* Retrieves the {@code Identity} whose name is the same as that of the
* specified principal. (Note: {@code Identity} implements
* {@code Principal}.)
*
* @param principal the principal corresponding to the {@code Identity}
* to be retrieved.
*
* @return the {@code Identity} whose name is the same as that of the
* principal, or {@code null} if there are no identities of the same name
* in this scope.
*/
public Identity getIdentity(Principal principal) {
return getIdentity(principal.getName());
}
/**
* Retrieves the {@code identity} with the specified public key.
*
* @param key the public key for the identity to be returned.
*
* @return the identity with the given key, or {@code null} if there are
* no identities in this scope with that key.
*/
public abstract Identity getIdentity(PublicKey key);
/**
* Adds an {@code Identity} to this identity scope.
*
* @param identity the {@code Identity} to be added.
*
* @throws KeyManagementException if the identity is not
* valid, a name conflict occurs, another identity has the same
* public key as the identity being added, or another exception
* occurs. */
public abstract void addIdentity(Identity identity)
throws KeyManagementException;
/**
* Removes an {@code Identity} from this identity scope.
*
* @param identity the {@code Identity} to be removed.
*
* @throws KeyManagementException if the identity is missing,
* or another exception occurs.
*/
public abstract void removeIdentity(Identity identity)
throws KeyManagementException;
/**
* Returns an enumeration of all identities in this identity scope.
*
* @return an enumeration of all identities in this identity scope.
*/
public abstract Enumeration