OpenJDK 27 · javax.smartcardio.CommandAPDU · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private byte[]	apdu
private transient int	dataOffset
private static final int	MAX_APDU_SIZE
private transient int	nc
private transient int	ne
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	CommandAPDU(byte[] the complete command APDU apdu) Constructs a CommandAPDU from a byte array containing the complete APDU contents (header and body).
public	CommandAPDU(byte[] the complete command APDU apdu, int the offset in the byte array at which the apdu data begins apduOffset, int the length of the APDU apduLength) Constructs a CommandAPDU from a byte array containing the complete APDU contents (header and body).
public	CommandAPDU(ByteBuffer the ByteBuffer containing the complete APDU apdu) Creates a CommandAPDU from the ByteBuffer containing the complete APDU contents (header and body).
public	CommandAPDU(int the class byte CLA cla, int the instruction byte INS ins, int the parameter byte P1 p1, int the parameter byte P2 p2) Constructs a CommandAPDU from the four header bytes.
public	CommandAPDU(int the class byte CLA cla, int the instruction byte INS ins, int the parameter byte P1 p1, int the parameter byte P2 p2, int the maximum number of expected data bytes in a response APDU ne) Constructs a CommandAPDU from the four header bytes and the expected response data length.
public	CommandAPDU(int the class byte CLA cla, int the instruction byte INS ins, int the parameter byte P1 p1, int the parameter byte P2 p2, byte[] the byte array containing the data bytes of the command body data) Constructs a CommandAPDU from the four header bytes and command data.
public	CommandAPDU(int the class byte CLA cla, int the instruction byte INS ins, int the parameter byte P1 p1, int the parameter byte P2 p2, byte[] the byte array containing the data bytes of the command body data, int the offset in the byte array at which the data bytes of the command body begin dataOffset, int the number of the data bytes in the command body dataLength) Constructs a CommandAPDU from the four header bytes and command data.
public	CommandAPDU(int the class byte CLA cla, int the instruction byte INS ins, int the parameter byte P1 p1, int the parameter byte P2 p2, byte[] the byte array containing the data bytes of the command body data, int the maximum number of expected data bytes in a response APDU ne) Constructs a CommandAPDU from the four header bytes, command data, and expected response data length.
public	CommandAPDU(int the class byte CLA cla, int the instruction byte INS ins, int the parameter byte P1 p1, int the parameter byte P2 p2, byte[] the byte array containing the data bytes of the command body data, int the offset in the byte array at which the data bytes of the command body begin dataOffset, int the number of the data bytes in the command body dataLength, int the maximum number of expected data bytes in a response APDU ne) Constructs a CommandAPDU from the four header bytes, command data, and expected response data length.

Method Summary

