IdentityScope (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.security.Identity
  • • java.security.IdentityScope

• All Implemented Interfaces:
  [Serializable](../../java/io/Serializable.html "interface in java.io"), [Principal](../../java/security/Principal.html "interface in java.security")

@Deprecated(since="1.2")
public abstract class IdentityScope
extends Identity
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, supposeAcme 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:
Identity, Signer, Principal, Key, Serialized Form

• • Constructor Summary

  Constructors

  Modifier	Constructor	Description
  protected	IdentityScope​()	Deprecated. This constructor is used for serialization only and should not be used by subclasses.
  	IdentityScope​(String name)	Deprecated. Constructs a new identity scope with the specified name.
  	IdentityScope​(String name,IdentityScope scope)	Deprecated. Constructs a new identity scope with the specified name and scope.

  • Method Summary

  All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods

  Modifier and Type	Method	Description
  abstract void	addIdentity​(Identity identity)	Deprecated. Adds an identity to this identity scope.
  abstract Identity	getIdentity​(String name)	Deprecated. Returns the identity in this scope with the specified name (if any).
  Identity	getIdentity​(Principal principal)	Deprecated. Retrieves the identity whose name is the same as that of the specified principal.
  abstract Identity	getIdentity​(PublicKey key)	Deprecated. Retrieves the identity with the specified public key.
  static IdentityScope	getSystemScope​()	Deprecated. Returns the system's identity scope.
  abstract Enumeration<Identity>	identities​()	Deprecated. Returns an enumeration of all identities in this identity scope.
  abstract void	removeIdentity​(Identity identity)	Deprecated. Removes an identity from this identity scope.
  protected static void	setSystemScope​(IdentityScope scope)	Deprecated. Sets the system's identity scope.
  abstract int	size​()	Deprecated. Returns the number of identities within this identity scope.
  String	toString​()	Deprecated. 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](../../java/security/Identity.html "class in java.security")  
     `[addCertificate](../../java/security/Identity.html#addCertificate-java.security.Certificate-), [certificates](../../java/security/Identity.html#certificates--), [equals](../../java/security/Identity.html#equals-java.lang.Object-), [getInfo](../../java/security/Identity.html#getInfo--), [getName](../../java/security/Identity.html#getName--), [getPublicKey](../../java/security/Identity.html#getPublicKey--), [getScope](../../java/security/Identity.html#getScope--), [hashCode](../../java/security/Identity.html#hashCode--), [identityEquals](../../java/security/Identity.html#identityEquals-java.security.Identity-), [removeCertificate](../../java/security/Identity.html#removeCertificate-java.security.Certificate-), [setInfo](../../java/security/Identity.html#setInfo-java.lang.String-), [setPublicKey](../../java/security/Identity.html#setPublicKey-java.security.PublicKey-), [toString](../../java/security/Identity.html#toString-boolean-)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`  
     * ### Methods inherited from interface java.security.[Principal](../../java/security/Principal.html "interface in java.security")  
     `[implies](../../java/security/Principal.html#implies-javax.security.auth.Subject-)`

• • Constructor Detail

     * #### IdentityScope  
     protected IdentityScope​()  
     Deprecated.  
     This constructor is used for serialization only and should not be used by subclasses.  
     * #### IdentityScope  
     public IdentityScope​([String](../../java/lang/String.html "class in java.lang") name)  
     Deprecated.  
     Constructs a new identity scope with the specified name.  
     Parameters:  
     `name` \- the scope name.  
     * #### IdentityScope  
     public IdentityScope​([String](../../java/lang/String.html "class in java.lang") name,  
                          [IdentityScope](../../java/security/IdentityScope.html "class in java.security") scope)  
                   throws [KeyManagementException](../../java/security/KeyManagementException.html "class in java.security")  
     Deprecated.  
     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](../../java/security/KeyManagementException.html "class in java.security")` \- if there is already an identity with the same name in the scope.  

  • Method Detail

    * #### getSystemScope  
    public static [IdentityScope](../../java/security/IdentityScope.html "class in java.security") getSystemScope​()  
    Deprecated.  
    Returns the system's identity scope.  
    Returns:  
    the system's identity scope, or `null` if none has been set.  
    See Also:  
    [setSystemScope(java.security.IdentityScope)](../../java/security/IdentityScope.html#setSystemScope-java.security.IdentityScope-)  
    * #### setSystemScope  
    protected static void setSystemScope​([IdentityScope](../../java/security/IdentityScope.html "class in java.security") scope)  
    Deprecated.  
    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](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkSecurityAccess` method doesn't allow setting the identity scope.  
    See Also:  
    [getSystemScope()](../../java/security/IdentityScope.html#getSystemScope--), [SecurityManager.checkSecurityAccess(java.lang.String)](../../java/lang/SecurityManager.html#checkSecurityAccess-java.lang.String-)  
    * #### size  
    public abstract int size​()  
    Deprecated.  
    Returns the number of identities within this identity scope.  
    Returns:  
    the number of identities within this identity scope.  
    * #### getIdentity  
    public abstract [Identity](../../java/security/Identity.html "class in java.security") getIdentity​([String](../../java/lang/String.html "class in java.lang") name)  
    Deprecated.  
    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.  
    * #### getIdentity  
    public [Identity](../../java/security/Identity.html "class in java.security") getIdentity​([Principal](../../java/security/Principal.html "interface in java.security") principal)  
    Deprecated.  
    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.  
    * #### getIdentity  
    public abstract [Identity](../../java/security/Identity.html "class in java.security") getIdentity​([PublicKey](../../java/security/PublicKey.html "interface in java.security") key)  
    Deprecated.  
    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.  
    * #### addIdentity  
    public abstract void addIdentity​([Identity](../../java/security/Identity.html "class in java.security") identity)  
                              throws [KeyManagementException](../../java/security/KeyManagementException.html "class in java.security")  
    Deprecated.  
    Adds an identity to this identity scope.  
    Parameters:  
    `identity` \- the identity to be added.  
    Throws:  
    `[KeyManagementException](../../java/security/KeyManagementException.html "class in java.security")` \- 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  
    public abstract void removeIdentity​([Identity](../../java/security/Identity.html "class in java.security") identity)  
                                 throws [KeyManagementException](../../java/security/KeyManagementException.html "class in java.security")  
    Deprecated.  
    Removes an identity from this identity scope.  
    Parameters:  
    `identity` \- the identity to be removed.  
    Throws:  
    `[KeyManagementException](../../java/security/KeyManagementException.html "class in java.security")` \- if the identity is missing, or another exception occurs.  
    * #### identities  
    public abstract [Enumeration](../../java/util/Enumeration.html "interface in java.util")<[Identity](../../java/security/Identity.html "class in java.security")> identities​()  
    Deprecated.  
    Returns an enumeration of all identities in this identity scope.  
    Returns:  
    an enumeration of all identities in this identity scope.  
    * #### toString  
    public [String](../../java/lang/String.html "class in java.lang") toString​()  
    Deprecated.  
    Returns a string representation of this identity scope, including its name, its scope name, and the number of identities in this identity scope.  
    Specified by:  
    `[toString](../../java/security/Principal.html#toString--)` in interface `[Principal](../../java/security/Principal.html "interface in java.security")`  
    Overrides:  
    `[toString](../../java/security/Identity.html#toString--)` in class `[Identity](../../java/security/Identity.html "class in java.security")`  
    Returns:  
    a string representation of this identity scope.  
    See Also:  
    [SecurityManager.checkSecurityAccess(java.lang.String)](../../java/lang/SecurityManager.html#checkSecurityAccess-java.lang.String-)

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.