Index (Keypop Reader API

A B C D E F G I L M N O P R S U V
All Classes All Packages

A

activateProtocol(String, String) - Method in interface org.eclipse.keypop.reader.ConfigurableCardReader: Activates the reader communication protocol by associating the provided physical communication protocol name and the logical communication protocol name defined by the application.
addObserver(CardReaderObserverSpi) - Method in interface org.eclipse.keypop.reader.ObservableCardReader: Registers a new observer to be notified when a reader event occurs.
ALWAYS - org.eclipse.keypop.reader.ObservableCardReader.NotificationMode: All cards presented to the readers are notified to the observers, regardless of the result of the selection.

B

BasicCardSelector - Interface in org.eclipse.keypop.reader.selection: Basic filters used to restrict the selection process to certain cards.

C

CARD_INSERTED - org.eclipse.keypop.reader.CardReaderEvent.Type: A card has been inserted with or without specific selection.
CARD_MATCHED - org.eclipse.keypop.reader.CardReaderEvent.Type: A card has been inserted that matches the selection.
CARD_REMOVED - org.eclipse.keypop.reader.CardReaderEvent.Type: The card has been removed from the reader.
CardCommunicationException - Exception in org.eclipse.keypop.reader: Indicates that the communication with the card failed.
CardCommunicationException(String) - Constructor for exception org.eclipse.keypop.reader.CardCommunicationException
CardCommunicationException(String, Throwable) - Constructor for exception org.eclipse.keypop.reader.CardCommunicationException
CardReader - Interface in org.eclipse.keypop.reader: Card reader driving the underlying hardware to manage the card detection.
CardReaderEvent - Interface in org.eclipse.keypop.reader: Card event data container indicating a change of state.
CardReaderEvent.Type - Enum in org.eclipse.keypop.reader: Possible card events.
CardReaderObservationExceptionHandlerSpi - Interface in org.eclipse.keypop.reader.spi: Reader observation error handler to implement in order to be notified of errors that may occur during operations carried out by the card monitoring process.
CardReaderObserverSpi - Interface in org.eclipse.keypop.reader.spi: Reader observer to implement in order to receive CardReaderEvent from a ObservableCardReader.
CardSelectionExtension - Interface in org.eclipse.keypop.reader.selection.spi: SPI provided by a card extension, allowing to enrich a selection case with additional commands if required, and to interpret the return to selection in order to build and fill the specific SmartCard which acts as an image of the targeted card.
CardSelectionManager - Interface in org.eclipse.keypop.reader.selection: Service dedicated to card selection, based on the preparation of a card selection scenario.
CardSelectionResult - Interface in org.eclipse.keypop.reader.selection: Result of a selection process.
CardSelector<T extends CardSelector<T>> - Interface in org.eclipse.keypop.reader.selection: Common filters used to restrict the selection process to certain cards.
clearObservers() - Method in interface org.eclipse.keypop.reader.ObservableCardReader: Unregisters all observers at once.
CommonIsoCardSelector<T extends CommonIsoCardSelector<T>> - Interface in org.eclipse.keypop.reader.selection: Common ISO filters used to restrict the selection process to certain ISO 7816-4 cards.
CommonIsoCardSelector.FileControlInformation - Enum in org.eclipse.keypop.reader.selection: Types of templates available in return for the Select Application command, according to the ISO7816-4 standard.
CommonIsoCardSelector.FileOccurrence - Enum in org.eclipse.keypop.reader.selection: Navigation options through the different applications contained in the card according to the ISO7816-4 standard.
ConfigurableCardReader - Interface in org.eclipse.keypop.reader: Configurable card reader providing the methods to manage the card protocols.
countObservers() - Method in interface org.eclipse.keypop.reader.ObservableCardReader: Provides the current number of registered observers.
createBasicCardSelector() - Method in interface org.eclipse.keypop.reader.ReaderApiFactory: Returns a new instance of BasicCardSelector.
createCardSelectionManager() - Method in interface org.eclipse.keypop.reader.ReaderApiFactory: Returns a new instance of CardSelectionManager.
createIsoCardSelector() - Method in interface org.eclipse.keypop.reader.ReaderApiFactory: Returns a new instance of IsoCardSelector.

D

deactivateProtocol(String) - Method in interface org.eclipse.keypop.reader.ConfigurableCardReader: Deactivates the provided reader communication protocol.

E

exportCardSelectionScenario() - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Exports the content of the current prepared card selection scenario in string format.
exportProcessedCardSelectionScenario() - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Exports the content of the previously processed card selection scenario in string format.

F

FCI - org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileControlInformation: File control information.
FCP - org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileControlInformation: File control parameters.
filterByCardProtocol(String) - Method in interface org.eclipse.keypop.reader.selection.CardSelector: Restricts the selection process to cards communicating with the reader according to a specific protocol, corresponding to the underlying technology: ISO14443-A, ISO14443-B or any other proprietary or standardized communication technology.
filterByDfName(byte[]) - Method in interface org.eclipse.keypop.reader.selection.CommonIsoCardSelector: Selects a card application DF by its name.
filterByDfName(String) - Method in interface org.eclipse.keypop.reader.selection.CommonIsoCardSelector: Selects a card application DF by its name.
filterByPowerOnData(String) - Method in interface org.eclipse.keypop.reader.selection.CardSelector: Restricts the selection process to cards whose power-on data provided by the reader matches a specific regular expression.
finalizeCardProcessing() - Method in interface org.eclipse.keypop.reader.ObservableCardReader: Notifies the observation process that the processing of the card has been completed in order to ensure that the card monitoring cycle runs properly.
FIRST - org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileOccurrence: First occurrence.
FMD - org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileControlInformation: File management data.

G

getActiveSelectionIndex() - Method in interface org.eclipse.keypop.reader.selection.CardSelectionResult: Gets the index of the active selection if any.
getActiveSmartCard() - Method in interface org.eclipse.keypop.reader.selection.CardSelectionResult: Gets the active matching card.
getCurrentProtocol() - Method in interface org.eclipse.keypop.reader.ConfigurableCardReader: Returns the name of the physical protocol currently used by the reader.
getName() - Method in interface org.eclipse.keypop.reader.CardReader: Returns the name of the reader.
getPowerOnData() - Method in interface org.eclipse.keypop.reader.selection.spi.SmartCard: Gets the card's power-on data.
getReaderName() - Method in interface org.eclipse.keypop.reader.CardReaderEvent: Returns the name of the reader that generated the event.
getScheduledCardSelectionsResponse() - Method in interface org.eclipse.keypop.reader.CardReaderEvent: Returns the card selection responses when it is available and null in all other cases.
getSelectApplicationResponse() - Method in interface org.eclipse.keypop.reader.selection.spi.IsoSmartCard: Gets the card data received in response to the "Select Application" command (including the status word).
getSmartCards() - Method in interface org.eclipse.keypop.reader.selection.CardSelectionResult: Gets all SmartCard corresponding to all successful selection cases in a map for which the key is the selection index provided by the CardSelectionManager.prepareSelection(CardSelector, CardSelectionExtension) method.
getType() - Method in interface org.eclipse.keypop.reader.CardReaderEvent: Returns the card reader event type.

I

importCardSelectionScenario(String) - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Imports a previously exported card selection scenario in string format.
importProcessedCardSelectionScenario(String) - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Imports a previously exported processed card selection scenario in string format and returns the card selection result.
InvalidCardResponseException - Exception in org.eclipse.keypop.reader.selection: Indicates that a response received from the card during the selection process was invalid.
InvalidCardResponseException(String) - Constructor for exception org.eclipse.keypop.reader.selection.InvalidCardResponseException
InvalidCardResponseException(String, Throwable) - Constructor for exception org.eclipse.keypop.reader.selection.InvalidCardResponseException
isCardPresent() - Method in interface org.eclipse.keypop.reader.CardReader: Checks if the card is present.
isContactless() - Method in interface org.eclipse.keypop.reader.CardReader: Checks if the card communication mode is contactless.
IsoCardSelector - Interface in org.eclipse.keypop.reader.selection: ISO filters used to restrict the selection process to certain ISO 7816-4 cards.
IsoSmartCard - Interface in org.eclipse.keypop.reader.selection.spi: ISO 7816-4 smart card with which communication has been established after a selection process and which is ready to receive APDUs.

L

LAST - org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileOccurrence: Last occurrence.

M

MATCHED_ONLY - org.eclipse.keypop.reader.ObservableCardReader.NotificationMode: Only the cards that have been successfully selected will be notified to the observers.

N

NEXT - org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileOccurrence: Next occurrence.
NO_RESPONSE - org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileControlInformation: No response expected.

O

ObservableCardReader - Interface in org.eclipse.keypop.reader: Card reader able to observe the insertion/removal of cards.
ObservableCardReader.DetectionMode - Enum in org.eclipse.keypop.reader: Card detection management options to be applied after processing a card.
ObservableCardReader.NotificationMode - Enum in org.eclipse.keypop.reader: The options that apply when a card is detected.
onReaderEvent(CardReaderEvent) - Method in interface org.eclipse.keypop.reader.spi.CardReaderObserverSpi: Called when a reader event occurs.
onReaderObservationError(String, String, Throwable) - Method in interface org.eclipse.keypop.reader.spi.CardReaderObservationExceptionHandlerSpi: Called when an error occurs in the observed reader.
org.eclipse.keypop.reader - package org.eclipse.keypop.reader: Components used in applications to manage readers and their observation.
org.eclipse.keypop.reader.selection - package org.eclipse.keypop.reader.selection: Components used to manage card selection.
org.eclipse.keypop.reader.selection.spi - package org.eclipse.keypop.reader.selection.spi: Components to be implemented by card extensions.
org.eclipse.keypop.reader.spi - package org.eclipse.keypop.reader.spi: Components to be implemented by end user applications when readers are observed.

P

parseScheduledCardSelectionsResponse(ScheduledCardSelectionsResponse) - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Analyzes the responses provided by a CardReaderEvent following the insertion of a card and the execution of the card selection scenario.
prepareReleaseChannel() - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Requests the closing of the physical channel at the end of the execution of the card selection request.
prepareSelection(CardSelector<?>, CardSelectionExtension) - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Appends a card selection case to the card selection scenario.
PREVIOUS - org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileOccurrence: Previous occurrence.
processCardSelectionScenario(CardReader) - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Explicitly executes a previously prepared card selection scenario and returns the card selection result.

R

ReaderApiFactory - Interface in org.eclipse.keypop.reader: Reader API Factory.
ReaderApiProperties - Class in org.eclipse.keypop.reader: Reader API properties.
ReaderCommunicationException - Exception in org.eclipse.keypop.reader: Indicates that the communication with the reader failed.
ReaderCommunicationException(String) - Constructor for exception org.eclipse.keypop.reader.ReaderCommunicationException
ReaderCommunicationException(String, Throwable) - Constructor for exception org.eclipse.keypop.reader.ReaderCommunicationException
ReaderProtocolNotSupportedException - Exception in org.eclipse.keypop.reader: Indicates that the current card protocol is not supported by the reader.
ReaderProtocolNotSupportedException(String) - Constructor for exception org.eclipse.keypop.reader.ReaderProtocolNotSupportedException
removeObserver(CardReaderObserverSpi) - Method in interface org.eclipse.keypop.reader.ObservableCardReader: Unregisters a reader observer.
REPEATING - org.eclipse.keypop.reader.ObservableCardReader.DetectionMode: Continue waiting for the insertion of a next card.

S

scheduleCardSelectionScenario(ObservableCardReader, ObservableCardReader.NotificationMode) - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Schedules the execution of the prepared card selection scenario as soon as a card is presented to the provided ObservableCardReader.
ScheduledCardSelectionsResponse - Interface in org.eclipse.keypop.reader.selection: Response of the execution of a scheduled selection scenario provided by a CardReaderEvent.
setFileControlInformation(CommonIsoCardSelector.FileControlInformation) - Method in interface org.eclipse.keypop.reader.selection.CommonIsoCardSelector: Sets the file control mode (see ISO7816-4).
setFileOccurrence(CommonIsoCardSelector.FileOccurrence) - Method in interface org.eclipse.keypop.reader.selection.CommonIsoCardSelector: Sets the file occurrence mode (see ISO7816-4).
setMultipleSelectionMode() - Method in interface org.eclipse.keypop.reader.selection.CardSelectionManager: Sets the multiple selection mode to process all selection cases even in case of a successful selection.
setReaderObservationExceptionHandler(CardReaderObservationExceptionHandlerSpi) - Method in interface org.eclipse.keypop.reader.ObservableCardReader: Sets the exception handler.
SINGLESHOT - org.eclipse.keypop.reader.ObservableCardReader.DetectionMode: Stop and wait for a restart signal.
SmartCard - Interface in org.eclipse.keypop.reader.selection.spi: Basic smart card with which communication has been established after a selection process and which is ready to receive APDUs.
startCardDetection(ObservableCardReader.DetectionMode) - Method in interface org.eclipse.keypop.reader.ObservableCardReader: Starts the card detection.
stopCardDetection() - Method in interface org.eclipse.keypop.reader.ObservableCardReader: Stops the card detection.

U

UNAVAILABLE - org.eclipse.keypop.reader.CardReaderEvent.Type: The reader has become unavailable.

V

valueOf(String) - Static method in enum org.eclipse.keypop.reader.CardReaderEvent.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keypop.reader.ObservableCardReader.DetectionMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keypop.reader.ObservableCardReader.NotificationMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileControlInformation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileOccurrence: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.keypop.reader.CardReaderEvent.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keypop.reader.ObservableCardReader.DetectionMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keypop.reader.ObservableCardReader.NotificationMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileControlInformation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keypop.reader.selection.CommonIsoCardSelector.FileOccurrence: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in class org.eclipse.keypop.reader.ReaderApiProperties: API version: "2.0"

A B C D E F G I L M N O P R S U V
All Classes All Packages