Modifier and Type	Method and Description
private static int	arrayLength(byte[] b)
private void	checkArrayBounds(byte[] b, int ofs, int len)
public boolean	Returns: true if the specified object is equal to this command APDU equals(Object the object to be compared for equality with this command APDU obj) Overrides java.lang.Object.equals. Compares the specified object with this command APDU for equality.
public byte[]	Returns: a copy of the bytes in this APDU. getBytes() Returns a copy of the bytes in this APDU.
public int	Returns: the value of the class byte CLA. getCLA() Returns the value of the class byte CLA.
public byte[]	Returns: a copy of the data bytes in the command body or the empty byte array if this APDU has no body. getData() Returns a copy of the data bytes in the command body.
public int	Returns: the value of the instruction byte INS. getINS() Returns the value of the instruction byte INS.
public int	Returns: the number of data bytes in the command body or 0 if this APDU has no body. getNc() Returns the number of data bytes in the command body (Nc) or 0 if this APDU has no body.
public int	Returns: the maximum number of expected data bytes in a response APDU. getNe() Returns the maximum number of expected data bytes in a response APDU (Ne).
public int	Returns: the value of the parameter byte P1. getP1() Returns the value of the parameter byte P1.
public int	Returns: the value of the parameter byte P2. getP2() Returns the value of the parameter byte P2.
public int	Returns: the hash code value for this command APDU. hashCode() Overrides java.lang.Object.hashCode. Returns the hash code value for this command APDU.
private void	parse() Command APDU encoding options: case 1: \|CLA\|INS\|P1 \|P2 \| len = 4 case 2s: \|CLA\|INS\|P1 \|P2 \|LE \| len = 5 case 3s: \|CLA\|INS\|P1 \|P2 \|LC \|...BODY...\| len = 6..260 case 4s: \|CLA\|INS\|P1 \|P2 \|LC \|...BODY...\|LE \| len = 7..261 case 2e: \|CLA\|INS\|P1 \|P2 \|00 \|LE1\|LE2\| len = 7 case 3e: \|CLA\|INS\|P1 \|P2 \|00 \|LC1\|LC2\|...BODY...\| len = 8..65542 case 4e: \|CLA\|INS\|P1 \|P2 \|00 \|LC1\|LC2\|...BODY...\|LE1\|LE2\| len =10..65544 LE, LE1, LE2 may be 0x00.
private void	readObject(ObjectInputStream in)
private void	setHeader(int cla, int ins, int p1, int p2)
public String	Returns: a String representation of this command APDU. toString() Overrides java.lang.Object.toString. Returns a string representation of this command APDU.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

apdu	back to summary
private byte[] apdu

dataOffset	back to summary
private transient int dataOffset

MAX_APDU_SIZE	back to summary
private static final int MAX_APDU_SIZE

nc	back to summary
private transient int nc

ne	back to summary
private transient int ne

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

CommandAPDU	back to summary
public CommandAPDU(byte[] apdu) Constructs a CommandAPDU from a byte array containing the complete APDU contents (header and body). Note that the apdu bytes are copied to protect against subsequent modification. Parameters apdu:byte[] the complete command APDU Exceptions NullPointerException: if apdu is null IllegalArgumentException: if apdu does not contain a valid command APDU

CommandAPDU

back to summary

public CommandAPDU(byte[] apdu)

Constructs a CommandAPDU from a byte array containing the complete APDU contents (header and body).

Note that the apdu bytes are copied to protect against subsequent modification.

Parameters

apdu:byte[]: the complete command APDU

Exceptions

NullPointerException:: if apdu is null
IllegalArgumentException:: if apdu does not contain a valid command APDU

CommandAPDU back to summary

CommandAPDU	back to summary
public CommandAPDU(byte[] apdu, int apduOffset, int apduLength) Constructs a CommandAPDU from a byte array containing the complete APDU contents (header and body). The APDU starts at the index `apduOffset` in the byte array and is `apduLength` bytes long. Note that the apdu bytes are copied to protect against subsequent modification. Parameters apdu:byte[] the complete command APDU apduOffset:int the offset in the byte array at which the apdu data begins apduLength:int the length of the APDU Exceptions NullPointerException: if apdu is null IllegalArgumentException: if apduOffset or apduLength are negative or if apduOffset + apduLength are greater than apdu.length, or if the specified bytes are not a valid APDU

public CommandAPDU(byte[] apdu, int apduOffset, int apduLength)

Constructs a CommandAPDU from a byte array containing the complete APDU contents (header and body). The APDU starts at the index apduOffset in the byte array and is apduLength bytes long.

Note that the apdu bytes are copied to protect against subsequent modification.

Parameters

apdu:byte[]: the complete command APDU
apduOffset:int: the offset in the byte array at which the apdu data begins
apduLength:int: the length of the APDU

Exceptions

NullPointerException:: if apdu is null
IllegalArgumentException:: if apduOffset or apduLength are negative or if apduOffset + apduLength are greater than apdu.length, or if the specified bytes are not a valid APDU

CommandAPDU back to summary

