IDEAParameterSpec ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.security.spec.IDEAParameterSpec

All Implemented Interfaces:

ASN1Type, java.security.spec.AlgorithmParameterSpec
```
public class IDEAParameterSpec
extends java.lang.Object
implements java.security.spec.AlgorithmParameterSpec, ASN1Type
```
This class implements the IDEA Parameter structure as defined in RFC 3058.
It specifies the initialization vector (IV), and is designed for use with the IDEA symmetric block cipher.
```
 IDEAParameter ::= SEQUENCE {
     iv    OCTET STRING OPTIONAL    -- exactly 8 octets
 }
 
```

Constructor Summary

Constructors
Constructor and Description
`IDEAParameterSpec()` The default constructor.
`IDEAParameterSpec(ASN1Object obj)` Creates a new `IDEAParameterSpec` object from an `ASN1Object`.
`IDEAParameterSpec(byte[] iv)` Creates a new `IDEAParameterSpec` object with the specified component.
`IDEAParameterSpec(byte[] iv, int offset)` Creates a new `IDEAParameterSpec` object with the specified component.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decode(ASN1Object obj)` Decodes an `IDEAParameterSpec` object from an `ASN1Object`.
`byte[]`	`getIV()` Returns a copy of the initialization vector (IV).
`void`	`setIV(byte[] iv, int offset)` Sets the initialization vector (IV) by copying 8 bytes of data from the byte array beginning at the specified offset.
`ASN1Object`	`toASN1Object()` Encodes this `IDEAParameterSpec` object as an `ASN1Object`.
`java.lang.String`	`toString()` Creates a text representation of the ASN.1 structure of this `IDEAParameterSpec` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IDEAParameterSpec
```
public IDEAParameterSpec()
```
    The default constructor.
    It creates a new IDEAParameterSpec object with the initialization vector (IV) not set (IV is an optional component).
  - IDEAParameterSpec
```
public IDEAParameterSpec(byte[] iv)
```
    Creates a new IDEAParameterSpec object with the specified component.
    The first 8 bytes of the supplied byte array are copied, and used as the initialization vector (IV). If the byte array is null, the IV is not set (IV is an optional component).
    
    Parameters:
    
    iv - a byte array containing the initialization vector
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if an 8-byte initialization vector could not be extracted from the byte array
  - IDEAParameterSpec
```
public IDEAParameterSpec(byte[] iv,
                         int offset)
```
    Creates a new IDEAParameterSpec object with the specified component.
    The 8-byte initialization vector (IV) is copied from the supplied byte array starting at the indicated offset. If the byte array is null, the IV is not set (IV is an optional component).
    
    Parameters:
    
    iv - a byte array containing the initialization vector
    
    offset - the offset in the byte array where the initialization vector begins
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if an 8-byte initialization vector could not be extracted from the byte array
  - IDEAParameterSpec
```
public IDEAParameterSpec(ASN1Object obj)
                  throws CodingException
```
    Creates a new IDEAParameterSpec object from an ASN1Object.
    The ASN1Object must be a IDEAParameter structure.
    
    Parameters:
    
    obj - the ASN.1 representation of a IDEAParameter structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
- Method Detail
  - getIV
```
public byte[] getIV()
```
    Returns a copy of the initialization vector (IV).
    If no IV has been set, null is returned.
    
    Returns:
    
    a copy of the initialization vector
  - setIV
```
public void setIV(byte[] iv,
                  int offset)
```
    Sets the initialization vector (IV) by copying 8 bytes of data from the byte array beginning at the specified offset.
    If the supplied byte array is null, then IV is set to null (IV is an optional component).
    
    Parameters:
    
    iv - a byte array containing the initialization vector
    
    offset - the offset in the byte array where the initialization vector begins
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if an 8-byte initialization vector could not be extracted from the byte array
    
    Since:
    
    7.0
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes an IDEAParameterSpec object from an ASN1Object.
    The ASN1Object must be a IDEAParameter structure.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    
    obj - an ASN.1 representation of a IDEAParameter structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Encodes this IDEAParameterSpec object as an ASN1Object.
    
    Specified by:
    
    toASN1Object in interface ASN1Type
    
    Returns:
    
    an ASN.1 representation of the IDEAParameter structure
  - toString
```
public java.lang.String toString()
```
    Creates a text representation of the ASN.1 structure of this IDEAParameterSpec object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a text representation of the ASN.1 structure of this object
    
    Since:
    
    7.0

Class IDEAParameterSpec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IDEAParameterSpec

IDEAParameterSpec

IDEAParameterSpec

IDEAParameterSpec

Method Detail

getIV

setIV

decode

toASN1Object

toString