Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

gnu.javax.crypto.key
Class GnuSecretKey  view GnuSecretKey download GnuSecretKey.java

java.lang.Object
  extended bygnu.javax.crypto.key.GnuSecretKey
All Implemented Interfaces:
java.security.Key, java.io.Serializable

public class GnuSecretKey
extends java.lang.Object
implements java.security.Key

A secret key composed of a sequence of raw, unformatted octets. This class is analogous to the javax.crypto.spec.SecretKeySpec class, but is provided for platforms that do not or cannot contain that class.


Field Summary
private  java.lang.String algorithm
           
private  byte[] key
           
 
Fields inherited from interface java.security.Key
serialVersionUID
 
Constructor Summary
GnuSecretKey(byte[] key, int offset, int length, java.lang.String algorithm)
          Creates a new secret key from a portion of a byte array.
GnuSecretKey(byte[] key, java.lang.String algorithm)
          Creates a new secret key.
 
Method Summary
 boolean equals(java.lang.Object o)
          Determine whether this Object is semantically equal to another Object.
 java.lang.String getAlgorithm()
          Returns the algorithm name, if any.
 byte[] getEncoded()
          Returns the encoded key, which is merely the byte array this class was created with.
 java.lang.String getFormat()
          Returns the string "RAW".
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

key

private final byte[] key

algorithm

private final java.lang.String algorithm
Constructor Detail

GnuSecretKey

public GnuSecretKey(byte[] key,
                    java.lang.String algorithm)
Creates a new secret key. The supplied byte array is copied by this constructor.


GnuSecretKey

public GnuSecretKey(byte[] key,
                    int offset,
                    int length,
                    java.lang.String algorithm)
Creates a new secret key from a portion of a byte array.

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()
Returns the algorithm name, if any.

Specified by:
getAlgorithm in interface java.security.Key

getEncoded

public byte[] getEncoded()
Returns the encoded key, which is merely the byte array this class was created with. A reference to the internal byte array is returned, so the caller can delete this key from memory by modifying the returned array.

Specified by:
getEncoded in interface java.security.Key

getFormat

public java.lang.String getFormat()
Returns the string "RAW".

Specified by:
getFormat in interface java.security.Key

equals

public boolean equals(java.lang.Object o)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


toString

public java.lang.String toString()
Description copied from class: java.lang.Object
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() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.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()).