Class DSSPrivateKey

public DSSPrivateKey(int preferredFormat,
                     BigInteger p,
                     BigInteger q,
                     BigInteger g,
                     BigInteger x)

Constructs a new instance of a DSSPrivateKey given the designated arguments.

Parameters:

preferredFormat - the indetifier of the preferred encoding format to use when externalizing this key.

p - the public modulus.

q - the public prime divisor of p-1.

g - a generator of the unique cyclic group Z* p.

x - the private key part.

public DSSPrivateKey(BigInteger p,
                     BigInteger q,
                     BigInteger g,
                     BigInteger x)

Convenience constructor. Calls the constructor with 5 arguments passing Registry.RAW_ENCODING_ID as the identifier of the preferred encoding format.

Parameters:

p - the public modulus.

q - the public prime divisor of p-1.

g - a generator of the unique cyclic group Z* p.

x - the private key part.

public boolean equals(Object obj)

Returns true if the designated object is an instance of DSAPrivateKey and has the same DSS (Digital Signature Standard) parameter values as this one.

Overrides:

equals in interface DSSKey

Parameters:

obj - the other non-null DSS key to compare to.

Returns:

true if the designated object is of the same type and value as this one.

public byte[] getEncoded(int format)

Returns the encoded form of this private key according to the designated format.

Overrides:

getEncoded in interface DSSKey

Parameters:

format - the desired format identifier of the resulting encoding.

Returns:

the byte sequence encoding this key according to the designated format.

Throws:

IllegalArgumentException - if the format is not supported.

See Also:

DSSKeyPairRawCodec

public BigInteger getX()

This method returns the value of the DSA private key

Specified by:

getX in interface DSAPrivateKey

public String toString()

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:

toString in interface DSSKey

Returns:

the String representing this Object, which may be null

See Also:

getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

public static DSSPrivateKey valueOf(byte[] k)

A class method that takes the output of the encodePrivateKey() method of a DSS keypair codec object (an instance implementing IKeyPairCodec for DSS keys, and re-constructs an instance of this object.

Parameters:

k - the contents of a previously encoded instance of this object.

Throws:

ArrayIndexOutOfBoundsException - if there is not enough bytes, in k, to represent a valid encoding of an instance of this object.

IllegalArgumentException - if the byte sequence does not represent a valid encoding of an instance of this object.