SHOW Signed

net.rim.device.api.smartcard
Class AnswerToReset

java.lang.Object
  |
  +--net.rim.device.api.smartcard.AnswerToReset

All Implemented Interfaces:

net.rim.vm.Persistable

public class AnswerToReset

extends Object

implements net.rim.vm.Persistable

Represents an Answer to Reset object(ATR). The Answer to Reset structure is defined in ISO 7816-3. It contains two parts, protocol bytes and historical bytes.

It is assumed that Answer to Reset objects will be different for two different families or brands of smart cards. The Answer To Reset object is used to identify what type of card is present in the reader.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 4.1.0

See Also:

SmartCardReader

Constructor Summary

AnswerToReset(byte[] atr) Constructs an ATR object using the response from the card when an ATR request is sent.

Method Summary

	boolean	equals(Object other) Returns true if two AnswerToReset objects have the same protocol and historical bytes, false otherwise.
	byte[]	getBytes() Returns a copy the ATR bytes The first byte is the TS byte followed by a maximum of 32 bytes
	byte[]	getHistoricalBytes() Returns the historical bytes from the raw data that is formatted as per ISO 7816-3.
	byte[]	getProtocolBytes() Returns the protocol bytes from the raw data that is formatted as per ISO 7816-3.
	String	toString() Returns a String representation of the object.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AnswerToReset

public AnswerToReset(byte[] atr)

Constructs an ATR object using the response from the card when an ATR request is sent. The first byte must be the TS byte followed by a maximum of 32 bytes. The array must contain at least the TS byte( thus the first byte must be 0x3b or 0x3F )and the T0 byte. This method also checks if the length of the atr is greater than the TS byte + the protocol bytes + the historical bytes + the TCK byte, or less than the TS byte + the protocol bytes + the historical bytes. It does not check the TCK, as it does not always appear.

See ISO 7816-3 on how an ATR response is constructed.

Parameters:

atr - A byte array representing the response from the card.

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

getBytes

public byte[] getBytes()

Returns a copy the ATR bytes The first byte is the TS byte followed by a maximum of 32 bytes

Returns:

a copy of the ATR bytes

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getProtocolBytes

public byte[] getProtocolBytes()

Returns the protocol bytes from the raw data that is formatted as per ISO 7816-3. The TS byte is not included in the protocol bytes. Thus the first protocol byte is T0.

Returns:

A byte array containing the protocol bytes.

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getHistoricalBytes

public byte[] getHistoricalBytes()

Returns the historical bytes from the raw data that is formatted as per ISO 7816-3.

See ISO 7816-3 for specification on the meaning of the historical bytes. This does not include the TCK byte.

Returns:

A byte array containing the historical bytes.

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

equals

public boolean equals(Object other)

Returns true if two AnswerToReset objects have the same protocol and historical bytes, false otherwise.

Overrides:

equals in class Object

Parameters:

other - The item to compare this object against.

Returns:

True if the objects have the same protocol and historical bytes, false otherwise.

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

toString

public String toString()

Returns a String representation of the object.

The String includes the historical and protocol bytes.

Overrides:

toString in class Object

Returns:

A String represention of the object, including the historical and protocol bytes.

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.