CardAndTerminalManager (Commons eID Client 1.2.0 API)

java.lang.Object
- be.fedict.commons.eid.client.CardAndTerminalManager

All Implemented Interfaces:

Runnable
```
public class CardAndTerminalManager
extends Object
implements Runnable
```
A CardAndTerminalManager maintains an active state overview of all javax.smartcardio.CardTerminal attached to a system's pcsc subsystem, and notifies registered:
- CardTerminalEventsListeners of any CardTerminals Attached or Detached
- CardEventsListeners of any Cards inserted into or removed from any attached CardTerminals
Note that at the level of CardAndTerminalManager there is no distinction between types of cards or terminals: They are merely reported using the standard javax.smartcardio classes.
Author:

Frank Marien

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CardAndTerminalManager.PROTOCOL

Nested Classes
Modifier and Type	Class and Description
`static class`	`CardAndTerminalManager.PROTOCOL`

Constructor Summary

Constructors
Constructor and Description
`CardAndTerminalManager()` Instantiate a CardAndTerminalManager working on the standard smartcardio CardTerminals, and without any logging.
`CardAndTerminalManager(javax.smartcardio.CardTerminals cardTerminals)` Instantiate a CardAndTerminalManager working on a specific CardTerminals instance and without any logging.
`CardAndTerminalManager(Logger logger)` Instantiate a CardAndTerminalManager working on the standard smartcardio CardTerminals, and logging to the Logger implementation given.
`CardAndTerminalManager(Logger logger, javax.smartcardio.CardTerminals cardTerminals)` Instantiate a CardAndTerminalManager working on a specific CardTerminals instance, and that logs to the given Logger.In normal operation, you would use the constructor that takes no CardTerminals parameter, but using this one you could, for example obtain a CardTerminals instance from a different TerminalFactory, or from your own implementation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CardAndTerminalManager`	`acceptCardEventsFor(String terminalName)` Start accepting events for the CardTerminal with the name given, where these were being ignored due to a previous call to `ignoreCardEventsFor(String)`.
`CardAndTerminalManager`	`addCardListener(CardEventsListener listener)` Register a CardEventsListener instance.
`CardAndTerminalManager`	`addCardTerminalListener(CardTerminalEventsListener listener)` Register a CardTerminalEventsListener instance.
`int`	`getDelay()` Returns the PCSC polling delay currently in use
`CardAndTerminalManager.PROTOCOL`	`getProtocol()` return which card protocols this CardAndTerminalsManager will attempt to connect to cards with.
`CardAndTerminalManager`	`ignoreCardEventsFor(String terminalName)` Start ignoring the CardTerminal with the name given.
`boolean`	`isAutoconnect()` Return whether this CardAndTerminalsManager will automatically connect() to any cards inserted.
`CardAndTerminalManager`	`removeCardListener(CardEventsListener listener)` Unregister a CardEventsListener instance.
`CardAndTerminalManager`	`removeCardTerminalListener(CardTerminalEventsListener listener)` Unregister a CardTerminalEventsListener instance.
`void`	`run()`
`CardAndTerminalManager`	`setAutoconnect(boolean newAutoConnect)` Set whether this CardAndTerminalsManager will automatically connect() to any cards inserted.
`CardAndTerminalManager`	`setDelay(int newDelay)` Set the PCSC polling delay.
`CardAndTerminalManager`	`setProtocol(CardAndTerminalManager.PROTOCOL newProtocol)` Determines which card protocols this CardAndTerminalsManager will attempt to connect to cards with.
`CardAndTerminalManager`	`start()` Start this CardAndTerminalManager.
`CardAndTerminalManager`	`stop()` Stop this CardAndTerminalManager.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CardAndTerminalManager
```
public CardAndTerminalManager()
```
    Instantiate a CardAndTerminalManager working on the standard smartcardio CardTerminals, and without any logging.
  - CardAndTerminalManager
```
public CardAndTerminalManager(Logger logger)
```
    Instantiate a CardAndTerminalManager working on the standard smartcardio CardTerminals, and logging to the Logger implementation given.
    
    Parameters:
    
    logger - an instance of be.fedict.commons.eid.spi.Logger that will be send all the logs
  - CardAndTerminalManager
```
public CardAndTerminalManager(javax.smartcardio.CardTerminals cardTerminals)
```
    Instantiate a CardAndTerminalManager working on a specific CardTerminals instance and without any logging. In normal operation, you would use the constructor that takes no CardTerminals parameter, but using this one you could, for example obtain a CardTerminals instance from a different TerminalFactory, or from your own implementation.
    
    Parameters:
    
    cardTerminals - instance to obtain terminal and card events from
  - CardAndTerminalManager
```
public CardAndTerminalManager(Logger logger,
                              javax.smartcardio.CardTerminals cardTerminals)
