| |
|
| java.lang.Object
 java.security.Identity
java.security.IdentityScope
| IdentityScope | | abstract public class IdentityScope extends Identity (Code) | | 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.
See Also: Identity
See Also: Signer
See Also: Principal
See Also: Key
version:
1.62 07/05/05
author:
Benjamin Renaud |
| Constructor Summary | |
| protected | IdentityScope()
This constructor is used for serialization only and should not
be used by subclasses. | | public | IdentityScope(String name)
Constructs a new identity scope with the specified name. | | public | IdentityScope(String name, IdentityScope scope)
Constructs a new identity scope with the specified name and scope. |
| Method Summary | |
| abstract public void | addIdentity(Identity identity)
Adds an identity to this identity scope.
Parameters:
identity - the identity to be added.
exception:
KeyManagementException - if the identity is notvalid, a name conflict occurs, another identity has the samepublic key as the identity being added, or another exceptionoccurs. | | abstract public 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. | | public Identity | getIdentity(Principal principal)
Retrieves the identity whose name is the same as that of the
specified principal. | | abstract public Identity | getIdentity(PublicKey key)
Retrieves the identity with the specified public key.
Parameters:
key - the public key for the identity to be returned. | | public static IdentityScope | getSystemScope()
Returns the system's identity scope. | | abstract public Enumeration<Identity> | identities()
Returns an enumeration of all identities in this identity scope. | | abstract public void | removeIdentity(Identity identity)
Removes an identity from this identity scope. | | 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. | | abstract public int | size()
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. |
| IdentityScope | | protected IdentityScope()(Code) | | This constructor is used for serialization only and should not
be used by subclasses.
|
| IdentityScope | | public IdentityScope(String name)(Code) | | Constructs a new identity scope with the specified name.
Parameters:
name - the scope name. |
| IdentityScope | | public IdentityScope(String name, IdentityScope scope) throws KeyManagementException(Code) | | Constructs a new identity scope with the specified name and scope.
Parameters:
name - the scope name.
Parameters:
scope - the scope for the new identity scope.
exception:
KeyManagementException - if there is already an identity with the same name in the scope. |
| addIdentity | | abstract public void addIdentity(Identity identity) throws KeyManagementException(Code) | | Adds an identity to this identity scope.
Parameters:
identity - the identity to be added.
exception:
KeyManagementException - if the identity is notvalid, a name conflict occurs, another identity has the samepublic key as the identity being added, or another exceptionoccurs. |
| getIdentity | | abstract public Identity getIdentity(String name)(Code) | | Returns the identity in this scope with the specified name (if any).
Parameters:
name - the name of the identity to be retrieved. the identity named name, or null if there areno identities named name in this scope. |
| getIdentity | | public Identity getIdentity(Principal principal)(Code) | | 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 identityto be retrieved. 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. |
| getIdentity | | abstract public Identity getIdentity(PublicKey key)(Code) | | Retrieves the identity with the specified public key.
Parameters:
key - the public key for the identity to be returned. the identity with the given key, or null if there areno identities in this scope with that key. |
| identities | | abstract public Enumeration<Identity> identities()(Code) | | Returns an enumeration of all identities in this identity scope.
an enumeration of all identities in this identity scope. |
| removeIdentity | | abstract public void removeIdentity(Identity identity) throws KeyManagementException(Code) | | Removes an identity from this identity scope.
Parameters:
identity - the identity to be removed.
exception:
KeyManagementException - if the identity is missing,or another exception occurs. |
| setSystemScope | | protected static void setSystemScope(IdentityScope scope)(Code) | | 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.
exception:
SecurityException - if a security manager exists and its checkSecurityAccess method doesn't allow setting the identity scope.
See Also: IdentityScope.getSystemScope
See Also: SecurityManager.checkSecurityAccess |
| size | | abstract public int size()(Code) | | Returns the number of identities within this identity scope.
the number of identities within this identity scope. |
| toString | | public String toString()(Code) | | Returns a string representation of this identity scope, including
its name, its scope name, and the number of identities in this
identity scope.
a string representation of this identity scope. |
|
|
|