Skip navigation links
CORE REFERENCE API - 1.0.0
A B C D E F G H I K M N O P R S T U V W 

A

AbstractApduCommandBuilder - Class in org.eclipse.keyple.core.card.command
Generic APDU command builder.
AbstractApduCommandBuilder(CardCommand, ApduRequest) - Constructor for class org.eclipse.keyple.core.card.command.AbstractApduCommandBuilder
(protected)
The generic abstract constructor to build an APDU request with a command reference and a byte array.
AbstractApduResponseParser - Class in org.eclipse.keyple.core.card.command
This abstract class defines the parser used to handle APDU's response.
AbstractApduResponseParser(ApduResponse, AbstractApduCommandBuilder) - Constructor for class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
(protected)
The generic abstract constructor to build a parser of the APDU response.
AbstractApduResponseParser.StatusProperties - Class in org.eclipse.keyple.core.card.command
This internal class provides Status code properties
AbstractCardSelection<T extends AbstractApduCommandBuilder> - Class in org.eclipse.keyple.core.card.selection
This class provide means to create a CardSelectionRequest and analyse its result.
AbstractCardSelection(CardSelector) - Constructor for class org.eclipse.keyple.core.card.selection.AbstractCardSelection
(protected)
Constructor.
AbstractDefaultSelectionsRequest - Class in org.eclipse.keyple.core.service.event
This abstract class defines the POJO used to carry the default selection request data.
AbstractDefaultSelectionsRequest() - Constructor for class org.eclipse.keyple.core.service.event.AbstractDefaultSelectionsRequest
 
AbstractDefaultSelectionsResponse - Class in org.eclipse.keyple.core.service.event
Abstract POJO used to carry the response to a default selection request.
AbstractDefaultSelectionsResponse() - Constructor for class org.eclipse.keyple.core.service.event.AbstractDefaultSelectionsResponse
 
AbstractIso7816CommandBuilder - Class in org.eclipse.keyple.core.card.command
Iso7816 APDU command builder.
AbstractIso7816CommandBuilder(CardCommand, ApduRequest) - Constructor for class org.eclipse.keyple.core.card.command.AbstractIso7816CommandBuilder
(protected)
Abstract constructor to build a command with a command reference and an ApduRequest.
AbstractLocalReader - Class in org.eclipse.keyple.core.plugin
Implements the methods defined by the ProxyReader interface for a local reader.
AbstractLocalReader(String, String) - Constructor for class org.eclipse.keyple.core.plugin.AbstractLocalReader
(protected)
Constructor.
AbstractObservableLocalAutonomousReader - Class in org.eclipse.keyple.core.plugin
Extends AbstractObservableLocalReader to allow the reader implementation to call back the core when card insertion and removal events occur.
AbstractObservableLocalAutonomousReader(String, String) - Constructor for class org.eclipse.keyple.core.plugin.AbstractObservableLocalAutonomousReader
AbstractObservableLocalReader - Class in org.eclipse.keyple.core.plugin
Extends AbstractLocalReader to manage the observation of card events.
AbstractObservableLocalReader(String, String) - Constructor for class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
(protected)
Constructor.
AbstractObservableLocalReader.InternalEvent - Enum in org.eclipse.keyple.core.plugin
Internal events
AbstractObservablePlugin - Class in org.eclipse.keyple.core.plugin
Provides the means to manage the observation of a plugin.
AbstractObservablePlugin(String) - Constructor for class org.eclipse.keyple.core.plugin.AbstractObservablePlugin
Constructor.
AbstractPlugin - Class in org.eclipse.keyple.core.plugin
This class define the common API for all plugins.
AbstractPlugin(String) - Constructor for class org.eclipse.keyple.core.plugin.AbstractPlugin
Instantiates a new Plugin.
AbstractReader - Class in org.eclipse.keyple.core.plugin
Implements the ProxyReader high-level interface.
AbstractReader(String, String) - Constructor for class org.eclipse.keyple.core.plugin.AbstractReader
Constructor.
AbstractSmartCard - Class in org.eclipse.keyple.core.card.selection
AbstractSmartCard is the class to manage the elements of the result of a selection.
AbstractSmartCard(CardSelectionResponse) - Constructor for class org.eclipse.keyple.core.card.selection.AbstractSmartCard
Constructor.
AbstractThreadedObservablePlugin - Class in org.eclipse.keyple.core.plugin
Provides the means to observe a plugin (insertion/removal of readers) using a monitoring thread.
AbstractThreadedObservablePlugin(String) - Constructor for class org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin
Instantiates a threaded observable plugin.
activateProtocol(String, String) - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Activates the provided card protocol and assigns it a name.
activateProtocol(String, String) - Method in interface org.eclipse.keyple.core.service.Reader
Activates the provided card protocol and assigns it a name.
activateReaderProtocol(String) - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Activates the protocol provided from the reader's implementation point of view.
addCommandBuilder(T) - Method in class org.eclipse.keyple.core.card.selection.AbstractCardSelection
Add an additional AbstractApduCommandBuilder for the command to be executed after the selection process if it succeeds.
addObserver(ObservableReader.ReaderObserver) - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Add a ObservableReader.ReaderObserver.
addObserver(ObservablePlugin.PluginObserver) - Method in class org.eclipse.keyple.core.plugin.AbstractObservablePlugin
Register a new plugin observer to be notified when a plugin event occurs.
addObserver(ObservablePlugin.PluginObserver) - Method in class org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin
Add a plugin observer.
addObserver(ObservablePlugin.PluginObserver) - Method in interface org.eclipse.keyple.core.service.event.ObservablePlugin
Register a new plugin observer to be notified when a plugin event occurs.
addObserver(ObservableReader.ReaderObserver) - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Register a new reader observer to be notified when a reader event occurs.
addSubName(String) - Method in class org.eclipse.keyple.core.card.command.AbstractApduCommandBuilder
Appends a string to the current name.
addSuccessfulStatusCode(int) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
Add as status code to be accepted to the list of successful selection status codes
AID_MAX_LENGTH - Static variable in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
 
AID_MIN_LENGTH - Static variable in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
 
aidSelector(CardSelector.AidSelector) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.CardSelectorBuilder
Sets the card AID Selector
aidToSelect(byte[]) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.AidSelectorBuilder
Sets the AID
aidToSelect(String) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.AidSelectorBuilder
Sets the AID
allocateReader(String) - Method in interface org.eclipse.keyple.core.service.PoolPlugin
Obtains an available Reader resource and makes it exclusive to the caller until the releaseReader method is called.
AnswerToReset - Class in org.eclipse.keyple.core.card.message
This POJO carries the data retrieved from the card after the power on sequence.
AnswerToReset(byte[]) - Constructor for class org.eclipse.keyple.core.card.message.AnswerToReset
Build from a byte array containing the power on data.
ApduRequest - Class in org.eclipse.keyple.core.card.message
This POJO wraps a data set related to an ISO-7816 APDU.
ApduRequest(byte[], boolean) - Constructor for class org.eclipse.keyple.core.card.message.ApduRequest
Constructor.
ApduResponse - Class in org.eclipse.keyple.core.card.message
This POJO wraps the card's response to an ApduRequest.
ApduResponse(byte[], Set<Integer>) - Constructor for class org.eclipse.keyple.core.card.message.ApduResponse
Constructor.
APPLICATION - Static variable in class org.eclipse.keyple.core.util.bertlv.Tag
 