```
    Instantiate a CardAndTerminalManager working on a specific CardTerminals instance, and that logs to the given Logger.In normal operation, you would use the constructor that takes no CardTerminals parameter, but using this one you could, for example obtain a CardTerminals instance from a different TerminalFactory, or from your own implementation.
    
    Parameters:
    
    logger - an instance of be.fedict.commons.eid.spi.Logger that will be send all the logs
    
    cardTerminals - instance to obtain terminal and card events from
- Method Detail
  - addCardTerminalListener
```
public CardAndTerminalManager addCardTerminalListener(CardTerminalEventsListener listener)
```
    Register a CardTerminalEventsListener instance. This will subsequently be called for any Terminal Attaches/Detaches on CardTerminals that we're not ignoring
    
    Parameters:
    
    listener - the CardTerminalEventsListener to be registered
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
    
    See Also:
    
    ignoreCardEventsFor(String)
  - addCardListener
```
public CardAndTerminalManager addCardListener(CardEventsListener listener)
```
    Register a CardEventsListener instance. This will subsequently be called for any Card Inserts/Removals on CardTerminals that we're not ignoring
    
    Parameters:
    
    listener - the CardEventsListener to be registered
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
    
    See Also:
    
    ignoreCardEventsFor(String)
  - start
```
public CardAndTerminalManager start()
```
    Start this CardAndTerminalManager. Doing this after registering one or more CardTerminalEventsListener and/or CardEventsListener instances will cause these to be called with the initial situation: The terminals and cards already present. Calling start() before registering any listeners will cause these to not see the initial situation.
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - removeCardTerminalListener
```
public CardAndTerminalManager removeCardTerminalListener(CardTerminalEventsListener listener)
```
    Unregister a CardTerminalEventsListener instance.
    
    Parameters:
    
    listener - the CardTerminalEventsListener to be unregistered
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - removeCardListener
```
public CardAndTerminalManager removeCardListener(CardEventsListener listener)
```
    Unregister a CardEventsListener instance.
    
    Parameters:
    
    listener - the CardEventsListener to be unregistered
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - ignoreCardEventsFor
```
public CardAndTerminalManager ignoreCardEventsFor(String terminalName)
```
    Start ignoring the CardTerminal with the name given. A CardTerminal's name is the exact String as returned by CardTerminal.getName() Note that this name is neither very stable, nor portable between operating systems: it is constructed by the PCSC subsystem in an arbitrary fashion, and may change between releases.
    
    Parameters:
    
    terminalName -
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - acceptCardEventsFor
```
public CardAndTerminalManager acceptCardEventsFor(String terminalName)
```
    Start accepting events for the CardTerminal with the name given, where these were being ignored due to a previous call to ignoreCardEventsFor(String).
    
    Parameters:
    
    terminalName -
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - stop
```
public CardAndTerminalManager stop()
                            throws InterruptedException
```
    Stop this CardAndTerminalManager. This will may block until the worker thread has returned, meaning that after this call returns, no registered listeners will receive any more events.
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
    
    Throws:
    
    InterruptedException
  - getDelay
```
public int getDelay()
```
    Returns the PCSC polling delay currently in use
    
    Returns:
    
    the PCSC polling delay currently in use
  - setDelay
```
public CardAndTerminalManager setDelay(int newDelay)
```
    Set the PCSC polling delay. A CardAndTerminalsManager will wait for a maximum of newDelay milliseconds for new events to be received, before issuing a new call to the PCSC subsystem. The higher this number, the less CPU this CardAndTerminalsManager will take, but the greater the chance that terminal attach/detach events will be noticed late.
    
    Parameters:
    
    newDelay - the new delay to trust the PCSC subsystem for
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - isAutoconnect
```
public boolean isAutoconnect()
```
    Return whether this CardAndTerminalsManager will automatically connect() to any cards inserted.
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - setAutoconnect
```
public CardAndTerminalManager setAutoconnect(boolean newAutoConnect)
```
    Set whether this CardAndTerminalsManager will automatically connect() to any cards inserted.
    
    Parameters:
    
    newAutoConnect -
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - getProtocol
```
public CardAndTerminalManager.PROTOCOL getProtocol()
```
    return which card protocols this CardAndTerminalsManager will attempt to connect to cards with. (if autoconnect is true, see setAutoconnect(boolean)) the default is PROTOCOL.ANY which allows any protocol.
    
    Returns:
    
    the currently attempted protocol(s)
  - setProtocol
```
public CardAndTerminalManager setProtocol(CardAndTerminalManager.PROTOCOL newProtocol)
```
    Determines which card protocols this CardAndTerminalsManager will attempt to connect to cards with. (if autoconnect is true, see setAutoconnect(boolean)) the default is PROTOCOL.ANY which allows any protocol.
    
    Parameters:
    
    newProtocol - the card protocol(s) to attempt connection to the cards with
    
    Returns:
    
    this CardAndTerminalManager to allow for method chaining.
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable

Class CardAndTerminalManager

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CardAndTerminalManager

CardAndTerminalManager

CardAndTerminalManager

CardAndTerminalManager

Method Detail

addCardTerminalListener

addCardListener

start

removeCardTerminalListener

removeCardListener

ignoreCardEventsFor

acceptCardEventsFor

stop

getDelay

setDelay

isAutoconnect

setAutoconnect

getProtocol

setProtocol

run