- 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
ConstructorsModifierConstructorDescriptionprotectedDeprecated, 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 voidaddIdentity(Identity identity) Deprecated, for removal: This API element is subject to removal in a future version.Adds anIdentityto this identity scope.abstract IdentitygetIdentity(String name) Deprecated, for removal: This API element is subject to removal in a future version.Returns theIdentityin 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 theIdentitywhose name is the same as that of the specified principal.abstract IdentitygetIdentity(PublicKey key) Deprecated, for removal: This API element is subject to removal in a future version.Retrieves theidentitywith the specified public key.static IdentityScopeDeprecated, 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 voidremoveIdentity(Identity identity) Deprecated, for removal: This API element is subject to removal in a future version.Removes anIdentityfrom this identity scope.protected static voidsetSystemScope(IdentityScope scope) Deprecated, for removal: This API element is subject to removal in a future version.Sets the system's identity scope.abstract intsize()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 declared in 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 anIdentitywith 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
nullif 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.First, if there is a security manager, its
checkSecurityAccessmethod 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 itscheckSecurityAccessmethod doesn't allow setting the identity scope.- 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 theIdentityin this scope with the specified name (if any).- Parameters:
name- the name of theIdentityto be retrieved.- Returns:
- the
Identitynamedname, ornullif there are no identities namednamein this scope.
-
getIdentity
Deprecated, for removal: This API element is subject to removal in a future version.Retrieves theIdentitywhose name is the same as that of the specified principal. (Note:IdentityimplementsPrincipal.)- Parameters:
principal- the principal corresponding to theIdentityto be retrieved.- Returns:
- the
Identitywhose name is the same as that of the principal, ornullif 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 theidentitywith the specified public key.- Parameters:
key- the public key for the identity to be returned.- Returns:
- the identity with the given key, or
nullif 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 anIdentityto this identity scope.- Parameters:
identity- theIdentityto 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 anIdentityfrom this identity scope.- Parameters:
identity- theIdentityto 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.certpackage, andjava.security.Principal.