Assert - Class in org.eclipse.keyple.core.util
Exposes useful methods for testing method call parameters and raising a IllegalArgumentException unchecked exception.
AtrFilter(String) - Constructor for class org.eclipse.keyple.core.card.selection.CardSelector.AtrFilter
Regular expression based filter
atrFilter(CardSelector.AtrFilter) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.CardSelectorBuilder
Sets the card ATR Filter
atrMatches(byte[]) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AtrFilter
Tells if the provided ATR matches the registered regular expression

B

BodyError - Class in org.eclipse.keyple.core.util.json
POJO used to transports the content of a RuntimeException into a String
BodyError(RuntimeException) - Constructor for class org.eclipse.keyple.core.util.json.BodyError
Builds an instance from an exception reference.
BodyErrorJsonSerializer - Class in org.eclipse.keyple.core.util.json
Serializer of a BodyError that contains a RuntimeException.
BodyErrorJsonSerializer() - Constructor for class org.eclipse.keyple.core.util.json.BodyErrorJsonSerializer
 
build() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.AidSelectorBuilder
Build a new AidSelector.
build() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.CardSelectorBuilder
Build a new CardSelector.
buildCommandException(Class<? extends KeypleCardCommandException>, String, CardCommand, Integer) - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
Builds a command exception.
builder - Variable in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
Parsers are usually created by their associated builder.
builder() - Static method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
Gets a new builder.
builder() - Static method in class org.eclipse.keyple.core.card.selection.CardSelector
Gets a new builder.
ByteArrayJsonAdapter - Class in org.eclipse.keyple.core.util.json
Serializer/Deserializer of a byte array to an hex string.
ByteArrayJsonAdapter() - Constructor for class org.eclipse.keyple.core.util.json.ByteArrayJsonAdapter
 
ByteArrayUtil - Class in org.eclipse.keyple.core.util
Utils around byte arrays

C

CardCommand - Interface in org.eclipse.keyple.core.card.command
Provides the API to get CardCommand's name and instruction byte (INS).
CardCommandJsonAdapter - Class in org.eclipse.keyple.core.util.json
Serializer/Deserializer of a CardCommand.
CardCommandJsonAdapter() - Constructor for class org.eclipse.keyple.core.util.json.CardCommandJsonAdapter
 
cardProtocol(String) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.CardSelectorBuilder
Sets the card protocol.
CardRequest - Class in org.eclipse.keyple.core.card.message
This POJO wraps a list of APDUs to be sent to a card for which the logical channel has already been opened.
CardRequest(List<ApduRequest>) - Constructor for class org.eclipse.keyple.core.card.message.CardRequest
Constructor.
CardResource<T extends AbstractSmartCard> - Class in org.eclipse.keyple.core.card.selection
The CardResource class groups a AbstractSmartCard and its associated Reader
CardResource(Reader, T) - Constructor for class org.eclipse.keyple.core.card.selection.CardResource
Constructor
CardResponse - Class in org.eclipse.keyple.core.card.message
This POJO wraps the data from a card obtained in response to a CardRequest.
CardResponse(boolean, List<ApduResponse>) - Constructor for class org.eclipse.keyple.core.card.message.CardResponse
Constructor.
CardSelectionRequest - Class in org.eclipse.keyple.core.card.message
This POJO, combining a CardSelector and a CardRequest, is used to define a selection case.
CardSelectionRequest(CardSelector) - Constructor for class org.eclipse.keyple.core.card.message.CardSelectionRequest
Constructor.
CardSelectionRequest(CardSelector, CardRequest) - Constructor for class org.eclipse.keyple.core.card.message.CardSelectionRequest
Constructor.
CardSelectionResponse - Class in org.eclipse.keyple.core.card.message
This POJO wraps the data from a card obtained in response to a CardSelectionRequest.
CardSelectionResponse(SelectionStatus, CardResponse) - Constructor for class org.eclipse.keyple.core.card.message.CardSelectionResponse
Constructor.
CardSelectionsResult - Class in org.eclipse.keyple.core.card.selection
Contains the result of a selection process.
CardSelectionsService - Class in org.eclipse.keyple.core.card.selection
Provides the means to prepare and execute a card selection.
CardSelectionsService(MultiSelectionProcessing) - Constructor for class org.eclipse.keyple.core.card.selection.CardSelectionsService
Constructor.
CardSelectionsService() - Constructor for class org.eclipse.keyple.core.card.selection.CardSelectionsService
Alternate constructor for standard usages.
cardSelector - Variable in class org.eclipse.keyple.core.card.selection.AbstractCardSelection
 
CardSelector - Class in org.eclipse.keyple.core.card.selection
This POJO holds the information needed to select a particular card.
CardSelector(CardSelector.CardSelectorBuilder) - Constructor for class org.eclipse.keyple.core.card.selection.CardSelector
Protected constructor
CardSelector.AidSelector - Class in org.eclipse.keyple.core.card.selection
Holds the AID selection data.
CardSelector.AidSelector.AidSelectorBuilder - Class in org.eclipse.keyple.core.card.selection
CardSelector.AidSelector.FileControlInformation - Enum in org.eclipse.keyple.core.card.selection
FileControlInformation indicates how to which template is expected in accordance with ISO7816-4
CardSelector.AidSelector.FileOccurrence - Enum in org.eclipse.keyple.core.card.selection
FileOccurrence indicates how to carry out the file occurrence in accordance with ISO7816-4
CardSelector.AtrFilter - Class in org.eclipse.keyple.core.card.selection
Static nested class to hold the data elements used to perform an ATR based filtering
CardSelector.CardSelectorBuilder - Class in org.eclipse.keyple.core.card.selection
Create a CardSelector to perform the card selection
CardSelectorBuilder() - Constructor for class org.eclipse.keyple.core.card.selection.CardSelector.CardSelectorBuilder
Protected constructor
ChannelControl - Enum in org.eclipse.keyple.core.card.message
Indicates the action to be taken on the physical channel at the end of the transmission of the request.
checkCardPresence() - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Wrapper for the native method of the plugin specific local reader to verify the presence of the card.
checkStatus() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
This method check the status code.
If status code is not referenced, then status is considered unsuccessful.
clearObservers() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Remove all observers at once
clearObservers() - Method in class org.eclipse.keyple.core.plugin.AbstractObservablePlugin
Unregister all observers at once.
clearObservers() - Method in class org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin
Remove all observers at once
clearObservers() - Method in interface org.eclipse.keyple.core.service.event.ObservablePlugin
Unregister all observers at once.
clearObservers() - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Unregister all observers at once
closeLogicalChannel() - Method in interface org.eclipse.keyple.core.plugin.SmartSelectionReader
Closes the logical channel explicitly.
closePhysicalChannel() - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Attempts to close the current physical channel.
commandRef - Variable in class org.eclipse.keyple.core.card.command.AbstractApduCommandBuilder
The reference field CardCommand is used to find the type of command concerned when manipulating a list of abstract builder objects.
ContactCardCommonProtocols - Enum in org.eclipse.keyple.core.service.util
This enum contains a non-exhaustive list of contacts smartcard communication protocols.
ContactlessCardCommonProtocols - Enum in org.eclipse.keyple.core.service.util
This enum contains a non-exhaustive list of contactless smartcard communication protocols.
CONTEXT - Static variable in class org.eclipse.keyple.core.util.bertlv.Tag
 
countObservers() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Gets the number of observers.
countObservers() - Method in class org.eclipse.keyple.core.plugin.AbstractObservablePlugin
Provides the current number of registered observers.
countObservers() - Method in interface org.eclipse.keyple.core.service.event.ObservablePlugin
Provides the current number of registered observers.
countObservers() - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Provides the current number of registered observers

D

