org.eclipse.keyple.core.card.selection

Class CardSelectionsService

java.lang.Object

org.eclipse.keyple.core.card.selection.CardSelectionsService

public final class CardSelectionsService
extends java.lang.Object

Provides the means to prepare and execute a card selection.

It provides a way to do an explicit card selection or to post process a default card selection.
The channel is kept open by default, but can be closed after each selection cases (see prepareReleaseChannel).

Since:

0.9

Constructor Summary

Constructors

Constructor and Description
CardSelectionsService() Alternate constructor for standard usages.
CardSelectionsService(MultiSelectionProcessing multiSelectionProcessing) Constructor.

Method Summary

Modifier and Type	Method and Description
AbstractDefaultSelectionsRequest	getDefaultSelectionsRequest() The SelectionOperation is the AbstractDefaultSelectionsRequest to process in ordered to select a card among others through the selection process.
void	prepareReleaseChannel() Prepare to close the card channel. If this command is called before a "process" selection command then the last transmission to the PO will be associated with the indication CLOSE_AFTER in order to close the card channel.
int	prepareSelection(AbstractCardSelection<? extends AbstractApduCommandBuilder> cardSelectionRequest) Prepare a selection: add the selection request from the provided selector to the selection request set.
CardSelectionsResult	processDefaultSelectionsResponse(AbstractDefaultSelectionsResponse defaultSelectionsResponse) Parses the response to a selection operation sent to a card and return a list of AbstractSmartCard
CardSelectionsResult	processExplicitSelections(Reader reader) Execute the selection process and return a list of AbstractSmartCard.

Methods inherited from class java.lang.Object

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

Constructor Detail

CardSelectionsService

public CardSelectionsService(MultiSelectionProcessing multiSelectionProcessing)

Constructor.

Parameters:

multiSelectionProcessing - the multi card processing mode

Since:

0.9

CardSelectionsService

public CardSelectionsService()

Alternate constructor for standard usages.

Method Detail

prepareSelection

public int prepareSelection(AbstractCardSelection<? extends AbstractApduCommandBuilder> cardSelectionRequest)

Prepare a selection: add the selection request from the provided selector to the selection request set.

Parameters:

cardSelectionRequest - the selector to prepare

Returns:

the selection index giving the current selection position in the selection request.

Since:

0.9

prepareReleaseChannel

public final void prepareReleaseChannel()

Prepare to close the card channel.
If this command is called before a "process" selection command then the last transmission to the PO will be associated with the indication CLOSE_AFTER in order to close the card channel.
This makes it possible to chain several selections on the same card if necessary.

Since:

0.9

processDefaultSelectionsResponse

public CardSelectionsResult processDefaultSelectionsResponse(AbstractDefaultSelectionsResponse defaultSelectionsResponse)

Parses the response to a selection operation sent to a card and return a list of AbstractSmartCard

Selection cases that have not matched the current card are set to null.

Parameters:

defaultSelectionsResponse - the response from the reader to the AbstractDefaultSelectionsRequest

Returns:

the CardSelectionsResult containing the result of all prepared selection cases, including AbstractSmartCard and CardResponse.

Throws:

KeypleException - if an error occurs during the selection process

Since:

0.9

processExplicitSelections

public CardSelectionsResult processExplicitSelections(Reader reader)

Execute the selection process and return a list of AbstractSmartCard.

Selection requests are transmitted to the card through the supplied Reader.

The process stops in the following cases:

• All the selection requests have been transmitted
• A selection request matches the current card and the keepChannelOpen flag was true

Parameters:

reader - the Reader on which the selection is made

Returns:

the CardSelectionsResult containing the result of all prepared selection cases, including AbstractSmartCard and CardResponse.

Throws:

KeypleReaderIOException - if the communication with the reader or the card has failed

KeypleException - if an error occurs during the selection process

Since:

0.9

getDefaultSelectionsRequest

public AbstractDefaultSelectionsRequest getDefaultSelectionsRequest()

The SelectionOperation is the AbstractDefaultSelectionsRequest to process in ordered to select a card among others through the selection process. This method is useful to build the prepared selection to be executed by a reader just after a card insertion.

Returns:

the AbstractDefaultSelectionsRequest previously prepared with prepareSelection

Since:

0.9