public abstract class

IdentityScope

extends Identity

java.lang.Object
↳	java.security.Identity
	↳	java.security.IdentityScope

Known Direct Subclasses

IdentityDatabase

This class is deprecated.
This class is no longer used. Its functionality has been replaced by java.security.KeyStore, the java.security.cert package, and java.security.Principal.

Class Overview

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 IdentityScope can contain Identity objects of all kinds, including Signers. All types of 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.

Summary

Public Constructors
	IdentityScope(String name) Constructs a new identity scope with the specified name.
	IdentityScope(String name, IdentityScope scope) Constructs a new identity scope with the specified name and scope.

Protected Constructors
	IdentityScope() This constructor is used for serialization only and should not be used by subclasses.

Public Methods
abstract void	addIdentity(Identity identity) Adds an identity to this identity scope.
abstract Identity	getIdentity(String name) Returns the identity in this scope with the specified name (if any).
abstract Identity	getIdentity(PublicKey key) Retrieves the identity with the specified public key.
Identity	getIdentity(Principal principal) Retrieves the identity whose name is the same as that of the specified principal.
static IdentityScope	getSystemScope() Returns the system's identity scope.
abstract Enumeration<Identity>	identities() Returns an enumeration of all identities in this identity scope.
abstract void	removeIdentity(Identity identity) Removes an identity from this identity scope.
abstract int	size() Returns the number of identities within this identity scope.
String	toString() Returns a string representation of this identity scope, including its name, its scope name, and the number of identities in this identity scope.

Protected Methods
static void	setSystemScope(IdentityScope scope) Sets the system's identity scope.

[Expand]

Inherited Methods

From class java.security.Identity

void	addCertificate(Certificate certificate) Adds a certificate for this identity.
Certificate[]	certificates() Returns a copy of all the certificates for this identity.
final boolean	equals(Object identity) Tests for equality between the specified object and this identity.
String	getInfo() Returns general information previously specified for this identity.
final String	getName() Returns this identity's name.
PublicKey	getPublicKey() Returns this identity's public key.
final IdentityScope	getScope() Returns this identity's scope.
int	hashCode() Returns a hashcode for this identity.
boolean	identityEquals(Identity identity) Tests for equality between the specified identity and this identity.
void	removeCertificate(Certificate certificate) Removes a certificate from this identity.
void	setInfo(String info) Specifies a general information string for this identity.
void	setPublicKey(PublicKey key) Sets this identity's public key.
String	toString(boolean detailed) Returns a string representation of this identity, with optionally more details than that provided by the `toString` method without any arguments.
String	toString() Returns a short string describing this identity, telling its name and its scope (if any).

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.security.Principal

Public Constructors

public IdentityScope (String name)

Constructs a new identity scope with the specified name.

Parameters

name	the scope name.

public IdentityScope (String name, IdentityScope scope)

Constructs a new identity scope with the specified name and scope.

Parameters

name	the scope name.
scope	the scope for the new identity scope.

Throws

KeyManagementException	if there is already an identity with the same name in the scope.

Protected Constructors

protected IdentityScope ()

This constructor is used for serialization only and should not be used by subclasses.

Public Methods

public abstract void addIdentity (Identity identity)

Adds an identity to this identity scope.

Parameters

identity	the 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 Identity getIdentity (String name)

Returns the identity in this scope with the specified name (if any).

Parameters

name	the name of the identity to be retrieved.

Returns

the identity named name, or null if there are no identities named name in this scope.

public abstract Identity getIdentity (PublicKey key)

Retrieves the identity with the specified public key.

Parameters

key	the public key for the identity to be returned.

Returns

the identity with the given key, or null if there are no identities in this scope with that key.

public Identity getIdentity (Principal principal)

Retrieves the identity whose name is the same as that of the specified principal. (Note: Identity implements Principal.)

Parameters

principal	the principal corresponding to the identity to be retrieved.

Returns

the identity whose name is the same as that of the principal, or null if there are no identities of the same name in this scope.

public static IdentityScope getSystemScope ()

Returns the system's identity scope.

Returns

the system's identity scope.

public abstract Enumeration<Identity> identities ()

Returns an enumeration of all identities in this identity scope.

Returns

an enumeration of all identities in this identity scope.

public abstract void removeIdentity (Identity identity)

Removes an identity from this identity scope.

Parameters

identity	the identity to be removed.

Throws

KeyManagementException	if the identity is missing, or another exception occurs.

public abstract int size ()

Returns the number of identities within this identity scope.

Returns

the number of identities within this identity scope.

public String toString ()

Returns a string representation of this identity scope, including its name, its scope name, and the number of identities in this identity scope.

Returns

a string representation of this identity scope.

Protected Methods

protected static void setSystemScope (IdentityScope scope)

Sets the system's identity scope.

First, if there is a security manager, its checkSecurityAccess method is called with "setSystemScope" as its argument to see if it's ok to set the identity scope.

Parameters

scope	the scope to set.

Throws

SecurityException	if a security manager exists and its `checkSecurityAccess` method doesn't allow setting the identity scope.

Interfaces

Classes

Enums

Exceptions

IdentityScope

Class Overview

See Also

Summary

Public Constructors

public IdentityScope (String name)

Parameters

public IdentityScope (String name, IdentityScope scope)

Parameters

Throws

Protected Constructors

protected IdentityScope ()

Public Methods

public abstract void addIdentity (Identity identity)

Parameters

Throws

public abstract Identity getIdentity (String name)

Parameters

Returns

public abstract Identity getIdentity (PublicKey key)

Parameters

Returns

public Identity getIdentity (Principal principal)

Parameters

Returns

public static IdentityScope getSystemScope ()

Returns

See Also

public abstract Enumeration<Identity> identities ()

Returns

public abstract void removeIdentity (Identity identity)

Parameters

Throws

public abstract int size ()

Returns

public String toString ()

Returns

Protected Methods

protected static void setSystemScope (IdentityScope scope)

Parameters

Throws

See Also