Index (Keyple Plugin Java API

A C D G I M O P R S T V W
All Classes All Packages

A

activateProtocol(String) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ConfigurableReaderSpi: Activates a specific protocol in order to make the reader able to communicate with the cards using this protocol.
allocateReader(String) - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginSpi: Obtains an available reader resource and makes it exclusive to the caller until the releaseReader method is invoked.
AutonomousObservablePluginApi - Interface in org.eclipse.keyple.core.plugin: API associated to a AutonomousObservablePluginSpi
AutonomousObservablePluginSpi - Interface in org.eclipse.keyple.core.plugin.spi: Plugin (non pool) having autonomous capabilities to observe reader connections and disconnections.
AutonomousSelectionReaderSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader: Reader having an autonomous mechanism to select the cards (for example OMAPI readers).

C

CardInsertionWaiterAsynchronousApi - Interface in org.eclipse.keyple.core.plugin: API associated to a CardInsertionWaiterAsynchronousSpi
CardInsertionWaiterAsynchronousSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion: This SPI is specifically designed for plugins that handle card insertion asynchronously.
CardInsertionWaiterBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion: This SPI is specifically designed for plugins that handle card insertion synchronously.
CardInsertionWaiterNonBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion: This SPI is specifically designed for plugins that don't handle card insertion autonomously but requires an external active stimulation to detect card insertion without implementing a waiting mechanism.
CardIOException - Exception in org.eclipse.keyple.core.plugin: Indicates that an error occurred while communicating with a card.
CardIOException(String) - Constructor for exception org.eclipse.keyple.core.plugin.CardIOException
CardIOException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.plugin.CardIOException
CardPresenceMonitorBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing: Reader able to detect and notify a card removal during processing, between two APDU commands.
CardRemovalWaiterAsynchronousApi - Interface in org.eclipse.keyple.core.plugin: API associated to a WaitForCardRemovalAutonomousSpi
CardRemovalWaiterAsynchronousSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal: This SPI is specifically designed for plugins that handle card removal asynchronously.
CardRemovalWaiterBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal: This SPI is specifically designed for plugins that handle card removal synchronously.
CardRemovalWaiterNonBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal: This SPI is specifically designed for plugins that don't handle card removal autonomously but requires the sending of an APDU to detect the card removal.
checkCardPresence() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Verifies the presence of a card.
closeLogicalChannel() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.AutonomousSelectionReaderSpi: Closes the logical channel explicitly.
closePhysicalChannel() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Tells the reader that card processing is complete and that the next step is to remove the card from the reader.
ConfigurableReaderSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader: Reader able to manage multiple protocols and which allows the configuration of the protocol to use.
connect(AutonomousObservablePluginApi) - Method in interface org.eclipse.keyple.core.plugin.spi.AutonomousObservablePluginSpi: Deprecated.
Use AutonomousObservablePluginSpi.setCallback(AutonomousObservablePluginApi) instead.
connect(WaitForCardInsertionAutonomousReaderApi) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion.WaitForCardInsertionAutonomousSpi: Deprecated.
connect(WaitForCardRemovalAutonomousReaderApi) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal.WaitForCardRemovalAutonomousSpi: Deprecated.

D

deactivateProtocol(String) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ConfigurableReaderSpi: Deactivates a specific protocol so that the reader ignores cards using this protocol.
DontWaitForCardRemovalDuringProcessingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing: Deprecated.
Useless SPI, don't implement it. Will be removed in a future version of this API.

G

getCardInsertionMonitoringSleepDuration() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion.CardInsertionWaiterNonBlockingSpi: Provides the value of the sleep duration (in milliseconds) inserted between two calls to ReaderSpi.checkCardPresence().
getCardRemovalMonitoringSleepDuration() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal.CardRemovalWaiterNonBlockingSpi: Provides the value of the sleep duration (in milliseconds) inserted between two calls to ReaderSpi.transmitApdu(byte[]).
getCommonApiVersion() - Method in interface org.eclipse.keyple.core.plugin.spi.PluginFactorySpi: Gets the common's API version used at compile time
getCommonApiVersion() - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginFactorySpi: Gets the common's API version used at compile time
getMonitoringCycleDuration() - Method in interface org.eclipse.keyple.core.plugin.spi.ObservablePluginSpi: Gets the recommended time cycle in milliseconds to check the list of current readers.
getName() - Method in interface org.eclipse.keyple.core.plugin.spi.PluginSpi: Gets the name of the plugin.
getName() - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginSpi: Gets the name of the pool plugin.
getName() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Gets the name of the reader.
getPlugin() - Method in interface org.eclipse.keyple.core.plugin.spi.PluginFactorySpi: Retrieves an instance of a plugin SPI (can be a singleton or not)
getPluginApiVersion() - Method in interface org.eclipse.keyple.core.plugin.spi.PluginFactorySpi: Gets the plugin's API version used at compile time
getPluginApiVersion() - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginFactorySpi: Gets the plugin's API version used at compile time
getPluginName() - Method in interface org.eclipse.keyple.core.plugin.spi.PluginFactorySpi: Retrieves the name of the plugin that will be instantiated by this factory (can be static or dynamic)
getPoolPlugin() - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginFactorySpi: Retrieves an instance of a pool plugin SPI (can be a singleton or not)
getPoolPluginName() - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginFactorySpi: Retrieves the name of the pool plugin that will be instantiated by this factory (can be static or dynamic)
getPowerOnData() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Gets the power-on data.
getReaderGroupReferences() - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginSpi: Gets a list of group references that will be used as an argument to PoolPluginSpi.allocateReader(String).
getSelectedSmartCard() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.PoolReaderSpi: Returns the selected smart card when it has been provided by the reader allocation process.

I

isContactless() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Tells if the reader is a contactless type.
isCurrentProtocol(String) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ConfigurableReaderSpi: Tells if the current card communicates with the provided protocol.
isPhysicalChannelOpen() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Tells if the physical channel is open or not.
isProtocolSupported(String) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ConfigurableReaderSpi: Indicates if the provided reader protocol is supported by the reader.

M

monitorCardPresenceDuringProcessing() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing.CardPresenceMonitorBlockingSpi: Monitors the card presence indefinitely (the method is blocking as long as the card is present).

O

ObservablePluginSpi - Interface in org.eclipse.keyple.core.plugin.spi: Plugin (non pool) able to manage a dynamic list of readers and provide the content on request (for example PC/SC).
ObservableReaderSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable: Reader able to detect the insertion and removal of cards.
onCardInserted() - Method in interface org.eclipse.keyple.core.plugin.CardInsertionWaiterAsynchronousApi: Must be invoked when a card is inserted.
onCardInserted() - Method in interface org.eclipse.keyple.core.plugin.WaitForCardInsertionAutonomousReaderApi: Deprecated.
Use CardInsertionWaiterAsynchronousApi.onCardInserted() instead.
onCardRemoved() - Method in interface org.eclipse.keyple.core.plugin.CardRemovalWaiterAsynchronousApi: Must be invoked when a card is removed.
onCardRemoved() - Method in interface org.eclipse.keyple.core.plugin.WaitForCardRemovalAutonomousReaderApi: Deprecated.
Use CardRemovalWaiterAsynchronousApi.onCardRemoved() instead.
onReaderConnected(Set<ReaderSpi>) - Method in interface org.eclipse.keyple.core.plugin.AutonomousObservablePluginApi: Must be invoked when one or more readers are connected to the system.
onReaderDisconnected(Set<String>) - Method in interface org.eclipse.keyple.core.plugin.AutonomousObservablePluginApi: Must be invoked when one or more readers are disconnected from the system.
onStartDetection() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.ObservableReaderSpi: Invoked when the card observation process is started
onStopDetection() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.ObservableReaderSpi: Invoked when the card observation process is stopped
onUnregister() - Method in interface org.eclipse.keyple.core.plugin.spi.PluginSpi: Invoked when unregistering the plugin.
onUnregister() - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginSpi: Invoked when unregistering the plugin.
onUnregister() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Invoked when unregistering the associated plugin.
openChannelForAid(byte[], byte) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.AutonomousSelectionReaderSpi: Opens a logical channel for the provided AID
openPhysicalChannel() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Validates the opening of the physical channel.
org.eclipse.keyple.core.plugin - package org.eclipse.keyple.core.plugin: API provided by Keyple Core.
org.eclipse.keyple.core.plugin.spi - package org.eclipse.keyple.core.plugin.spi: SPI for plugins and factories.
org.eclipse.keyple.core.plugin.spi.reader - package org.eclipse.keyple.core.plugin.spi.reader: SPI for readers.
org.eclipse.keyple.core.plugin.spi.reader.observable - package org.eclipse.keyple.core.plugin.spi.reader.observable: SPI for observable readers.
org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion - package org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion: SPI for the card insertion observation profile definition.
org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing - package org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing: SPI for the card processing observation profile definition.
org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal - package org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal: SPI for the card removal observation profile definition.

P

PluginApiProperties - Class in org.eclipse.keyple.core.plugin: API properties.
PluginFactorySpi - Interface in org.eclipse.keyple.core.plugin.spi: Factory of PluginSpi
PluginIOException - Exception in org.eclipse.keyple.core.plugin: Indicates that an error occurred while managing the readers.
PluginIOException(String) - Constructor for exception org.eclipse.keyple.core.plugin.PluginIOException
PluginIOException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.plugin.PluginIOException
PluginSpi - Interface in org.eclipse.keyple.core.plugin.spi: Plugin (non pool) able to manage a static list of readers.
PoolPluginFactorySpi - Interface in org.eclipse.keyple.core.plugin.spi: Factory of PoolPluginSpi
PoolPluginSpi - Interface in org.eclipse.keyple.core.plugin.spi: Plugin able to manage a dynamic list of readers based on an allocation/de-allocation mechanism (for example HSM).
PoolReaderSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader: Reader extension for pool readers.

R

ReaderIOException - Exception in org.eclipse.keyple.core.plugin: Indicates that an error occurred while communicating with a reader.
ReaderIOException(String) - Constructor for exception org.eclipse.keyple.core.plugin.ReaderIOException
ReaderIOException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.plugin.ReaderIOException
ReaderSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader: Reader able to communicate with smart cards whose purpose is to remain present in the reader (for example a SAM reader).
releaseReader(ReaderSpi) - Method in interface org.eclipse.keyple.core.plugin.spi.PoolPluginSpi: Releases the reader previously allocated with PoolPluginSpi.allocateReader(String) and whose reference is provided.

S

searchAvailableReaderNames() - Method in interface org.eclipse.keyple.core.plugin.spi.ObservablePluginSpi: Enumerates currently available readers and returns their names as a collection of String.
searchAvailableReaders() - Method in interface org.eclipse.keyple.core.plugin.spi.PluginSpi: Enumerates currently available readers.
searchReader(String) - Method in interface org.eclipse.keyple.core.plugin.spi.ObservablePluginSpi: Searches for the reader whose name is provided and returns its ReaderSpi if found, null if not.
setCallback(AutonomousObservablePluginApi) - Method in interface org.eclipse.keyple.core.plugin.spi.AutonomousObservablePluginSpi: Sets the asynchronous callback that will be called when a reader is connected or disconnected.
setCallback(CardInsertionWaiterAsynchronousApi) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion.CardInsertionWaiterAsynchronousSpi: Sets the asynchronous callback that will be called when a card is inserted.
setCallback(CardRemovalWaiterAsynchronousApi) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal.CardRemovalWaiterAsynchronousSpi: Sets the asynchronous callback that will be called when the card removal is complete.
stopCardPresenceMonitoringDuringProcessing() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing.CardPresenceMonitorBlockingSpi: Interrupts the monitoring of the card presence.
stopWaitForCardInsertion() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion.CardInsertionWaiterBlockingSpi: Interrupts the waiting of a card insertion.
stopWaitForCardInsertion() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion.WaitForCardInsertionBlockingSpi: Deprecated.
stopWaitForCardRemoval() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal.CardRemovalWaiterBlockingSpi: Interrupts the waiting of the removal of the card
stopWaitForCardRemoval() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal.WaitForCardRemovalBlockingSpi: Deprecated.
stopWaitForCardRemovalDuringProcessing() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing.WaitForCardRemovalDuringProcessingBlockingSpi: Deprecated.

T

TaskCanceledException - Exception in org.eclipse.keyple.core.plugin: Indicates that a task (for example, waiting for a card to be inserted) has been cancelled and is no longer active.
TaskCanceledException(String) - Constructor for exception org.eclipse.keyple.core.plugin.TaskCanceledException
transmitApdu(byte[]) - Method in interface org.eclipse.keyple.core.plugin.spi.reader.ReaderSpi: Transmits an APDU and returns its response.

V

VERSION - Static variable in class org.eclipse.keyple.core.plugin.PluginApiProperties: API version: "2.3"

W

waitForCardInsertion() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion.CardInsertionWaiterBlockingSpi: Waits indefinitely for a card to be inserted.
waitForCardInsertion() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion.WaitForCardInsertionBlockingSpi: Deprecated.
WaitForCardInsertionAutonomousReaderApi - Interface in org.eclipse.keyple.core.plugin: Deprecated.
Use CardInsertionWaiterAsynchronousApi instead (will be removed in a future version of this API).
WaitForCardInsertionAutonomousSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion: Deprecated.
Implement CardInsertionWaiterAsynchronousSpi instead (will be removed in a future version of this API).
WaitForCardInsertionBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion: Deprecated.
Implement CardInsertionWaiterBlockingSpi instead (will be removed in a future version of this API).
WaitForCardInsertionNonBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.insertion: Deprecated.
Implement CardInsertionWaiterNonBlockingSpi instead (will be removed in a future version of this API).
waitForCardRemoval() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal.CardRemovalWaiterBlockingSpi: Waits indefinitely for a card to be removed.
waitForCardRemoval() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal.WaitForCardRemovalBlockingSpi: Deprecated.
WaitForCardRemovalAutonomousReaderApi - Interface in org.eclipse.keyple.core.plugin: Deprecated.
Use CardRemovalWaiterAsynchronousApi instead (will be removed in a future version of this API).
WaitForCardRemovalAutonomousSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal: Deprecated.
Implement CardRemovalWaiterAsynchronousSpi instead (will be removed in a future version of this API).
WaitForCardRemovalBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal: Deprecated.
Implement CardRemovalWaiterBlockingSpi instead (will be removed in a future version of this API).
waitForCardRemovalDuringProcessing() - Method in interface org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing.WaitForCardRemovalDuringProcessingBlockingSpi: Deprecated.
WaitForCardRemovalDuringProcessingBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.processing: Deprecated.
Useless SPI, don't implement it. Will be removed in a future version of this API.
WaitForCardRemovalNonBlockingSpi - Interface in org.eclipse.keyple.core.plugin.spi.reader.observable.state.removal: Deprecated.
Implement CardRemovalWaiterNonBlockingSpi instead (will be removed in a future version of this API).

A C D G I M O P R S T V W
All Classes All Packages