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

Constructs a new identity scope with the specified name.

Constructs a new identity scope with the specified name and scope.

Protected constructors

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!

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!

Retrieves the identity with the specified public key.

open static IdentityScope!

Returns the system's identity scope.

abstract Enumeration<Identity!>!

Returns an enumeration of all identities in this identity scope.

abstract Unit

Removes an identity from this identity scope.

abstract Int

Returns the number of identities within this identity scope.

open String

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

Sets the system's identity scope.

Inherited functions

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

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.