deactivateProtocol(String) - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Deactivates the provided card protocol.
deactivateProtocol(String) - Method in interface org.eclipse.keyple.core.service.Reader
Deactivates the provided card protocol.
deactivateReaderProtocol(String) - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Deactivates the protocol provided from the reader's implementation point of view.
DefaultSelectionsRequest - Class in org.eclipse.keyple.core.card.message
This POJO defines the default selection request to be processed when a card is inserted in an observable reader.
DefaultSelectionsRequest(List<CardSelectionRequest>, MultiSelectionProcessing, ChannelControl) - Constructor for class org.eclipse.keyple.core.card.message.DefaultSelectionsRequest
Builds a DefaultSelectionsRequest from a list of selection cases and two enum constants guiding the expected behaviour of the selection process.
DefaultSelectionsResponse - Class in org.eclipse.keyple.core.card.message
This POJO wraps the default selections responses in return to the default selections made when a card is inserted.
DefaultSelectionsResponse(List<CardSelectionResponse>) - Constructor for class org.eclipse.keyple.core.card.message.DefaultSelectionsResponse
Builds a DefaultSelectionsResponse from the list of CardSelectionResponse received from the reader during the selection process.
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class org.eclipse.keyple.core.util.json.BodyErrorJsonSerializer
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class org.eclipse.keyple.core.util.json.ByteArrayJsonAdapter
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class org.eclipse.keyple.core.util.json.CardCommandJsonAdapter
DontWaitForCardRemovalDuringProcessing - Interface in org.eclipse.keyple.core.plugin
Interface to be implemented by readers not able to detect a card removal during processing, between two APDU commands.

E

equals(Object) - Method in class org.eclipse.keyple.core.card.message.AnswerToReset
 
equals(Object) - Method in class org.eclipse.keyple.core.card.message.ApduResponse
 
equals(Object) - Method in class org.eclipse.keyple.core.card.message.CardResponse
 
equals(Object) - Method in class org.eclipse.keyple.core.card.message.CardSelectionResponse
 
equals(Object) - Method in class org.eclipse.keyple.core.card.message.SelectionStatus
 
equals(Object) - Method in class org.eclipse.keyple.core.util.bertlv.Tag
 

F

fetchNativeReader(String) - Method in class org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin
Fetch connected native reader (from third party library) by its name Returns the current AbstractReader if it is already listed.
fetchNativeReadersNames() - Method in class org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin
Fetch the list of connected native reader (usually from third party library) and returns their names (or id)
fileControlInformation(CardSelector.AidSelector.FileControlInformation) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.AidSelectorBuilder
Sets the file control mode (see ISO7816-4)
fileOccurrence(CardSelector.AidSelector.FileOccurrence) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.AidSelectorBuilder
Sets the file occurence mode (see ISO7816-4)
finalizeCardProcessing() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Terminates the processing of the card, in particular after an interruption by exception
Do nothing if the channel is already closed.
Channel closing is nominally managed by using the ChannelControl.CLOSE_AFTER flag during the last transmission with the card.
finalizeCardProcessing() - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Terminates the processing of the card, in particular after an interruption by exception
Do nothing if the channel is already closed.
Channel closing is nominally managed by using the ChannelControl.CLOSE_AFTER flag during the last transmission with the card.
fourBytesToInt(byte[], int) - Static method in class org.eclipse.keyple.core.util.ByteArrayUtil
Convert four bytes from a byte array into an integer.
fromHex(String) - Static method in class org.eclipse.keyple.core.util.ByteArrayUtil
Create a byte array from an hexa string.

G

getActiveSelectionIndex() - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsResult
Gets the index of the active selection
getActiveSmartCard() - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsResult
Get the active matching card.
getAidSelector() - Method in class org.eclipse.keyple.core.card.selection.CardSelector
Gets the AID selector
getAidToSelect() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
Getter for the AID provided at construction time
getApduRequest() - Method in class org.eclipse.keyple.core.card.command.AbstractApduCommandBuilder
Gets ApduRequest the request
getApduRequests() - Method in class org.eclipse.keyple.core.card.message.CardRequest
Gets the list of ApduRequest.
getApduResponse() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
getApduResponses() - Method in class org.eclipse.keyple.core.card.message.CardResponse
Gets the apdu responses.
getAtr() - Method in class org.eclipse.keyple.core.card.message.SelectionStatus
Gets the ATR coming from the card.
getATR() - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
This abstract method must be implemented by the derived class in order to provide the information retrieved when powering up the card.
getAtrBytes() - Method in class org.eclipse.keyple.core.card.selection.AbstractSmartCard
Gets the ATR
getAtrFilter() - Method in class org.eclipse.keyple.core.card.selection.CardSelector
Gets the ATR filter
getAtrRegex() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AtrFilter
Getter for the regular expression provided at construction time
getBuilder() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
Gets AbstractApduCommandBuilder, the associated builder reference
getBytes() - Method in class org.eclipse.keyple.core.card.message.AnswerToReset
Gets the data
getBytes() - Method in class org.eclipse.keyple.core.card.message.ApduRequest
Gets the APDU bytes to send to the card.
getBytes() - Method in class org.eclipse.keyple.core.card.message.ApduResponse
Gets all the data received from the card including SW1SW2.
getCardProtocol() - Method in class org.eclipse.keyple.core.card.selection.CardSelector
Gets the card protocol name.
getCardRequest() - Method in class org.eclipse.keyple.core.card.message.CardSelectionRequest
Gets the CardRequest
getCardResponse() - Method in class org.eclipse.keyple.core.card.message.CardSelectionResponse
Gets the apdu responses.
getCardResponse() - Method in exception org.eclipse.keyple.core.service.exception.KeypleReaderIOException
 
getCardSelectionRequests() - Method in class org.eclipse.keyple.core.card.message.DefaultSelectionsRequest
Gets the list of selection cases provided in the default selection
getCardSelectionRequests() - Method in class org.eclipse.keyple.core.service.event.AbstractDefaultSelectionsRequest
Gets the list of selection cases provided in the default selection
getCardSelectionResponses() - Method in class org.eclipse.keyple.core.card.message.DefaultSelectionsResponse
Gets the result of the selection as a list of responses corresponding to the requests made in AbstractDefaultSelectionsRequest.
getCardSelectionResponses() - Method in class org.eclipse.keyple.core.service.event.AbstractDefaultSelectionsResponse
Gets the result of the selection as a list of responses corresponding to the requests made in AbstractDefaultSelectionsRequest.
getCardSelectionResponses() - Method in exception org.eclipse.keyple.core.service.exception.KeypleReaderIOException
 
getCardSelector() - Method in class org.eclipse.keyple.core.card.message.CardSelectionRequest
Gets the CardSelector
getCardSelector() - Method in class org.eclipse.keyple.core.card.selection.AbstractCardSelection
 
