javax.crypto.spec

Class SecretKeySpec

Implemented Interfaces:
Key, KeySpec, SecretKey, Serializable

public class SecretKeySpec
extends Object
implements KeySpec, SecretKey

This is a simple wrapper around a raw byte array, for ciphers that do not require any key parameters other than the bytes themselves.

Since this class implements SecretKey, which in turn extends Key, so instances of this class may be passed directly to the init() methods of Cipher.

See Also:
SecretKey, SecretKeyFactory

Fields inherited from interface java.security.Key

serialVersionUID

Fields inherited from interface javax.crypto.SecretKey

serialVersionUID

Constructor Summary

SecretKeySpec(byte[] key, int off, int len, String algorithm)
Create a new secret key spec from part of a byte array.
SecretKeySpec(byte[] key, String algorithm)
Create a new secret key spec from an entire byte array.

Method Summary

boolean
equals(Object o)
String
getAlgorithm()
Return the name of the algorithm associated with this secret key.
byte[]
getEncoded()
Return the key as a byte array.
String
getFormat()
This key's format, which is always "RAW".
int
hashCode()

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SecretKeySpec

public SecretKeySpec(byte[] key,
                     int off,
                     int len,
                     String algorithm)
Create a new secret key spec from part of a byte array.
Parameters:
key - The key material.
off - The offset at which key material begins.
len - The length of key material.
algorithm - The name of the algorithm using this key.

SecretKeySpec

public SecretKeySpec(byte[] key,
                     String algorithm)
Create a new secret key spec from an entire byte array.
Parameters:
key - The key material.
algorithm - The name of the algorithm using this key.

Method Details

equals

public boolean equals(Object o)
Overrides:
equals in interface Object

getAlgorithm

public String getAlgorithm()
Return the name of the algorithm associated with this secret key.
Specified by:
getAlgorithm in interface Key
Returns:
The algorithm's name.

getEncoded

public byte[] getEncoded()
Return the key as a byte array.
Specified by:
getEncoded in interface Key
Returns:
The key material.

getFormat

public String getFormat()
This key's format, which is always "RAW".
Specified by:
getFormat in interface Key
Returns:
"RAW"

hashCode

public int hashCode()
Overrides:
hashCode in interface Object

SecretKeySpec.java -- Wrapper for secret keys. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.