net.sf.scuba.smartcards

Class CardService

java.lang.Object

net.sf.scuba.smartcards.CardService

Direct Known Subclasses:

WrappingCardService

public abstract class CardService
extends java.lang.Object

Default abstract service. Provides a factory method for creating card services. Provides some functionality for observing apdu events.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	SESSION_STARTED_STATE
protected static int	SESSION_STOPPED_STATE
protected int	state

Constructor Summary

Constructors

Constructor and Description
CardService() Creates a new service.

Method Summary

Modifier and Type	Method and Description
void	addAPDUListener(APDUListener l) Adds a listener.
abstract void	close() Closes the session with the card.
java.util.Collection<APDUListener>	getAPDUListeners() Returns the collection of APDU listeners.
abstract byte[]	getATR() Gets the answer to reset.
static CardService	getInstance(java.lang.Object object) Creates a card service.
abstract boolean	isConnectionLost(java.lang.Exception e) Determines whether an exception indicates a tag is lost event.
boolean	isExtendedAPDULengthSupported() Returns a boolean indicating whether extended length APDUs are supported.
abstract boolean	isOpen() Whether there is a session started with the card.
protected void	notifyExchangedAPDU(APDUEvent event) Notifies listeners about APDU event.
abstract void	open() Opens a session with the card.
void	removeAPDUListener(APDUListener l) Removes a listener.
abstract ResponseAPDU	transmit(CommandAPDU commandAPDU) Sends an APDU to the card.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSION_STOPPED_STATE

protected static final int SESSION_STOPPED_STATE

See Also:

Constant Field Values

SESSION_STARTED_STATE

protected static final int SESSION_STARTED_STATE

See Also:

Constant Field Values

state

protected int state

Constructor Detail

CardService

public CardService()

Creates a new service.

Method Detail

getInstance

public static CardService getInstance(java.lang.Object object)

Creates a card service.

Parameters:

object - some platform object responsible for transporting the APDU

Returns:

a card service

addAPDUListener

public void addAPDUListener(APDUListener l)

Adds a listener.

Parameters:

l - the listener to add

removeAPDUListener

public void removeAPDUListener(APDUListener l)

Removes a listener. If the specified listener is not present, this method has no effect.

Parameters:

l - the listener to remove

getAPDUListeners

public java.util.Collection<APDUListener> getAPDUListeners()

Returns the collection of APDU listeners. The result is an unmodifiable copy of the actual listeners at the moment of calling.

Returns:

the APDU listeners

notifyExchangedAPDU

protected void notifyExchangedAPDU(APDUEvent event)

Notifies listeners about APDU event.

Parameters:

event - the APDU event

open

public abstract void open()
                   throws CardServiceException

Opens a session with the card. Selects a reader. Connects to the card. Notifies any interested apduListeners.

Throws:

CardServiceException - on error

isOpen

public abstract boolean isOpen()

Whether there is a session started with the card.

Returns:

a boolean indicating whether sessions has started

transmit

public abstract ResponseAPDU transmit(CommandAPDU commandAPDU)
                               throws CardServiceException

Sends an APDU to the card. Notifies any interested apduListeners. This method does not throw a CardServiceException if the ResponseAPDU is status word indicating error.

Parameters:

commandAPDU - the Command APDU to send

Returns:

the Response APDU from the card, including the status word

Throws:

CardServiceException - if the card operation failed

getATR

public abstract byte[] getATR()
                       throws CardServiceException

Gets the answer to reset.

Returns:

the answer to reset

Throws:

CardServiceException - on error

isExtendedAPDULengthSupported

public boolean isExtendedAPDULengthSupported()

Returns a boolean indicating whether extended length APDUs are supported.

Returns:

a boolean indicating whether extended length APDUs are supported

close

public abstract void close()

Closes the session with the card. Disconnects from the card and reader. Notifies any interested apduListeners.

isConnectionLost

public abstract boolean isConnectionLost(java.lang.Exception e)

Determines whether an exception indicates a tag is lost event.

Parameters:

e - an exception

Returns:

whether the exception indicates a tag is lost event