getChannelControl() - Method in class org.eclipse.keyple.core.card.message.DefaultSelectionsRequest
Gets the indication whether the logic channel is to be kept open or closed
getChannelControl() - Method in class org.eclipse.keyple.core.service.event.AbstractDefaultSelectionsRequest
Gets the indication whether the logic channel is to be kept open or closed
getCode() - Method in class org.eclipse.keyple.core.util.json.BodyError
Gets the exception class name.
getCommand() - Method in exception org.eclipse.keyple.core.card.command.exception.KeypleCardCommandException
Gets the command
getCommandBuilders() - Method in class org.eclipse.keyple.core.card.selection.AbstractCardSelection
Gets the list of command builders.
getCommandRef() - Method in class org.eclipse.keyple.core.card.command.AbstractApduCommandBuilder
Gets CardCommand the current command identification
getCommandRef() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
Gets the associated command reference.
By default, the command reference is retrieved from the associated builder.
getDataOut() - Method in class org.eclipse.keyple.core.card.message.ApduResponse
Get the data received from the card excluding SW1SW2.
getDefaultSelectionsRequest() - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsService
The SelectionOperation is the AbstractDefaultSelectionsRequest to process in ordered to select a card among others through the selection process.
getDefaultSelectionsResponse() - Method in class org.eclipse.keyple.core.service.event.ReaderEvent
Gets the default selection response that may be present when the event is ReaderEvent.EventType.CARD_INSERTED, always present when the event is ReaderEvent.EventType.CARD_MATCHED and null in the others cases.
getEventType() - Method in class org.eclipse.keyple.core.service.event.PluginEvent
Gets the plugin event type.
getEventType() - Method in class org.eclipse.keyple.core.service.event.ReaderEvent
Gets the reader event type.
getException() - Method in class org.eclipse.keyple.core.util.json.BodyError
Gets the associated runtime exception.
getExceptionClass() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser.StatusProperties
Gets Exception Class
getFci() - Method in class org.eclipse.keyple.core.card.message.SelectionStatus
Gets the ApduResponse from the card to the Selection Application command.
getFciBytes() - Method in class org.eclipse.keyple.core.card.selection.AbstractSmartCard
Gets the FCI
getFileControlInformation() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
 
getFileOccurrence() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
 
getInformation() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser.StatusProperties
Gets information
getInstance() - Static method in class org.eclipse.keyple.core.service.SmartCardService
Gets the single instance of SmartCardService.
getInstance() - Static method in class org.eclipse.keyple.core.util.Assert
Gets the unique instance.
getInstructionByte() - Method in interface org.eclipse.keyple.core.card.command.CardCommand
Gets Instruction Byte (INS)
getIsoBitMask() - Method in enum org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.FileControlInformation
 
getIsoBitMask() - Method in enum org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.FileOccurrence
 
getMultiSelectionProcessing() - Method in class org.eclipse.keyple.core.card.message.DefaultSelectionsRequest
Gets the indication whether the selection process should stop after the first matching case or process all of them.
getMultiSelectionProcessing() - Method in class org.eclipse.keyple.core.service.event.AbstractDefaultSelectionsRequest
Gets the indication whether the selection process should stop after the first matching case or process all of them.
getName() - Method in class org.eclipse.keyple.core.card.command.AbstractApduCommandBuilder
Gets the name of this APDU command if it has been allowed by the log level (see constructor).
getName() - Method in interface org.eclipse.keyple.core.card.command.CardCommand
Gets command's name.
getName() - Method in class org.eclipse.keyple.core.card.message.ApduRequest
Gets the name of this APDU request if it has been defined (see setName).
getName() - Method in class org.eclipse.keyple.core.plugin.AbstractPlugin
Gets the name of the plugin
getName() - Method in class org.eclipse.keyple.core.plugin.AbstractReader
Gets the name of the reader.
getName() - Method in interface org.eclipse.keyple.core.service.Plugin
Gets the name of the plugin
getName() - Method in interface org.eclipse.keyple.core.service.Reader
Gets the name of the reader
getObservationExceptionHandler() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Allows to call the defined handler when an exception condition needs to be transmitted to the application level.
getObservationExceptionHandler() - Method in class org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin
Allows to call the defined handler when an exception condition needs to be transmitted to the application level.
getParser() - Static method in class org.eclipse.keyple.core.util.json.KeypleGsonParser
Gets the singleton instance of the parser.
getPlugin() - Method in class org.eclipse.keyple.core.service.event.ReaderEvent
Gets the Plugin from which the reader that generated the event comes from.
getPlugin() - Method in interface org.eclipse.keyple.core.service.PluginFactory
Retrieve an instance of a plugin (can be a singleton or not)
getPlugin(String) - Method in class org.eclipse.keyple.core.service.SmartCardService
Gets the plugin whose name is provided as an argument.
getPluginName() - Method in class org.eclipse.keyple.core.plugin.AbstractReader
Gets the name of plugin provided in the constructor.
getPluginName() - Method in class org.eclipse.keyple.core.service.event.PluginEvent
Gets the name of the plugin to which the reader that generated the event belongs.
getPluginName() - Method in class org.eclipse.keyple.core.service.event.ReaderEvent
Gets the name of the plugin from which the reader that generated the event comes from
getPluginName() - Method in interface org.eclipse.keyple.core.service.PluginFactory
Retrieve the name of the plugin that will be instantiated by this factory (can be static or dynamic)
getPlugins() - Method in class org.eclipse.keyple.core.service.SmartCardService
Gets the plugins.
getPosition() - Method in class org.eclipse.keyple.core.util.bertlv.TLV
Gets the current position in the main array
getReader() - Method in class org.eclipse.keyple.core.card.selection.CardResource
Gets the reader
getReader(String) - Method in class org.eclipse.keyple.core.plugin.AbstractPlugin
Gets a specific reader designated by its name in the current readers list
getReader() - Method in class org.eclipse.keyple.core.service.event.ReaderEvent
Gets the Reader from which generated event comes from
getReader(String) - Method in interface org.eclipse.keyple.core.service.Plugin
Gets the reader whose name is provided as an argument
getReaderGroupReferences() - Method in interface org.eclipse.keyple.core.service.PoolPlugin
Gets a list of group references that will be used as an argument to allocateReader.
getReaderName() - Method in class org.eclipse.keyple.core.service.event.ReaderEvent
Gets the name of the reader that generated the event comes from
getReaderNames() - Method in class org.eclipse.keyple.core.plugin.AbstractPlugin
Returns the current list of reader names.
getReaderNames() - Method in class org.eclipse.keyple.core.service.event.PluginEvent
Gets the names of the readers related to the event in the form of a sorted set.
getReaderNames() - Method in interface org.eclipse.keyple.core.service.Plugin
Gets the list of names of all readers
getReaders() - Method in class org.eclipse.keyple.core.plugin.AbstractPlugin
Returns the current readers name instance map.
getReaders() - Method in interface org.eclipse.keyple.core.service.Plugin
Gets the readers.
getSelectionStatus() - Method in class org.eclipse.keyple.core.card.message.CardSelectionResponse
Gets the selection status.
getSmartCard() - Method in class org.eclipse.keyple.core.card.selection.CardResource
Gets the card
getSmartCard(int) - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsResult
Gets the AbstractSmartCard for the specified index.
getSmartCards() - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsResult
Gets all the AbstractSmartCard corresponding to all selection cases in a map where the key is the selection index.
getStatusCode() - Method in exception org.eclipse.keyple.core.card.command.exception.KeypleCardCommandException
Gets the status code
getStatusCode() - Method in class org.eclipse.keyple.core.card.message.ApduResponse
Gets the status code SW1SW2 of the APDU.
getStatusInformation() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
Gets he ASCII message from the statusTable for the current status code.
getStatusTable() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
Returns the internal status table
getSuccessfulSelectionStatusCodes() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
Gets the list of successful selection status codes
getSuccessfulStatusCodes() - Method in class org.eclipse.keyple.core.card.message.ApduRequest
Get the list of valid status codes for the request.
getTagClass() - Method in class org.eclipse.keyple.core.util.bertlv.Tag
Gets the tag class
getTagNumber() - Method in class org.eclipse.keyple.core.util.bertlv.Tag
Gets the tag number
getTagSize() - Method in class org.eclipse.keyple.core.util.bertlv.Tag
Gets the tag size
getTagType() - Method in class org.eclipse.keyple.core.util.bertlv.Tag
Gets the tag type
getValue() - Method in class org.eclipse.keyple.core.util.bertlv.TLV
Return a byte array copied from the main array corresponding to value part of the last TLV parsing.
getVersion() - Method in class org.eclipse.keyple.core.service.SmartCardService
Gets the version API, (the version of the sdk).
greaterOrEqual(Integer, int, String) - Method in class org.eclipse.keyple.core.util.Assert
Assert that an integer is not null and is greater than or equal to minValue.

