Home How it Works Android APIMiner IDE Version More Info

to top

Added in API level 1
Deprecated since API level 1

public abstract class

IdentityScope

extends Identity

java.lang.Object
↳	java.security.Identity
	↳	java.security.IdentityScope

This class was deprecated in API level 1.
The functionality of this class has been replace by Principal, KeyStore and the java.security.cert package.

Class Overview

IdentityScope represents a scope for Identity objects.

Summary

Public Constructors
	IdentityScope( String name) Constructs a new instance of `IdentityScope` with the specified name.
	IdentityScope( String name, IdentityScope scope) Constructs a new instance of `IdentityScope` with the specified name and the specified scope.

Protected Constructors
	IdentityScope() Constructs a new instance of `IdentityScope`.

Public Methods
abstract void	addIdentity( Identity identity) Adds an `Identity` to this `IdentityScope`.
abstract Identity	getIdentity( String name) Returns the `Identity` with the specified name or `null` if no `Identity` with the specified name is present in this scope.
abstract Identity	getIdentity( PublicKey key) Returns the `Identity` which is associated with the specified key or `null` if no `Identity` associated with the specified key is present in this scope.
Identity	getIdentity( Principal principal) Returns the `Identity` with the name of the specified principal or `null` if no `Identity` with the name of the specified principal is present in this scope.
static IdentityScope	getSystemScope() Returns the system's scope.
abstract Enumeration< Identity>	identities() Returns an `Enumeration` over the `Identity` objects in this `IdentityScope`.
abstract void	removeIdentity( Identity identity) Removes an `Identity` from this `IdentityScope`.
abstract int	size() Returns the number of `Identity` objects in this scope.
String	toString() Returns a string containing a concise, human-readable description of this `IdentityScope`.

Protected Methods
static void	setSystemScope( IdentityScope scope) Sets the system's scope.

[Expand]

Inherited Methods

From class java.security.Identity

void	addCertificate( Certificate certificate) Adds a `Certificate` to this `Identity`.
Certificate[]	certificates() Returns the certificates for this `Identity`.
final boolean	equals( Object obj) Compares the specified object with this `Identity` for equality and returns `true` if the specified object is equal, `false` otherwise.
String	getInfo() Returns the information string of this `Identity`.
final String	getName() Returns the name of this `Identity`.
PublicKey	getPublicKey() Returns the `PublicKey` associated with this `Identity`.
final IdentityScope	getScope() Returns the `IdentityScope` of this `Identity`.
int	hashCode() Returns the hash code value for this `Identity`.
boolean	identityEquals( Identity identity) Compares the specified `Identity` with this `Identity` for equality and returns `true` if the specified object is equal, `false` otherwise.
void	removeCertificate( Certificate certificate) Removes the specified `Certificate` from this `Identity`.
void	setInfo( String info) Sets an information string for this `Identity`.
void	setPublicKey( PublicKey key) Sets the specified `PublicKey` to this `Identity`.
String	toString(boolean detailed) Returns a string containing a concise, human-readable description of the this `Identity`.
String	toString() Returns a string containing a concise, human-readable description of the this `Identity` including its name and its scope.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.security.Principal

Public Constructors

public IdentityScope (String name)

Added in API level 1

Constructs a new instance of IdentityScope with the specified name.

Parameters

name	the name of this `IdentityScope`.

public IdentityScope (String name, IdentityScope scope)

Added in API level 1

Constructs a new instance of IdentityScope with the specified name and the specified scope.

Parameters

name	the name of this `IdentityScope`.
scope	the scope of this `IdentityScope`.

Throws

KeyManagementException	if an identity with the same key already exists.

Protected Constructors

protected IdentityScope ()

Added in API level 1

Constructs a new instance of IdentityScope.

Public Methods

public abstract void addIdentity (Identity identity)

Added in API level 1

Adds an Identity to this IdentityScope.

Parameters

identity	the `Identity` to be added.

Throws

KeyManagementException	if the specified `Identity` is invalid or an identity with the same key already exists.

public abstract Identity getIdentity (String name)

Added in API level 1

Returns the Identity with the specified name or null if no Identity with the specified name is present in this scope.

Parameters

name	the name of the `Identity` to be returned.

Returns

the Identity with the specified name or null if not present.

public abstract Identity getIdentity (PublicKey key)

Added in API level 1

Returns the Identity which is associated with the specified key or null if no Identity associated with the specified key is present in this scope.

Parameters

key	the `PublicKey` of the `Identity` to be returned.

Returns

the Identity associated with the specified key or null if not present.

public Identity getIdentity (Principal principal)

Added in API level 1

Returns the Identity with the name of the specified principal or null if no Identity with the name of the specified principal is present in this scope.

Parameters

principal	the `Principal` whose name is used to lookup the `Identity` to be returned.

Returns

the Identity with the specified name or null if not present.

public static IdentityScope getSystemScope ()

Added in API level 1

Returns the system's scope.

Returns

the system's scope.

public abstract Enumeration<Identity> identities ()

Added in API level 1

Returns an Enumeration over the Identity objects in this IdentityScope.

Returns

an Enumeration over the Identity objects in this IdentityScope.

public abstract void removeIdentity (Identity identity)

Added in API level 1

Removes an Identity from this IdentityScope.

Parameters

identity	the `Identity` to be removed.

Throws

KeyManagementException	if the `Identity` is not present in this scope.

public abstract int size ()

Added in API level 1

Returns the number of Identity objects in this scope.

Returns

the number of Identity objects in this scope.

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this IdentityScope.

Returns

a printable representation for this IdentityScope.

Protected Methods

protected static void setSystemScope (IdentityScope scope)

Added in API level 1

Sets the system's scope.

Parameters

scope	the scope to set.

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes

Enums

Exceptions

IdentityScope

Class Overview

Summary

Public Constructors

public IdentityScope (String name)

Parameters

public IdentityScope (String name, IdentityScope scope)

Parameters

Throws

Protected Constructors

protected IdentityScope ()

Public Methods

public abstract void addIdentity (Identity identity)

Parameters

Throws

public abstract Identity getIdentity (String name)

Parameters

Returns

public abstract Identity getIdentity (PublicKey key)

Parameters

Returns

public Identity getIdentity (Principal principal)

Parameters

Returns

public static IdentityScope getSystemScope ()

Returns

public abstract Enumeration<Identity> identities ()

Returns

public abstract void removeIdentity (Identity identity)

Parameters

Throws

public abstract int size ()

Returns

public String toString ()

Returns

Protected Methods

protected static void setSystemScope (IdentityScope scope)

Parameters