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

• java.lang.Object

• • java.security.Identity
  • • java.security.Signer

• 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 Signer
extends Identity
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.
Since:
1.1
See Also:
Identity, Serialized Form

• • Constructor Summary

  Constructors

  Modifier	Constructor	Description
  protected	Signer​()	Deprecated. Creates a signer.
  	Signer​(String name)	Deprecated. Creates a signer with the specified identity name.
  	Signer​(String name,IdentityScope scope)	Deprecated. Creates a signer with the specified identity name and scope.

  • Method Summary

  All Methods Instance Methods Concrete Methods Deprecated Methods

  Modifier and Type	Method	Description
  PrivateKey	getPrivateKey​()	Deprecated. Returns this signer's private key.
  void	setKeyPair​(KeyPair pair)	Deprecated. Sets the key pair (public key and private key) for this signer.
  String	toString​()	Deprecated. Returns a string of information about the signer.

     * ### 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

     * #### Signer  
     protected Signer​()  
     Deprecated.  
     Creates a signer. This constructor should only be used for serialization.  
     * #### Signer  
     public Signer​([String](../../java/lang/String.html "class in java.lang") name)  
     Deprecated.  
     Creates a signer with the specified identity name.  
     Parameters:  
     `name` \- the identity name.  
     * #### Signer  
     public Signer​([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.  
     Creates a signer with the specified identity name and scope.  
     Parameters:  
     `name` \- the identity name.  
     `scope` \- the scope of the identity.  
     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

    * #### getPrivateKey  
    public [PrivateKey](../../java/security/PrivateKey.html "interface in java.security") getPrivateKey​()  
    Deprecated.  
    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:  
    this signer's private key, or null if the private key has not yet been set.  
    Throws:  
    `[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkSecurityAccess` method doesn't allow returning the private key.  
    See Also:  
    [SecurityManager.checkSecurityAccess(java.lang.String)](../../java/lang/SecurityManager.html#checkSecurityAccess-java.lang.String-)  
    * #### setKeyPair  
    public final void setKeyPair​([KeyPair](../../java/security/KeyPair.html "class in java.security") pair)  
                          throws [InvalidParameterException](../../java/security/InvalidParameterException.html "class in java.security"),  
                                 [KeyException](../../java/security/KeyException.html "class in java.security")  
    Deprecated.  
    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` \- an initialized key pair.  
    Throws:  
    `[InvalidParameterException](../../java/security/InvalidParameterException.html "class in java.security")` \- if the key pair is not properly initialized.  
    `[KeyException](../../java/security/KeyException.html "class in java.security")` \- if the key pair cannot be set for any other reason.  
    `[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkSecurityAccess` method doesn't allow setting the key pair.  
    See Also:  
    [SecurityManager.checkSecurityAccess(java.lang.String)](../../java/lang/SecurityManager.html#checkSecurityAccess-java.lang.String-)  
    * #### toString  
    public [String](../../java/lang/String.html "class in java.lang") toString​()  
    Deprecated.  
    Returns a string of information about the signer.  
    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 of information about the signer.  
    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.