org.eclipse.keyple.core.card.message

Class DefaultSelectionsRequest

java.lang.Object

org.eclipse.keyple.core.service.event.AbstractDefaultSelectionsRequest

org.eclipse.keyple.core.card.message.DefaultSelectionsRequest

public final class DefaultSelectionsRequest
extends AbstractDefaultSelectionsRequest

This POJO defines the default selection request to be processed when a card is inserted in an observable reader.

The default selection is defined by:

• A list of CardSelectionRequest corresponding to one or more selection cases.
• A MultiSelectionProcessing indicator specifying whether all planned selections are to be executed or whether to stop at the first one that is successful.
• A ChannelControl indicator controlling the physical channel to stipulate whether it should be closed or left open at the end of the selection process.

Note: this class extends the AbstractDefaultSelectionsRequest class which is the one handled at the application level.

Since:

0.9

Constructor Summary

Constructors

Constructor and Description
DefaultSelectionsRequest(java.util.List<CardSelectionRequest> cardSelectionRequests, MultiSelectionProcessing multiSelectionProcessing, ChannelControl channelControl) Builds a DefaultSelectionsRequest from a list of selection cases and two enum constants guiding the expected behaviour of the selection process.

Method Summary

Modifier and Type	Method and Description
java.util.List<CardSelectionRequest>	getCardSelectionRequests() Gets the list of selection cases provided in the default selection
ChannelControl	getChannelControl() Gets the indication whether the logic channel is to be kept open or closed
MultiSelectionProcessing	getMultiSelectionProcessing() Gets the indication whether the selection process should stop after the first matching case or process all of them.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSelectionsRequest

public DefaultSelectionsRequest(java.util.List<CardSelectionRequest> cardSelectionRequests,
                                MultiSelectionProcessing multiSelectionProcessing,
                                ChannelControl channelControl)

Builds a DefaultSelectionsRequest from a list of selection cases and two enum constants guiding the expected behaviour of the selection process.

The MultiSelectionProcessing enum is used to attempt to execute all the selection cases: MultiSelectionProcessing.PROCESS_ALL (for example in order to list all the applications present in a card) or MultiSelectionProcessing.FIRST_MATCH (to target a single application).

The ChannelControl enum controls the closing of the physical channel at the end of the selection.

Note: the CardSelectionRequest list should be carefully ordered in accordance with the cards expected in the application to optimize the processing time of the selection process. The first selection case in the list will be processed first.

Parameters:

cardSelectionRequests - A list of CardSelectionRequest embedding the selection data (must be not empty).

multiSelectionProcessing - The multi request processing mode (must be not null).

channelControl - The channel control (must be not null).

Since:

0.9

Method Detail

getMultiSelectionProcessing

public final MultiSelectionProcessing getMultiSelectionProcessing()

Gets the indication whether the selection process should stop after the first matching case or process all of them.

Specified by:

getMultiSelectionProcessing in class AbstractDefaultSelectionsRequest

Returns:

A not null value.

Since:

0.9

getChannelControl

public final ChannelControl getChannelControl()

Gets the indication whether the logic channel is to be kept open or closed

Specified by:

getChannelControl in class AbstractDefaultSelectionsRequest

Returns:

A not null value.

Since:

0.9

getCardSelectionRequests

public final java.util.List<CardSelectionRequest> getCardSelectionRequests()

Gets the list of selection cases provided in the default selection

Specified by:

getCardSelectionRequests in class AbstractDefaultSelectionsRequest

Returns:

A not empty list.

Since:

0.9