Class IdentityScope
- All Implemented Interfaces:
Serializable
,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.
- Since:
- 1.1
- See Also:
-
Constructor Summary
ModifierConstructorDescriptionprotected
Deprecated, for removal: This API element is subject to removal in a future version.This constructor is used for serialization only and should not be used by subclasses.IdentityScope
(String name) Deprecated, for removal: This API element is subject to removal in a future version.Constructs a new identity scope with the specified name.IdentityScope
(String name, IdentityScope scope) Deprecated, for removal: This API element is subject to removal in a future version.Constructs a new identity scope with the specified name and scope. -
Method Summary
Modifier and TypeMethodDescriptionabstract void
addIdentity
(Identity identity) Deprecated, for removal: This API element is subject to removal in a future version.Adds anIdentity
to this identity scope.abstract Identity
getIdentity
(String name) Deprecated, for removal: This API element is subject to removal in a future version.Returns theIdentity
in this scope with the specified name (if any).getIdentity
(Principal principal) Deprecated, for removal: This API element is subject to removal in a future version.Retrieves theIdentity
whose name is the same as that of the specified principal.abstract Identity
getIdentity
(PublicKey key) Deprecated, for removal: This API element is subject to removal in a future version.Retrieves theidentity
with the specified public key.static IdentityScope
Deprecated, for removal: This API element is subject to removal in a future version.Returns the system's identity scope.abstract Enumeration
<Identity> Deprecated, for removal: This API element is subject to removal in a future version.Returns an enumeration of all identities in this identity scope.abstract void
removeIdentity
(Identity identity) Deprecated, for removal: This API element is subject to removal in a future version.Removes anIdentity
from this identity scope.protected static void
setSystemScope
(IdentityScope scope) Deprecated, for removal: This API element is subject to removal in a future version.Sets the system's identity scope.abstract int
size()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the number of identities within this identity scope.toString()
Deprecated, for removal: This API element is subject to removal in a future version.Returns a string representation of this identity scope, including its name, its scope name, and the number of identities in this identity scope.Methods inherited from class java.security.Identity
addCertificate, certificates, equals, getInfo, getName, getPublicKey, getScope, hashCode, identityEquals, removeCertificate, setInfo, setPublicKey, toString
-
Constructor Details
-
IdentityScope
protected IdentityScope()Deprecated, for removal: This API element is subject to removal in a future version.This constructor is used for serialization only and should not be used by subclasses. -
IdentityScope
Deprecated, for removal: This API element is subject to removal in a future version.Constructs a new identity scope with the specified name.- Parameters:
name
- the scope name.
-
IdentityScope
Deprecated, for removal: This API element is subject to removal in a future version.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 anIdentity
with the same name in the scope.
-
-
Method Details
-
getSystemScope
Deprecated, for removal: This API element is subject to removal in a future version.Returns the system's identity scope.- Returns:
- the system's identity scope, or
null
if none has been set. - See Also:
-
setSystemScope
Deprecated, for removal: This API element is subject to removal in a future version.Sets the system's identity scope.- Parameters:
scope
- the scope to set.- See Also:
-
size
public abstract int size()Deprecated, for removal: This API element is subject to removal in a future version.Returns the number of identities within this identity scope.- Returns:
- the number of identities within this identity scope.
-
getIdentity
Deprecated, for removal: This API element is subject to removal in a future version.Returns theIdentity
in this scope with the specified name (if any).- Parameters:
name
- the name of theIdentity
to be retrieved.- Returns:
- the
Identity
namedname
, ornull
if there are no identities namedname
in this scope.
-
getIdentity
Deprecated, for removal: This API element is subject to removal in a future version.Retrieves theIdentity
whose name is the same as that of the specified principal. (Note:Identity
implementsPrincipal
.)- Parameters:
principal
- the principal corresponding to theIdentity
to be retrieved.- Returns:
- the
Identity
whose name is the same as that of the principal, ornull
if there are no identities of the same name in this scope.
-
getIdentity
Deprecated, for removal: This API element is subject to removal in a future version.Retrieves theidentity
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.
-
addIdentity
Deprecated, for removal: This API element is subject to removal in a future version.Adds anIdentity
to this identity scope.- Parameters:
identity
- theIdentity
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.
-
removeIdentity
Deprecated, for removal: This API element is subject to removal in a future version.Removes anIdentity
from this identity scope.- Parameters:
identity
- theIdentity
to be removed.- Throws:
KeyManagementException
- if the identity is missing, or another exception occurs.
-
identities
Deprecated, for removal: This API element is subject to removal in a future version.Returns an enumeration of all identities in this identity scope.- Returns:
- an enumeration of all identities in this identity scope.
-
toString
Deprecated, for removal: This API element is subject to removal in a future version.Returns a string representation of this identity scope, including its name, its scope name, and the number of identities in this identity scope.
-
java.security.KeyStore
, thejava.security.cert
package, andjava.security.Principal
.