H

hasActiveSelection() - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsResult
Tells if the current selection process resulted in an active selection.
hasAtr() - Method in class org.eclipse.keyple.core.card.selection.AbstractSmartCard
Tells if the card provided an ATR
hasFci() - Method in class org.eclipse.keyple.core.card.selection.AbstractSmartCard
Tells if the card provided a FCI
hashCode() - Method in class org.eclipse.keyple.core.card.message.AnswerToReset
 
hashCode() - Method in class org.eclipse.keyple.core.card.message.ApduResponse
 
hashCode() - Method in class org.eclipse.keyple.core.card.message.CardResponse
 
hashCode() - Method in class org.eclipse.keyple.core.card.message.CardSelectionResponse
 
hashCode() - Method in class org.eclipse.keyple.core.card.message.SelectionStatus
 
hashCode() - Method in class org.eclipse.keyple.core.util.bertlv.Tag
 
hasMatched() - Method in class org.eclipse.keyple.core.card.message.SelectionStatus
Tells if the selection process has been successful.
hasSelectionMatched(int) - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsResult
Get the matching status of a selection case for which the index is provided.

I

initNativeReaders() - Method in class org.eclipse.keyple.core.plugin.AbstractPlugin
Init connected native readers (from third party library) and returns a map of corresponding Reader with their name as key.
isCardPresent() - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Check the presence of a card
isCardPresent() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Check the presence of a card
isCardPresent() - Method in interface org.eclipse.keyple.core.service.Reader
Checks if is the card present.
isCase4() - Method in class org.eclipse.keyple.core.card.message.ApduRequest
Indicates if the APDU is type 4.
isContactless() - Method in interface org.eclipse.keyple.core.service.Reader
Tells if the current card communication is contactless.
isCurrentProtocol(String) - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Tells if the current card communicates with the protocol provided as an argument.
isEqual(Integer, int, String) - Method in class org.eclipse.keyple.core.util.Assert
Assert that an integer is equal to value.
isInRange(Integer, int, int, String) - Method in class org.eclipse.keyple.core.util.Assert
Assert that an integer is not null and is in the range minValue, maxValue.
isLogicalChannelOpen() - Method in class org.eclipse.keyple.core.card.message.CardResponse
Get the logical channel status
isPhysicalChannelOpen() - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Tells if the physical channel is open or not.
isRegistered - Variable in class org.eclipse.keyple.core.plugin.AbstractReader
Registeration status of the reader
isRegistered(String) - Method in class org.eclipse.keyple.core.service.SmartCardService
Check weither a plugin is already registered to the platform or not
isSuccessful() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
Gets true if the status is successful from the statusTable according to the current status code.
isSuccessful() - Method in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser.StatusProperties
Gets successful indicator
isSuccessful() - Method in class org.eclipse.keyple.core.card.message.ApduResponse
Tells if the current APDU is successful or not.
isTrue(Boolean, String) - Method in class org.eclipse.keyple.core.util.Assert
Assert that a condition is true.

K

KeypleAllocationNoReaderException - Exception in org.eclipse.keyple.core.service.exception
Indicates that no reader were available during allocation invocation.
KeypleAllocationNoReaderException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleAllocationNoReaderException
 
KeypleAllocationNoReaderException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleAllocationNoReaderException
 
KeypleAllocationReaderException - Exception in org.eclipse.keyple.core.service.exception
Indicates that a reader allocation failed.
KeypleAllocationReaderException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleAllocationReaderException
 
KeypleAllocationReaderException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleAllocationReaderException
Encapsulates a lower level reader exception
KeypleCardCommandException - Exception in org.eclipse.keyple.core.card.command.exception
This exception is the parent abstract class of all Keyple card APDU commands exceptions.
KeypleCardCommandException(String, CardCommand, Integer) - Constructor for exception org.eclipse.keyple.core.card.command.exception.KeypleCardCommandException
Constructor allowing to set the error message and the reference to the command
KeypleCardCommandExceptionJsonSerializer - Class in org.eclipse.keyple.core.util.json
KeypleCardCommandExceptionJsonSerializer() - Constructor for class org.eclipse.keyple.core.util.json.KeypleCardCommandExceptionJsonSerializer
 
KeypleCardCommandUnknownStatusException - Exception in org.eclipse.keyple.core.card.command.exception
This exception indicates that the status code is not referenced.
KeypleCardCommandUnknownStatusException(String, CardCommand, Integer) - Constructor for exception org.eclipse.keyple.core.card.command.exception.KeypleCardCommandUnknownStatusException
Constructor allowing to set a message, the command and the status code.
KeypleException - Exception in org.eclipse.keyple.core.service.exception
The exception KeypleException is the parent abstract class of all Keyple checked exceptions.
KeypleException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleException
 
KeypleException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleException
Encapsulate a lower level exception (ie CardException, IOException, HostNotFoundException..)
KeypleGsonParser - Class in org.eclipse.keyple.core.util.json
GSON Parser of Keyple objects.
KeyplePluginException - Exception in org.eclipse.keyple.core.service.exception
The exception KeyplePluginException is the parent abstract class of all Keyple plugins exceptions.
KeyplePluginException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeyplePluginException
 
KeyplePluginException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.service.exception.KeyplePluginException
Encapsulates a lower level plugin exception
KeyplePluginInstantiationException - Exception in org.eclipse.keyple.core.service.exception
Indicates that the plugin cannot be instantiated, possibly due to a problem with one of the associated readers.
KeyplePluginInstantiationException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeyplePluginInstantiationException
 
KeyplePluginInstantiationException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.service.exception.KeyplePluginInstantiationException
Encapsulates a lower level plugin exception
KeyplePluginNotFoundException - Exception in org.eclipse.keyple.core.service.exception
Indicates that the plugin is not found, generally when it has not been previously registered to the SmartCardService.
KeyplePluginNotFoundException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeyplePluginNotFoundException
 
KeypleReaderException - Exception in org.eclipse.keyple.core.service.exception
The exception KeypleReaderException is the parent abstract class of all Keyple reader exceptions.
KeypleReaderException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleReaderException
 
KeypleReaderException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleReaderException
Encapsulates a lower level reader exception
KeypleReaderIOException - Exception in org.eclipse.keyple.core.service.exception
Indicates that some IO operations with the reader or the card have failed, generally when the reader was disconnected or card removed.
KeypleReaderIOException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleReaderIOException
 
KeypleReaderIOException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleReaderIOException
Encapsulates a lower level reader exception
KeypleReaderIOExceptionJsonSerializer - Class in org.eclipse.keyple.core.util.json
Serializer of a KeypleReaderIOException.
KeypleReaderIOExceptionJsonSerializer() - Constructor for class org.eclipse.keyple.core.util.json.KeypleReaderIOExceptionJsonSerializer
 
KeypleReaderNotFoundException - Exception in org.eclipse.keyple.core.service.exception
Indicates that the reader is not found by its name, generally when it is not connected to the terminal.
KeypleReaderNotFoundException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleReaderNotFoundException
 
KeypleReaderProtocolNotFoundException - Exception in org.eclipse.keyple.core.service.exception
Indicates that the current card protocol is undetermined.
KeypleReaderProtocolNotFoundException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleReaderProtocolNotFoundException
 