CommandAPDU	back to summary
public CommandAPDU(ByteBuffer apdu) Creates a CommandAPDU from the ByteBuffer containing the complete APDU contents (header and body). The buffer's `position` must be set to the start of the APDU, its `limit` to the end of the APDU. Upon return, the buffer's `position` is equal to its limit; its limit remains unchanged. Note that the data in the ByteBuffer is copied to protect against subsequent modification. Parameters apdu:ByteBuffer the ByteBuffer containing the complete APDU Exceptions NullPointerException: if apdu is null IllegalArgumentException: if apdu does not contain a valid command APDU

public CommandAPDU(ByteBuffer apdu)

Creates a CommandAPDU from the ByteBuffer containing the complete APDU contents (header and body). The buffer's position must be set to the start of the APDU, its limit to the end of the APDU. Upon return, the buffer's position is equal to its limit; its limit remains unchanged.

Note that the data in the ByteBuffer is copied to protect against subsequent modification.

Parameters

apdu:ByteBuffer: the ByteBuffer containing the complete APDU

Exceptions

NullPointerException:: if apdu is null
IllegalArgumentException:: if apdu does not contain a valid command APDU

CommandAPDU	back to summary
public CommandAPDU(int cla, int ins, int p1, int p2) Constructs a CommandAPDU from the four header bytes. This is case 1 in ISO 7816, no command body. Parameters cla:int the class byte CLA ins:int the instruction byte INS p1:int the parameter byte P1 p2:int the parameter byte P2

CommandAPDU

back to summary

public CommandAPDU(int cla, int ins, int p1, int p2)

Constructs a CommandAPDU from the four header bytes. This is case 1 in ISO 7816, no command body.

Parameters

cla:int: the class byte CLA
ins:int: the instruction byte INS
p1:int: the parameter byte P1
p2:int: the parameter byte P2

CommandAPDU	back to summary
public CommandAPDU(int cla, int ins, int p1, int p2, int ne) Constructs a CommandAPDU from the four header bytes and the expected response data length. This is case 2 in ISO 7816, empty command data field with Ne specified. If Ne is 0, the APDU is encoded as ISO 7816 case 1. Parameters cla:int the class byte CLA ins:int the instruction byte INS p1:int the parameter byte P1 p2:int the parameter byte P2 ne:int the maximum number of expected data bytes in a response APDU Exceptions IllegalArgumentException: if ne is negative or greater than 65536

CommandAPDU

back to summary

public CommandAPDU(int cla, int ins, int p1, int p2, int ne)

Constructs a CommandAPDU from the four header bytes and the expected response data length. This is case 2 in ISO 7816, empty command data field with Ne specified. If Ne is 0, the APDU is encoded as ISO 7816 case 1.

Parameters

cla:int: the class byte CLA
ins:int: the instruction byte INS
p1:int: the parameter byte P1
p2:int: the parameter byte P2
ne:int: the maximum number of expected data bytes in a response APDU

Exceptions

IllegalArgumentException:: if ne is negative or greater than 65536

CommandAPDU back to summary

CommandAPDU	back to summary
public CommandAPDU(int cla, int ins, int p1, int p2, byte[] data) Constructs a CommandAPDU from the four header bytes and command data. This is case 3 in ISO 7816, command data present and Ne absent. The value Nc is taken as data.length. If `data` is null or its length is 0, the APDU is encoded as ISO 7816 case 1. Note that the data bytes are copied to protect against subsequent modification. Parameters cla:int the class byte CLA ins:int the instruction byte INS p1:int the parameter byte P1 p2:int the parameter byte P2 data:byte[] the byte array containing the data bytes of the command body Exceptions IllegalArgumentException: if data.length is greater than 65535

public CommandAPDU(int cla, int ins, int p1, int p2, byte[] data)

Constructs a CommandAPDU from the four header bytes and command data. This is case 3 in ISO 7816, command data present and Ne absent. The value Nc is taken as data.length. If data is null or its length is 0, the APDU is encoded as ISO 7816 case 1.

