Added in API level 1
Deprecated in API level 3

Signer

public abstract class Signer
extends Identity

java.lang.Object
   ↳ java.security.Identity
     ↳ java.security.Signer


This class was deprecated in API level 3.
This class is deprecated and subject to removal in a future version of Java SE. It has been replaced by java.security.KeyStore, the java.security.cert package, and java.security.Principal.

This class is used to represent an Identity that can also digitally sign data.

The management of a signer's private keys is an important and sensitive issue that should be handled by subclasses as appropriate to their intended use.

See also:

Summary

Public constructors

Signer(String name)

Creates a signer with the specified identity name.

Signer(String name, IdentityScope scope)

Creates a signer with the specified identity name and scope.

Protected constructors

Signer()

Creates a signer.

Public methods

PrivateKey getPrivateKey()

Returns this signer's private key.

final void setKeyPair(KeyPair pair)

Sets the key pair (public key and private key) for this signer.

String toString()

Returns a string of information about the signer.

Inherited methods

Public constructors

Signer

Added in API level 1
public Signer (String name)

Creates a signer with the specified identity name.

Parameters
name String: the identity name.

Signer

Added in API level 1
public Signer (String name, 
                IdentityScope scope)

Creates a signer with the specified identity name and scope.

Parameters
name String: the identity name.

scope IdentityScope: the scope of the identity.

Throws
KeyManagementException if there is already an identity with the same name in the scope.

Protected constructors

Signer

Added in API level 1
protected Signer ()

Creates a signer. This constructor should only be used for serialization.

Public methods

getPrivateKey

Added in API level 1
public PrivateKey getPrivateKey ()

Returns this signer's private key.

First, if there is a security manager, its checkSecurityAccess method is called with "getSignerPrivateKey" as its argument to see if it's ok to return the private key.

Returns
PrivateKey this signer's private key, or null if the private key has not yet been set.

Throws
SecurityException if a security manager exists and its checkSecurityAccess method doesn't allow returning the private key.

setKeyPair

Added in API level 1
public final void setKeyPair (KeyPair pair)

Sets the key pair (public key and private key) for this signer.

First, if there is a security manager, its checkSecurityAccess method is called with "setSignerKeyPair" as its argument to see if it's ok to set the key pair.

Parameters
pair KeyPair: an initialized key pair.

Throws
InvalidParameterException if the key pair is not properly initialized.
KeyException if the key pair cannot be set for any other reason.
SecurityException if a security manager exists and its checkSecurityAccess method doesn't allow setting the key pair.

toString

Added in API level 1
public String toString ()

Returns a string of information about the signer.

Returns
String a string of information about the signer.