KeypleReaderProtocolNotSupportedException - Exception in org.eclipse.keyple.core.service.exception
Indicates that the current card protocol is not supported by the plugin.
KeypleReaderProtocolNotSupportedException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleReaderProtocolNotSupportedException
 
KeypleRuntimeException - Exception in org.eclipse.keyple.core.service.exception
 
KeypleRuntimeException(String) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleRuntimeException
 
KeypleRuntimeException(String, Throwable) - Constructor for exception org.eclipse.keyple.core.service.exception.KeypleRuntimeException
 

M

MultiSelectionProcessing - Enum in org.eclipse.keyple.core.card.selection
Indicates whether the selection process should stop after the first matching or process all requests in the CardSelectionRequest list.

N

notEmpty(String, String) - Method in class org.eclipse.keyple.core.util.Assert
Assert that the input string is not null and not empty.
notEmpty(List<? extends Object>, String) - Method in class org.eclipse.keyple.core.util.Assert
Assert that a list of objects is not null and not empty.
notEmpty(byte[], String) - Method in class org.eclipse.keyple.core.util.Assert
Assert that a byte array is not null and not empty.
notifyObservers(ReaderEvent) - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Notify all registered observers with the provided ReaderEvent
notifyObservers(PluginEvent) - Method in class org.eclipse.keyple.core.plugin.AbstractObservablePlugin
Push a PluginEvent of the ObservablePluginNotifier to its registered observers.
notifyObservers(PluginEvent) - Method in interface org.eclipse.keyple.core.plugin.ObservablePluginNotifier
Push a PluginEvent of the ObservablePluginNotifier to its registered observers.
notifyObservers(ReaderEvent) - Method in interface org.eclipse.keyple.core.plugin.ObservableReaderNotifier
Push a ReaderEvent of the ObservableReaderNotifier to its registered observers.
notNull(Object, String) - Method in class org.eclipse.keyple.core.util.Assert
Assert that the input object is not null.

O

ObservablePlugin - Interface in org.eclipse.keyple.core.service.event
Provides the API to observe Reader's connection/disconnection.
ObservablePlugin.PluginObserver - Interface in org.eclipse.keyple.core.service.event
This interface has to be implemented by plugin observers.
ObservablePluginNotifier - Interface in org.eclipse.keyple.core.plugin
Provides the API to notify the observers of an ObservablePlugin
ObservableReader - Interface in org.eclipse.keyple.core.service.event
Provides the API to observe cards insertion/removal.
ObservableReader.NotificationMode - Enum in org.eclipse.keyple.core.service.event
Indicates the expected behavior when processing a default selection.
ObservableReader.PollingMode - Enum in org.eclipse.keyple.core.service.event
Indicates the action to be taken after processing a card.
ObservableReader.ReaderObserver - Interface in org.eclipse.keyple.core.service.event
This interface has to be implemented by reader observers.
ObservableReaderNotifier - Interface in org.eclipse.keyple.core.plugin
Provides the API to notify the observers of an ObservableReader
onCardInserted() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalAutonomousReader
This method must be called when a card is inserted.
onCardRemoved() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalAutonomousReader
This method must be called when a card is removed.
onPluginObservationError(String, Throwable) - Method in interface org.eclipse.keyple.core.service.event.PluginObservationExceptionHandler
This method is invoked when a runtime exception occurs in the observed plugin.
onReaderObservationError(String, String, Throwable) - Method in interface org.eclipse.keyple.core.service.event.ReaderObservationExceptionHandler
This method is invoked when a runtime exception occurs in the observed reader.
onStartDetection() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Method called when the card detection is started by the Keyple Plugin
onStopDetection() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Method called when the card detection is stopped by the Keyple Plugin
openChannelForAid(byte[], byte) - Method in interface org.eclipse.keyple.core.plugin.SmartSelectionReader
Opens a logical channel for the provided AID
openPhysicalChannel() - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Attempts to open the physical channel.
org.eclipse.keyple.core.card.command - package org.eclipse.keyple.core.card.command
Contains the basic APIs needed to build and parse the cards' APDUs.
org.eclipse.keyple.core.card.command.exception - package org.eclipse.keyple.core.card.command.exception
Contains the basic exceptions related to the execution of card commands.
org.eclipse.keyple.core.card.message - package org.eclipse.keyple.core.card.message
Contains the POJOs carrying the data to or from the cards.
org.eclipse.keyple.core.card.selection - package org.eclipse.keyple.core.card.selection
Contains the classes to handle the card selection process.
org.eclipse.keyple.core.plugin - package org.eclipse.keyple.core.plugin
Contains the plugin and reader management classes.
org.eclipse.keyple.core.service - package org.eclipse.keyple.core.service
Contains the SmartCardService and the main interfaces.
org.eclipse.keyple.core.service.event - package org.eclipse.keyple.core.service.event
Contains the necessary APIs for observing plugins and readers (used by ticketing applications).
org.eclipse.keyple.core.service.exception - package org.eclipse.keyple.core.service.exception
Contains the basic exceptions related to the management of plugins and readers.
org.eclipse.keyple.core.service.util - package org.eclipse.keyple.core.service.util
Contains the card protocols definitions.
org.eclipse.keyple.core.util - package org.eclipse.keyple.core.util
Contains various utility classes.
org.eclipse.keyple.core.util.bertlv - package org.eclipse.keyple.core.util.bertlv
Contains BER-TLV helper classes.
org.eclipse.keyple.core.util.json - package org.eclipse.keyple.core.util.json
Contains JSON utility classes as serializers/deserializers, mainly used by the Keyple Remote Plugins solution.

P

parse(CardSelectionResponse) - Method in class org.eclipse.keyple.core.card.selection.AbstractCardSelection
Parsing method to be implemented in a card specific extension.
parse(Tag, int) - Method in class org.eclipse.keyple.core.util.bertlv.TLV
Parse the byte array to find the expected TLV.
Plugin - Interface in org.eclipse.keyple.core.service
Defines the high level plugin API.
PluginEvent - Class in org.eclipse.keyple.core.service.event
This POJO is used to propagate a change of reader state in an ObservablePlugin.
PluginEvent(String, String, PluginEvent.EventType) - Constructor for class org.eclipse.keyple.core.service.event.PluginEvent
Create a PluginEvent for a single reader from the plugin and reader names and the type of event.
PluginEvent(String, Set<String>, PluginEvent.EventType) - Constructor for class org.eclipse.keyple.core.service.event.PluginEvent
Create a PluginEvent for multiple readers from the plugin name, multiple reader names and the type of event.
PluginEvent.EventType - Enum in org.eclipse.keyple.core.service.event
The two types of reader event
PluginFactory - Interface in org.eclipse.keyple.core.service
Plugin Factory interface.
PluginObservationExceptionHandler - Interface in org.eclipse.keyple.core.service.event
This interface must be implemented by any application using the plugin observation.
PoolPlugin - Interface in org.eclipse.keyple.core.service
Provides methods to handle the access to an undefined number of Reader resources.
prepareReleaseChannel() - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsService
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.
prepareSelection(AbstractCardSelection<? extends AbstractApduCommandBuilder>) - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsService
Prepare a selection: add the selection request from the provided selector to the selection request set.
PRIVATE - Static variable in class org.eclipse.keyple.core.util.bertlv.Tag
 