Note that the data bytes are copied to protect against subsequent modification.

Parameters

cla:int: the class byte CLA
ins:int: the instruction byte INS
p1:int: the parameter byte P1
p2:int: the parameter byte P2
data:byte[]: the byte array containing the data bytes of the command body

Exceptions

IllegalArgumentException:: if data.length is greater than 65535

CommandAPDU back to summary

CommandAPDU	back to summary
public CommandAPDU(int cla, int ins, int p1, int p2, byte[] data, int dataOffset, int dataLength) Constructs a CommandAPDU from the four header bytes and command data. This is case 3 in ISO 7816, command data present and Ne absent. The value Nc is taken as dataLength. If `dataLength` is 0, the APDU is encoded as ISO 7816 case 1. Note that the data bytes are copied to protect against subsequent modification. Parameters cla:int the class byte CLA ins:int the instruction byte INS p1:int the parameter byte P1 p2:int the parameter byte P2 data:byte[] the byte array containing the data bytes of the command body dataOffset:int the offset in the byte array at which the data bytes of the command body begin dataLength:int the number of the data bytes in the command body Exceptions NullPointerException: if data is null and dataLength is not 0 IllegalArgumentException: if dataOffset or dataLength are negative or if dataOffset + dataLength are greater than data.length or if dataLength is greater than 65535

public CommandAPDU(int cla, int ins, int p1, int p2, byte[] data, int dataOffset, int dataLength)

Constructs a CommandAPDU from the four header bytes and command data. This is case 3 in ISO 7816, command data present and Ne absent. The value Nc is taken as dataLength. If dataLength is 0, the APDU is encoded as ISO 7816 case 1.

Note that the data bytes are copied to protect against subsequent modification.

Parameters

cla:int: the class byte CLA
ins:int: the instruction byte INS
p1:int: the parameter byte P1
p2:int: the parameter byte P2
data:byte[]: the byte array containing the data bytes of the command body
dataOffset:int: the offset in the byte array at which the data bytes of the command body begin
dataLength:int: the number of the data bytes in the command body

Exceptions

NullPointerException:: if data is null and dataLength is not 0
IllegalArgumentException:: if dataOffset or dataLength are negative or if dataOffset + dataLength are greater than data.length or if dataLength is greater than 65535

CommandAPDU back to summary

CommandAPDU	back to summary
public CommandAPDU(int cla, int ins, int p1, int p2, byte[] data, int ne) Constructs a CommandAPDU from the four header bytes, command data, and expected response data length. This is case 4 in ISO 7816, command data and Ne present. The value Nc is taken as data.length if `data` is non-null and as 0 otherwise. If Ne or Nc are zero, the APDU is encoded as case 1, 2, or 3 per ISO 7816. Note that the data bytes are copied to protect against subsequent modification. Parameters cla:int the class byte CLA ins:int the instruction byte INS p1:int the parameter byte P1 p2:int the parameter byte P2 data:byte[] the byte array containing the data bytes of the command body ne:int the maximum number of expected data bytes in a response APDU Exceptions IllegalArgumentException: if data.length is greater than 65535 or if ne is negative or greater than 65536

public CommandAPDU(int cla, int ins, int p1, int p2, byte[] data, int ne)

Constructs a CommandAPDU from the four header bytes, command data, and expected response data length. This is case 4 in ISO 7816, command data and Ne present. The value Nc is taken as data.length if data is non-null and as 0 otherwise. If Ne or Nc are zero, the APDU is encoded as case 1, 2, or 3 per ISO 7816.

Note that the data bytes are copied to protect against subsequent modification.

Parameters

cla:int: the class byte CLA
ins:int: the instruction byte INS
p1:int: the parameter byte P1
p2:int: the parameter byte P2
data:byte[]: the byte array containing the data bytes of the command body
ne:int: the maximum number of expected data bytes in a response APDU

Exceptions

IllegalArgumentException:: if data.length is greater than 65535 or if ne is negative or greater than 65536

