Added in API level 1
Deprecated in API level 3

IdentityScope

abstract class IdentityScope : Identity

kotlin.Any
↳	java.security.Identity
	↳	java.security.IdentityScope

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.

Summary

Public constructors
`IdentityScope(name: String!)` Constructs a new identity scope with the specified name.
`IdentityScope(name: String!, scope: IdentityScope!)` 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 Unit	`addIdentity(identity: Identity!)` Adds an identity to this identity scope.
abstract Identity!	`getIdentity(name: String!)` Returns the identity in this scope with the specified name (if any).
open Identity!	`getIdentity(principal: Principal!)` Retrieves the identity whose name is the same as that of the specified principal.
abstract Identity!	`getIdentity(key: PublicKey!)` Retrieves the identity with the specified public key.
open static IdentityScope!	`getSystemScope()` Returns the system's identity scope.
abstract Enumeration<Identity!>!	`identities()` Returns an enumeration of all identities in this identity scope.
abstract Unit	`removeIdentity(identity: Identity!)` Removes an identity from this identity scope.
abstract Int	`size()` Returns the number of identities within this identity scope.
open 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
open static Unit	`setSystemScope(scope: IdentityScope!)` Sets the system's identity scope.

Inherited functions

From class Identity

`Unit`	`addCertificate(certificate: Certificate!)` Adds a certificate for this identity. If the identity has a public key, the public key in the certificate must be the same, and if the identity does not have a public key, the identity's public key is set to be that specified in the certificate. First, if there is a security manager, its `checkSecurityAccess` method is called with `"addIdentityCertificate"` as its argument to see if it's ok to add a certificate.
`Array<Certificate!>!`	`certificates()` Returns a copy of all the certificates for this identity.
`Boolean`	`equals(other: Any?)` Tests for equality between the specified object and this identity. This first tests to see if the entities actually refer to the same object, in which case it returns true. Next, it checks to see if the entities have the same name and the same scope. If they do, the method returns true. Otherwise, it calls `identityEquals`, which subclasses should override.
`String!`	`getInfo()` Returns general information previously specified for this identity.
`String!`	`getName()` Returns this identity's name.
`PublicKey!`	`getPublicKey()` Returns this identity's public key.
`IdentityScope!`	`getScope()` Returns this identity's scope.
`Int`	`hashCode()` Returns a hashcode for this identity.
`Boolean`	`identityEquals(identity: Identity!)` Tests for equality between the specified identity and this identity. This method should be overriden by subclasses to test for equality. The default behavior is to return true if the names and public keys are equal.
`Unit`	`removeCertificate(certificate: Certificate!)` Removes a certificate from this identity. First, if there is a security manager, its `checkSecurityAccess` method is called with `"removeIdentityCertificate"` as its argument to see if it's ok to remove a certificate.
`Unit`	`setInfo(info: String!)` Specifies a general information string for this identity. First, if there is a security manager, its `checkSecurityAccess` method is called with `"setIdentityInfo"` as its argument to see if it's ok to specify the information string.
`Unit`	`setPublicKey(key: PublicKey!)` Sets this identity's public key. The old key and all of this identity's certificates are removed by this operation. First, if there is a security manager, its `checkSecurityAccess` method is called with `"setIdentityPublicKey"` as its argument to see if it's ok to set the public key.
`String!`	`toString(detailed: Boolean)` Returns a string representation of this identity, with optionally more details than that provided by the `toString` method without any arguments. First, if there is a security manager, its `checkSecurityAccess` method is called with `"printIdentity"` as its argument to see if it's ok to return the string.

From class Principal

Boolean

implies(subject: Subject!)

Returns true if the specified subject is implied by this principal.

Public constructors

IdentityScope

Added in API level 1

IdentityScope(name: String!)

Constructs a new identity scope with the specified name.

Parameters
`name`	String!: the scope name.

IdentityScope

Added in API level 1

IdentityScope(
    name: String!, 
    scope: IdentityScope!)

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.

Exceptions
`java.security.KeyManagementException`	if there is already an identity with the same name in the scope.

Protected constructors

IdentityScope

Added in API level 1

protected IdentityScope()

This constructor is used for serialization only and should not be used by subclasses.

Public methods

addIdentity

Added in API level 1

abstract fun addIdentity(identity: Identity!): Unit

Deprecated: Deprecated in Java.

Adds an identity to this identity scope.

Parameters
`identity`	Identity!: the identity to be added.

Exceptions
`java.security.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.

getIdentity

Added in API level 1

abstract fun getIdentity(name: String!): Identity!

Deprecated: Deprecated in Java.

Returns the identity in this scope with the specified name (if any).

Parameters
`name`	String!: the name of the identity to be retrieved.

Return
`Identity!`	the identity named `name`, or null if there are no identities named `name` in this scope.

getIdentity

Added in API level 1

open fun getIdentity(principal: Principal!): Identity!

Deprecated: Deprecated in Java.

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.

Return
`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.

getIdentity

Added in API level 1

abstract fun getIdentity(key: PublicKey!): Identity!

Deprecated: Deprecated in Java.

Retrieves the identity with the specified public key.

Parameters
`key`	PublicKey!: the public key for the identity to be returned.

Return
`Identity!`	the identity with the given key, or null if there are no identities in this scope with that key.

getSystemScope

Added in API level 1

open static fun getSystemScope(): IdentityScope!

Deprecated: Deprecated in Java.

Returns the system's identity scope.

Return
`IdentityScope!`	the system's identity scope, or `null` if none has been set.

See Also

#setSystemScope

identities

Added in API level 1

abstract fun identities(): Enumeration<Identity!>!

Deprecated: Deprecated in Java.

Returns an enumeration of all identities in this identity scope.

Return
`Enumeration<Identity!>!`	an enumeration of all identities in this identity scope.

removeIdentity

Added in API level 1

abstract fun removeIdentity(identity: Identity!): Unit

Deprecated: Deprecated in Java.

Removes an identity from this identity scope.

Parameters
`identity`	Identity!: the identity to be removed.

Exceptions
`java.security.KeyManagementException`	if the identity is missing, or another exception occurs.

size

Added in API level 1

abstract fun size(): Int

Deprecated: Deprecated in Java.

Returns the number of identities within this identity scope.

Return
`Int`	the number of identities within this identity scope.

toString

Added in API level 1

open fun toString(): String

Deprecated: Deprecated in Java.

Returns a string representation of this identity scope, including its name, its scope name, and the number of identities in this identity scope.

Return
`String`	a string representation of this identity scope.

Protected methods

setSystemScope

Added in API level 1

protected open static fun setSystemScope(scope: IdentityScope!): Unit

Deprecated: Deprecated in Java.

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.

Exceptions
`java.lang.SecurityException`	if a security manager exists and its `checkSecurityAccess` method doesn't allow setting the identity scope.

See Also