processCardRequest(CardRequest, ChannelControl) - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
processCardRequest(CardRequest, ChannelControl) - Method in class org.eclipse.keyple.core.plugin.AbstractReader
This method is the actual implementation of the process of a CardRequest as defined by ProxyReader.transmitCardRequest(CardRequest, ChannelControl)
processCardSelectionRequests(List<CardSelectionRequest>, MultiSelectionProcessing, ChannelControl) - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
processCardSelectionRequests(List<CardSelectionRequest>, MultiSelectionProcessing, ChannelControl) - Method in class org.eclipse.keyple.core.plugin.AbstractReader
This method is the actual implementation of the process of transmitting a list of CardSelectionRequest as defined by ProxyReader.transmitCardSelectionRequests(List, MultiSelectionProcessing, ChannelControl).
processDefaultSelectionsResponse(AbstractDefaultSelectionsResponse) - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsService
Parses the response to a selection operation sent to a card and return a list of AbstractSmartCard
processExplicitSelections(Reader) - Method in class org.eclipse.keyple.core.card.selection.CardSelectionsService
Execute the selection process and return a list of AbstractSmartCard.
ProxyReader - Interface in org.eclipse.keyple.core.card.message
Defines the methods of a Reader for communicating with cards.

R

Reader - Interface in org.eclipse.keyple.core.service
Defines the high level API to access a card reader.
ReaderEvent - Class in org.eclipse.keyple.core.service.event
This POJO is used to propagate a change of a card state in an ObservableReader.
ReaderEvent(String, String, ReaderEvent.EventType, AbstractDefaultSelectionsResponse) - Constructor for class org.eclipse.keyple.core.service.event.ReaderEvent
ReaderEvent constructor for simple insertion notification mode
ReaderEvent.EventType - Enum in org.eclipse.keyple.core.service.event
The different types of reader events, reflecting the status of the reader regarding the presence of a card.
ReaderObservationExceptionHandler - Interface in org.eclipse.keyple.core.service.event
This interface must be implemented by any application using the reader observation.
readers - Variable in class org.eclipse.keyple.core.plugin.AbstractPlugin
The list of readers
register() - Method in class org.eclipse.keyple.core.plugin.AbstractPlugin
Deprecated. 
registerPlugin(PluginFactory) - Method in class org.eclipse.keyple.core.service.SmartCardService
Register a new plugin to be available in the platform if not registered yet
registerTypeAdapter(Class<?>, Object, boolean) - Static method in class org.eclipse.keyple.core.util.json.KeypleGsonParser
Registers a new type adapter and returns the updated parser.
releaseChannel() - Method in interface org.eclipse.keyple.core.card.message.ProxyReader
Release the communication channel previously established with the card.
releaseChannel() - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Release the communication channel previously established with the card.
releaseReader(Reader) - Method in interface org.eclipse.keyple.core.service.PoolPlugin
Releases a Reader previously allocated with allocateReader.
removeObserver(ObservableReader.ReaderObserver) - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Remove a ObservableReader.ReaderObserver.
removeObserver(ObservablePlugin.PluginObserver) - Method in class org.eclipse.keyple.core.plugin.AbstractObservablePlugin
Unregister a plugin observer.
removeObserver(ObservablePlugin.PluginObserver) - Method in class org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin
Remove a plugin observer.
removeObserver(ObservablePlugin.PluginObserver) - Method in interface org.eclipse.keyple.core.service.event.ObservablePlugin
Unregister a plugin observer.
removeObserver(ObservableReader.ReaderObserver) - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Unregister a reader observer.
request - Variable in class org.eclipse.keyple.core.card.command.AbstractApduCommandBuilder
The byte array APDU request.
response - Variable in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
the ApduResponse containing response.

S

SelectionStatus - Class in org.eclipse.keyple.core.card.message
This POJO is used to transport the data related to the outcome of the card selection process.
SelectionStatus(AnswerToReset, ApduResponse, boolean) - Constructor for class org.eclipse.keyple.core.card.message.SelectionStatus
Create a Selection Status with the 3 required elements.
serialize(byte[], Type, JsonSerializationContext) - Method in class org.eclipse.keyple.core.util.json.ByteArrayJsonAdapter
serialize(CardCommand, Type, JsonSerializationContext) - Method in class org.eclipse.keyple.core.util.json.CardCommandJsonAdapter
serialize(KeypleCardCommandException, Type, JsonSerializationContext) - Method in class org.eclipse.keyple.core.util.json.KeypleCardCommandExceptionJsonSerializer
serialize(KeypleReaderIOException, Type, JsonSerializationContext) - Method in class org.eclipse.keyple.core.util.json.KeypleReaderIOExceptionJsonSerializer
serialize(Throwable, Type, JsonSerializationContext) - Method in class org.eclipse.keyple.core.util.json.ThrowableJsonSerializer
setApduRequest(byte, CardCommand, byte, byte, byte[], Byte) - Method in class org.eclipse.keyple.core.card.command.AbstractIso7816CommandBuilder
Helper method to create an ApduRequest from separated elements.
setAtrRegex(String) - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AtrFilter
Setter for the regular expression provided at construction time
setCardResponse(CardResponse) - Method in exception org.eclipse.keyple.core.service.exception.KeypleReaderIOException
 
setCardSelectionResponses(List<CardSelectionResponse>) - Method in exception org.eclipse.keyple.core.service.exception.KeypleReaderIOException
 
setDefaultSelectionRequest(AbstractDefaultSelectionsRequest, ObservableReader.NotificationMode) - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
If defined, the prepared DefaultSelectionRequest will be processed as soon as a card is inserted.
setDefaultSelectionRequest(AbstractDefaultSelectionsRequest, ObservableReader.NotificationMode, ObservableReader.PollingMode) - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
A combination of defining the default selection request and starting the card detection.
setDefaultSelectionRequest(AbstractDefaultSelectionsRequest, ObservableReader.NotificationMode) - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Defines the default selection request to be processed when a card is inserted.
setDefaultSelectionRequest(AbstractDefaultSelectionsRequest, ObservableReader.NotificationMode, ObservableReader.PollingMode) - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Defines the default selection request and starts the card detection using the provided polling mode.
setName(String) - Method in class org.eclipse.keyple.core.card.message.ApduRequest
Name this APDU request.
setSuccessfulStatusCodes(Set<Integer>) - Method in class org.eclipse.keyple.core.card.message.ApduRequest
The successfulStatusCodes list indicates which status words in the response should be considered successful even though they are different from 9000h.
SmartCardService - Class in org.eclipse.keyple.core.service
The Class SmartCardService.
SmartSelectionReader - Interface in org.eclipse.keyple.core.plugin
Interface implemented by readers able to handle natively the card selection process.
startCardDetection(ObservableReader.PollingMode) - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Starts the card detection.
startCardDetection(ObservableReader.PollingMode) - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Starts the card detection.
stateService - Variable in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
 
STATUS_TABLE - Static variable in class org.eclipse.keyple.core.card.command.AbstractApduResponseParser
This Map stores expected status that could be .
StatusProperties(String) - Constructor for class org.eclipse.keyple.core.card.command.AbstractApduResponseParser.StatusProperties
Creates a successful status.
StatusProperties(String, Class<? extends KeypleCardCommandException>) - Constructor for class org.eclipse.keyple.core.card.command.AbstractApduResponseParser.StatusProperties
Creates an error status.
If exceptionClass is null, then a successful status is created.
stopCardDetection() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
Stops the card detection.
stopCardDetection() - Method in interface org.eclipse.keyple.core.service.event.ObservableReader
Stops the card detection.
stopWaitForCard() - Method in interface org.eclipse.keyple.core.plugin.WaitForCardInsertionBlocking
Interrupts the waiting of a card
stopWaitForCardRemoval() - Method in interface org.eclipse.keyple.core.plugin.WaitForCardRemovalBlocking
Interrupts the waiting of the removal of the card

T