CommandAPDU back to summary

CommandAPDU	back to summary
public CommandAPDU(int cla, int ins, int p1, int p2, byte[] data, int dataOffset, int dataLength, int ne) Constructs a CommandAPDU from the four header bytes, command data, and expected response data length. This is case 4 in ISO 7816, command data and Le present. The value Nc is taken as `dataLength`. If Ne or Nc are zero, the APDU is encoded as case 1, 2, or 3 per ISO 7816. Note that the data bytes are copied to protect against subsequent modification. Parameters cla:int the class byte CLA ins:int the instruction byte INS p1:int the parameter byte P1 p2:int the parameter byte P2 data:byte[] the byte array containing the data bytes of the command body dataOffset:int the offset in the byte array at which the data bytes of the command body begin dataLength:int the number of the data bytes in the command body ne:int the maximum number of expected data bytes in a response APDU Exceptions NullPointerException: if data is null and dataLength is not 0 IllegalArgumentException: if dataOffset or dataLength are negative or if dataOffset + dataLength are greater than data.length, or if ne is negative or greater than 65536, or if dataLength is greater than 65535

public CommandAPDU(int cla, int ins, int p1, int p2, byte[] data, int dataOffset, int dataLength, int ne)

Constructs a CommandAPDU from the four header bytes, command data, and expected response data length. This is case 4 in ISO 7816, command data and Le present. The value Nc is taken as dataLength. If Ne or Nc are zero, the APDU is encoded as case 1, 2, or 3 per ISO 7816.

Note that the data bytes are copied to protect against subsequent modification.

Parameters

cla:int: the class byte CLA
ins:int: the instruction byte INS
p1:int: the parameter byte P1
p2:int: the parameter byte P2
data:byte[]: the byte array containing the data bytes of the command body
dataOffset:int: the offset in the byte array at which the data bytes of the command body begin
dataLength:int: the number of the data bytes in the command body
ne:int: the maximum number of expected data bytes in a response APDU

Exceptions

NullPointerException:: if data is null and dataLength is not 0
IllegalArgumentException:: if dataOffset or dataLength are negative or if dataOffset + dataLength are greater than data.length, or if ne is negative or greater than 65536, or if dataLength is greater than 65535

Method Detail

arrayLength	back to summary
private static int arrayLength(byte[] b)

checkArrayBounds	back to summary
private void checkArrayBounds(byte[] b, int ofs, int len)

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Compares the specified object with this command APDU for equality. Returns true if the given object is also a CommandAPDU and its bytes are identical to the bytes in this CommandAPDU. Parameters obj:Object the object to be compared for equality with this command APDU Returns:boolean true if the specified object is equal to this command APDU

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Compares the specified object with this command APDU for equality. Returns true if the given object is also a CommandAPDU and its bytes are identical to the bytes in this CommandAPDU.

Parameters

obj:Object: the object to be compared for equality with this command APDU

Returns:boolean

true if the specified object is equal to this command APDU

getBytes	back to summary
public byte[] getBytes() Returns a copy of the bytes in this APDU. Returns:byte[] a copy of the bytes in this APDU.

getBytes

back to summary

public byte[] getBytes()

Returns a copy of the bytes in this APDU.

Returns:byte[]: a copy of the bytes in this APDU.

getCLA	back to summary
public int getCLA() Returns the value of the class byte CLA. Returns:int the value of the class byte CLA.

getCLA

back to summary

public int getCLA()

Returns the value of the class byte CLA.

Returns:int: the value of the class byte CLA.

getData	back to summary
public byte[] getData() Returns a copy of the data bytes in the command body. If this APDU as no body, this method returns a byte array with length zero. Returns:byte[] a copy of the data bytes in the command body or the empty byte array if this APDU has no body.

getData

back to summary

public byte[] getData()

Returns a copy of the data bytes in the command body. If this APDU as no body, this method returns a byte array with length zero.

