javax.crypto.spec: public class: IvParameterSpec

javax.crypto.spec
public class: IvParameterSpec [javadoc | source]

java.lang.Object
   javax.crypto.spec.IvParameterSpec

All Implemented Interfaces:
AlgorithmParameterSpec

This class specifies an initialization vector (IV). Examples which use IVs are ciphers in feedback mode, e.g., DES in CBC mode and RSA ciphers with OAEP encoding operation.

author: Jan - Luehe

since: 1.4 -

Constructor:

Constructor:
public IvParameterSpec(byte[] iv) { this(iv, 0, iv.length); } Creates an IvParameterSpec object using the bytes in `iv` as the IV. Parameters: `iv` - the buffer with the IV. The contents of the buffer are copied to protect against subsequent modification. Throws: `NullPointerException` - if `iv` is `null`
public IvParameterSpec(byte[] iv, int offset, int len) { if (iv == null) { throw new IllegalArgumentException("IV missing"); } if (iv.length - offset < len) { throw new IllegalArgumentException ("IV buffer too short for given offset/length combination"); } if (len < 0) { throw new ArrayIndexOutOfBoundsException("len is negative"); } this.iv = new byte[len]; System.arraycopy(iv, offset, this.iv, 0, len); } Creates an IvParameterSpec object using the first `len` bytes in `iv`, beginning at `offset` inclusive, as the IV. The bytes that constitute the IV are those between `iv[offset]` and `iv[offset+len-1]` inclusive. Parameters: `iv` - the buffer with the IV. The first `len` bytes of the buffer beginning at `offset` inclusive are copied to protect against subsequent modification. `offset` - the offset in `iv` where the IV starts. `len` - the number of IV bytes. Throws: `IllegalArgumentException` - if `iv` is `null` or `(iv.length - offset < len)` `ArrayIndexOutOfBoundsException` - is thrown if `offset` or `len` index bytes outside the `iv`.

 public IvParameterSpec(byte[] iv) {
        this(iv, 0, iv.length);
}

Creates an IvParameterSpec object using the bytes in iv as the IV.

Parameters:

iv - the buffer with the IV. The contents of the buffer are copied to protect against subsequent modification.

Throws:

NullPointerException - if iv is null

 public IvParameterSpec(byte[] iv,
    int offset,
    int len) {
        if (iv == null) {
            throw new IllegalArgumentException("IV missing");
        }
        if (iv.length - offset <  len) {
            throw new IllegalArgumentException
                ("IV buffer too short for given offset/length combination");
        }
        if (len <  0) {
            throw new ArrayIndexOutOfBoundsException("len is negative");
        }
        this.iv = new byte[len];
        System.arraycopy(iv, offset, this.iv, 0, len);
}

Creates an IvParameterSpec object using the first len bytes in iv, beginning at offset inclusive, as the IV.

The bytes that constitute the IV are those between iv[offset] and iv[offset+len-1] inclusive.

Parameters:

iv - the buffer with the IV. The first len bytes of the buffer beginning at offset inclusive are copied to protect against subsequent modification.

offset - the offset in iv where the IV starts.

len - the number of IV bytes.

Throws:

IllegalArgumentException - if iv is null or (iv.length - offset < len)

ArrayIndexOutOfBoundsException - is thrown if offset or len index bytes outside the iv.

Method from javax.crypto.spec.IvParameterSpec Summary:
getIV

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.crypto.spec.IvParameterSpec Detail:
public byte[] getIV() { return (byte[])this.iv.clone(); } Returns the initialization vector (IV).

Method from javax.crypto.spec.IvParameterSpec Detail:

 public byte[] getIV() {
        return (byte[])this.iv.clone();
}

Returns the initialization vector (IV).