Tag - Class in org.eclipse.keyple.core.util.bertlv
Represents a TAG as defined by the Basic Encoding Rules for ASN.1
This implementation limits the tag size to 2.
(ITU-T X.690 / ISO 8825)
Tag(int, byte, Tag.TagType, int) - Constructor for class org.eclipse.keyple.core.util.bertlv.Tag
Creates a tag from its attributes.
Tag(byte[], int) - Constructor for class org.eclipse.keyple.core.util.bertlv.Tag
Create a tag from a binary stream.
Tag.TagType - Enum in org.eclipse.keyple.core.util.bertlv
The tag type
threadWaitTimeout - Variable in class org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin
Thread wait timeout in ms
threeBytesSignedToInt(byte[], int) - Static method in class org.eclipse.keyple.core.util.ByteArrayUtil
Convert three bytes (signed) from a byte array into an integer.
threeBytesToInt(byte[], int) - Static method in class org.eclipse.keyple.core.util.ByteArrayUtil
Convert three bytes (unsigned) from a byte array into an integer.
ThrowableJsonSerializer - Class in org.eclipse.keyple.core.util.json
Serializer of a Throwable.
ThrowableJsonSerializer() - Constructor for class org.eclipse.keyple.core.util.json.ThrowableJsonSerializer
 
TLV - Class in org.eclipse.keyple.core.util.bertlv
Helps to parse a byte array as a TLV structure
TLV(byte[]) - Constructor for class org.eclipse.keyple.core.util.bertlv.TLV
Create a TLV object initialized with a byte array
toHex(byte[]) - Static method in class org.eclipse.keyple.core.util.ByteArrayUtil
Represents the byte array in a hexadecimal string.
toString() - Method in class org.eclipse.keyple.core.card.message.ApduRequest
 
toString() - Method in class org.eclipse.keyple.core.card.message.ApduResponse
 
toString() - Method in class org.eclipse.keyple.core.card.message.CardRequest
 
toString() - Method in class org.eclipse.keyple.core.card.message.CardResponse
 
toString() - Method in class org.eclipse.keyple.core.card.message.CardSelectionRequest
 
toString() - Method in class org.eclipse.keyple.core.card.message.CardSelectionResponse
 
toString() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AidSelector
Print out the AID in hex
toString() - Method in class org.eclipse.keyple.core.card.selection.CardSelector.AtrFilter
Print out the ATR regex
toString() - Method in class org.eclipse.keyple.core.card.selection.CardSelector
 
toString() - Method in class org.eclipse.keyple.core.util.bertlv.Tag
 
toString() - Method in class org.eclipse.keyple.core.util.bertlv.TLV
 
transmitApdu(byte[]) - Method in class org.eclipse.keyple.core.plugin.AbstractLocalReader
Transmits a single APDU and receives its response.
transmitCardRequest(CardRequest, ChannelControl) - Method in interface org.eclipse.keyple.core.card.message.ProxyReader
Transmits a single CardRequest passed as an argument and returns a CardResponse.
transmitCardRequest(CardRequest, ChannelControl) - Method in class org.eclipse.keyple.core.plugin.AbstractReader
Transmits a single CardRequest passed as an argument and returns a CardResponse.
transmitCardSelectionRequests(List<CardSelectionRequest>, MultiSelectionProcessing, ChannelControl) - Method in interface org.eclipse.keyple.core.card.message.ProxyReader
Transmits the list of CardSelectionRequest and gets in return a list of CardSelectionResponse.
transmitCardSelectionRequests(List<CardSelectionRequest>, MultiSelectionProcessing, ChannelControl) - Method in class org.eclipse.keyple.core.plugin.AbstractReader
Transmits the list of CardSelectionRequest and gets in return a list of CardSelectionResponse.
twoBytesSignedToInt(byte[], int) - Static method in class org.eclipse.keyple.core.util.ByteArrayUtil
Convert two bytes (signed) from a byte array into an integer.
twoBytesToInt(byte[], int) - Static method in class org.eclipse.keyple.core.util.ByteArrayUtil
Convert two bytes (unsigned) from a byte array into an integer.

U

UNIVERSAL - Static variable in class org.eclipse.keyple.core.util.bertlv.Tag
The tag classes
unregister() - Method in class org.eclipse.keyple.core.plugin.AbstractObservableLocalReader
(package-private)
Change the reader status to unregistered
unregister() - Method in class org.eclipse.keyple.core.plugin.AbstractObservablePlugin
 
unregister() - Method in class org.eclipse.keyple.core.plugin.AbstractPlugin
Deprecated. 
unregisterPlugin(String) - Method in class org.eclipse.keyple.core.service.SmartCardService
Unregister plugin from platform
update(PluginEvent) - Method in interface org.eclipse.keyple.core.service.event.ObservablePlugin.PluginObserver
Called when a plugin event occurs.
update(ReaderEvent) - Method in interface org.eclipse.keyple.core.service.event.ObservableReader.ReaderObserver
Called when a reader event occurs.

V

valueOf(String) - Static method in enum org.eclipse.keyple.core.card.message.ChannelControl
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.FileControlInformation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.FileOccurrence
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.card.selection.MultiSelectionProcessing
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.plugin.AbstractObservableLocalReader.InternalEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.service.event.ObservableReader.NotificationMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.service.event.ObservableReader.PollingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.service.event.PluginEvent.EventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.service.event.ReaderEvent.EventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.service.util.ContactCardCommonProtocols
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.service.util.ContactlessCardCommonProtocols
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.keyple.core.util.bertlv.Tag.TagType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.keyple.core.card.message.ChannelControl
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.FileControlInformation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.card.selection.CardSelector.AidSelector.FileOccurrence
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.card.selection.MultiSelectionProcessing
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.plugin.AbstractObservableLocalReader.InternalEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.service.event.ObservableReader.NotificationMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.service.event.ObservableReader.PollingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.service.event.PluginEvent.EventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.service.event.ReaderEvent.EventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.service.util.ContactCardCommonProtocols
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.service.util.ContactlessCardCommonProtocols
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.keyple.core.util.bertlv.Tag.TagType
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForCardAbsentNative() - Method in interface org.eclipse.keyple.core.plugin.WaitForCardRemovalBlocking
Wait until the card disappears.
WaitForCardInsertionAutonomous - Interface in org.eclipse.keyple.core.plugin
Interface to be implemented by readers that have a fully integrated management of card communications for card insertion detection.
WaitForCardInsertionBlocking - Interface in org.eclipse.keyple.core.plugin
Interface to be implemented by readers that are autonomous in the management of waiting for the insertion of a card and that provide a method to wait for it indefinitely.
WaitForCardInsertionNonBlocking - Interface in org.eclipse.keyple.core.plugin
Interface to be implemented by readers that require an active process to detect the card insertion.
waitForCardPresent() - Method in interface org.eclipse.keyple.core.plugin.WaitForCardInsertionBlocking
Waits for a card.
WaitForCardRemovalAutonomous - Interface in org.eclipse.keyple.core.plugin
Interface to be implemented by readers that have a fully integrated management of card communications for card removal detection.
WaitForCardRemovalBlocking - Interface in org.eclipse.keyple.core.plugin
Interface to be implemented by the readers able to handle natively the card removal process.
WaitForCardRemovalDuringProcessing - Interface in org.eclipse.keyple.core.plugin
Interface to be implemented by readers able to detect a card removal during processing, between two APDU commands.
WaitForCardRemovalNonBlocking - Interface in org.eclipse.keyple.core.plugin
Interface to be implemented by readers that require an active process to detect the card removal.
A B C D E F G H I K M N O P R S T U V W 
Skip navigation links
Copyright © Eclipse Foundation, Inc. All Rights Reserved.