Returns:byte[]: a copy of the data bytes in the command body or the empty byte array if this APDU has no body.

getINS	back to summary
public int getINS() Returns the value of the instruction byte INS. Returns:int the value of the instruction byte INS.

getINS

back to summary

public int getINS()

Returns the value of the instruction byte INS.

Returns:int: the value of the instruction byte INS.

getNc back to summary

getNc	back to summary
public int getNc() Returns the number of data bytes in the command body (Nc) or 0 if this APDU has no body. This call is equivalent to `getData().length`. Returns:int the number of data bytes in the command body or 0 if this APDU has no body.

public int getNc()

Returns the number of data bytes in the command body (Nc) or 0 if this APDU has no body. This call is equivalent to getData().length.

Returns:int: the number of data bytes in the command body or 0 if this APDU has no body.

getNe	back to summary
public int getNe() Returns the maximum number of expected data bytes in a response APDU (Ne). Returns:int the maximum number of expected data bytes in a response APDU.

getNe

back to summary

public int getNe()

Returns the maximum number of expected data bytes in a response APDU (Ne).

Returns:int: the maximum number of expected data bytes in a response APDU.

getP1	back to summary
public int getP1() Returns the value of the parameter byte P1. Returns:int the value of the parameter byte P1.

getP1

back to summary

public int getP1()

Returns the value of the parameter byte P1.

Returns:int: the value of the parameter byte P1.

getP2	back to summary
public int getP2() Returns the value of the parameter byte P2. Returns:int the value of the parameter byte P2.

getP2

back to summary

public int getP2()

Returns the value of the parameter byte P2.

Returns:int: the value of the parameter byte P2.

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns the hash code value for this command APDU. Returns:int the hash code value for this command APDU.

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the hash code value for this command APDU.

Returns:int: the hash code value for this command APDU.

parse	back to summary
private void parse() Command APDU encoding options: case 1: \|CLA\|INS\|P1 \|P2 \| len = 4 case 2s: \|CLA\|INS\|P1 \|P2 \|LE \| len = 5 case 3s: \|CLA\|INS\|P1 \|P2 \|LC \|...BODY...\| len = 6..260 case 4s: \|CLA\|INS\|P1 \|P2 \|LC \|...BODY...\|LE \| len = 7..261 case 2e: \|CLA\|INS\|P1 \|P2 \|00 \|LE1\|LE2\| len = 7 case 3e: \|CLA\|INS\|P1 \|P2 \|00 \|LC1\|LC2\|...BODY...\| len = 8..65542 case 4e: \|CLA\|INS\|P1 \|P2 \|00 \|LC1\|LC2\|...BODY...\|LE1\|LE2\| len =10..65544 LE, LE1, LE2 may be 0x00. LC must not be 0x00 and LC1\|LC2 must not be 0x00\|0x00

parse

back to summary

private void parse()

Command APDU encoding options: case 1: |CLA|INS|P1 |P2 | len = 4 case 2s: |CLA|INS|P1 |P2 |LE | len = 5 case 3s: |CLA|INS|P1 |P2 |LC |...BODY...| len = 6..260 case 4s: |CLA|INS|P1 |P2 |LC |...BODY...|LE | len = 7..261 case 2e: |CLA|INS|P1 |P2 |00 |LE1|LE2| len = 7 case 3e: |CLA|INS|P1 |P2 |00 |LC1|LC2|...BODY...| len = 8..65542 case 4e: |CLA|INS|P1 |P2 |00 |LC1|LC2|...BODY...|LE1|LE2| len =10..65544 LE, LE1, LE2 may be 0x00. LC must not be 0x00 and LC1|LC2 must not be 0x00|0x00

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

setHeader	back to summary
private void setHeader(int cla, int ins, int p1, int p2)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of this command APDU. Returns:String a String representation of this command APDU.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this command APDU.

Returns:String: a String representation of this command APDU.

public final Class CommandAPDU

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail