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

Access	Constructor and Description
protected	Card() Constructs a new Card object.

Method Summary

Modifier and Type	Method and Description
public abstract void	beginExclusive() Requests exclusive access to this card.
public abstract void	disconnect(boolean whether to reset the card after disconnecting. reset) Disconnects the connection with this card.
public abstract void	endExclusive() Releases the exclusive access previously established using `beginExclusive`.
public abstract ATR	Returns: the ATR of this card. getATR() Returns the ATR of this card.
public abstract CardChannel	Returns: the CardChannel for the basic logical channel getBasicChannel() Returns the CardChannel for the basic logical channel.
public abstract String	Returns: the protocol in use for this card, for example "T=0" or "T=1" getProtocol() Returns the protocol in use for this card.
public abstract CardChannel	Returns: the logical channel which has been opened openLogicalChannel() Opens a new logical channel to the card and returns it.
public abstract byte[]	Returns: the response from the terminal device transmitControlCommand(int the control code of the command controlCode, byte[] the command data command) Transmits a control command to the terminal device.

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

Card	back to summary
protected Card() Constructs a new Card object. This constructor is called by subclasses only. Application should call the CardTerminal.connect() method to obtain a Card object.

Method Detail

beginExclusive back to summary

beginExclusive	back to summary
public abstract void beginExclusive() throws CardException Requests exclusive access to this card. Once a thread has invoked `beginExclusive`, only this thread is allowed to communicate with this card until it calls `endExclusive`. Other threads attempting communication will receive a CardException. Applications have to ensure that exclusive access is correctly released. This can be achieved by executing the `beginExclusive()` and `endExclusive` calls in a `try ... finally` block. Exceptions CardException: if exclusive access has already been set or if exclusive access could not be established SecurityException: if a SecurityManager exists and the caller does not have the required permission IllegalStateException: if this card object has been disposed of via the disconnect() method

public abstract void beginExclusive() throws CardException

Requests exclusive access to this card.

Once a thread has invoked beginExclusive, only this thread is allowed to communicate with this card until it calls endExclusive. Other threads attempting communication will receive a CardException.

Applications have to ensure that exclusive access is correctly released. This can be achieved by executing the beginExclusive() and endExclusive calls in a try ... finally block.

Exceptions

CardException:: if exclusive access has already been set or if exclusive access could not be established
SecurityException:: if a SecurityManager exists and the caller does not have the required permission
IllegalStateException:: if this card object has been disposed of via the disconnect() method

disconnect	back to summary
public abstract void disconnect(boolean reset) throws CardException Disconnects the connection with this card. After this method returns, calling methods on this object or in CardChannels associated with this object that require interaction with the card will raise an IllegalStateException. Parameters reset:boolean whether to reset the card after disconnecting. Exceptions CardException: if the card operation failed SecurityException: if a SecurityManager exists and the caller does not have the required permission

disconnect

back to summary

public abstract void disconnect(boolean reset) throws CardException

Disconnects the connection with this card. After this method returns, calling methods on this object or in CardChannels associated with this object that require interaction with the card will raise an IllegalStateException.

Parameters

reset:boolean: whether to reset the card after disconnecting.

Exceptions

CardException:: if the card operation failed
SecurityException:: if a SecurityManager exists and the caller does not have the required permission

endExclusive back to summary

endExclusive	back to summary
public abstract void endExclusive() throws CardException Releases the exclusive access previously established using `beginExclusive`. Exceptions CardException: if the operation failed SecurityException: if a SecurityManager exists and the caller does not have the required permission IllegalStateException: if the active Thread does not currently have exclusive access to this card or if this card object has been disposed of via the disconnect() method

public abstract void endExclusive() throws CardException

Releases the exclusive access previously established using beginExclusive.

Exceptions

CardException:: if the operation failed
SecurityException:: if a SecurityManager exists and the caller does not have the required permission
IllegalStateException:: if the active Thread does not currently have exclusive access to this card or if this card object has been disposed of via the disconnect() method

getATR	back to summary
public abstract ATR getATR() Returns the ATR of this card. Returns:ATR the ATR of this card.

getATR

back to summary

public abstract ATR getATR()

Returns the ATR of this card.

Returns:ATR: the ATR of this card.

getBasicChannel	back to summary
public abstract CardChannel getBasicChannel() Returns the CardChannel for the basic logical channel. The basic logical channel has a channel number of 0. Returns:CardChannel the CardChannel for the basic logical channel Exceptions SecurityException: if a SecurityManager exists and the caller does not have the required permission IllegalStateException: if this card object has been disposed of via the disconnect() method

getBasicChannel

back to summary

public abstract CardChannel getBasicChannel()

Returns the CardChannel for the basic logical channel. The basic logical channel has a channel number of 0.

Returns:CardChannel

the CardChannel for the basic logical channel

Exceptions

SecurityException:: if a SecurityManager exists and the caller does not have the required permission
IllegalStateException:: if this card object has been disposed of via the disconnect() method

getProtocol	back to summary
public abstract String getProtocol() Returns the protocol in use for this card. Returns:String the protocol in use for this card, for example "T=0" or "T=1"

getProtocol

back to summary

public abstract String getProtocol()

Returns the protocol in use for this card.

Returns:String: the protocol in use for this card, for example "T=0" or "T=1"

openLogicalChannel back to summary

openLogicalChannel	back to summary
public abstract CardChannel openLogicalChannel() throws CardException Opens a new logical channel to the card and returns it. The channel is opened by issuing a `MANAGE CHANNEL` command that should use the format `[00 70 00 00 01]`. Returns:CardChannel the logical channel which has been opened Exceptions CardException: is a new logical channel could not be opened SecurityException: if a SecurityManager exists and the caller does not have the required permission IllegalStateException: if this card object has been disposed of via the disconnect() method

public abstract CardChannel openLogicalChannel() throws CardException

Opens a new logical channel to the card and returns it. The channel is opened by issuing a MANAGE CHANNEL command that should use the format [00 70 00 00 01].

Returns:CardChannel

the logical channel which has been opened

Exceptions

CardException:: is a new logical channel could not be opened
SecurityException:: if a SecurityManager exists and the caller does not have the required permission
IllegalStateException:: if this card object has been disposed of via the disconnect() method

transmitControlCommand	back to summary
public abstract byte[] transmitControlCommand(int controlCode, byte[] command) throws CardException Transmits a control command to the terminal device. This can be used to, for example, control terminal functions like a built-in PIN pad or biometrics. Parameters controlCode:int the control code of the command command:byte[] the command data Returns:byte[] the response from the terminal device Exceptions CardException: if the card operation failed SecurityException: if a SecurityManager exists and the caller does not have the required permission NullPointerException: if command is null IllegalStateException: if this card object has been disposed of via the disconnect() method

transmitControlCommand

back to summary

public abstract byte[] transmitControlCommand(int controlCode, byte[] command) throws CardException

Transmits a control command to the terminal device.

This can be used to, for example, control terminal functions like a built-in PIN pad or biometrics.

Parameters

controlCode:int: the control code of the command
command:byte[]: the command data

Returns:byte[]

the response from the terminal device

Exceptions

CardException:: if the card operation failed
SecurityException:: if a SecurityManager exists and the caller does not have the required permission
NullPointerException:: if command is null
IllegalStateException:: if this card object has been disposed of via the disconnect() method

public abstract Class Card

Constructor Summary

Method Summary

Constructor Detail

Method Detail