public
abstract
class
IdentityScope
extends Identity
java.lang.Object | ||
↳ | java.security.Identity | |
↳ | java.security.IdentityScope |
This class was deprecated
in API level 1.
This class is no longer used. Its functionality has been
replaced by java.security.KeyStore
, the
java.security.cert
package, and
java.security.Principal
.
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.
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. |
Inherited methods | |
---|---|
From
class
java.security.Identity
| |
From
class
java.lang.Object
| |
From
interface
java.security.Principal
|
IdentityScope (String name)
Constructs a new identity scope with the specified name.
Parameters | |
---|---|
name |
String :
the scope name.
|
IdentityScope (String name, IdentityScope scope)
Constructs a new identity scope with the specified name and scope.
Parameters | |
---|---|
name |
String :
the scope name. |
scope |
IdentityScope :
the scope for the new identity scope. |
Throws | |
---|---|
KeyManagementException |
if there is already an identity with the same name in the scope. |
IdentityScope ()
This constructor is used for serialization only and should not be used by subclasses.
void addIdentity (Identity identity)
Adds an identity to this identity scope.
Parameters | |
---|---|
identity |
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. |
Identity getIdentity (String name)
Returns the identity in this scope with the specified name (if any).
Parameters | |
---|---|
name |
String :
the name of the identity to be retrieved. |
Returns | |
---|---|
Identity |
the identity named name , or null if there are
no identities named name in this scope.
|
Identity getIdentity (PublicKey key)
Retrieves the identity with the specified public key.
Parameters | |
---|---|
key |
PublicKey :
the public key for the identity to be returned. |
Returns | |
---|---|
Identity |
the identity with the given key, or null if there are no identities in this scope with that key. |
Identity getIdentity (Principal principal)
Retrieves the identity whose name is the same as that of the specified principal. (Note: Identity implements Principal.)
Parameters | |
---|---|
principal |
Principal :
the principal corresponding to the identity
to be retrieved. |
Returns | |
---|---|
Identity |
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. |
IdentityScope getSystemScope ()
Returns the system's identity scope.
Returns | |
---|---|
IdentityScope |
the system's identity scope, or null if none has been
set. |
See also:
Enumeration<Identity> identities ()
Returns an enumeration of all identities in this identity scope.
Returns | |
---|---|
Enumeration<Identity> |
an enumeration of all identities in this identity scope. |
void removeIdentity (Identity identity)
Removes an identity from this identity scope.
Parameters | |
---|---|
identity |
Identity :
the identity to be removed. |
Throws | |
---|---|
KeyManagementException |
if the identity is missing, or another exception occurs. |
int size ()
Returns the number of identities within this identity scope.
Returns | |
---|---|
int |
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.
Returns | |
---|---|
String |
a string representation of this identity scope. |
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 |
IdentityScope :
the scope to set. |
Throws | |
---|---|
SecurityException |
if a security manager exists and its
checkSecurityAccess method doesn't allow
setting the identity scope. |