org.eclipse.keyple.core.plugin

Class AbstractThreadedObservablePlugin

java.lang.Object

org.eclipse.keyple.core.plugin.AbstractPlugin

org.eclipse.keyple.core.plugin.AbstractObservablePlugin

org.eclipse.keyple.core.plugin.AbstractThreadedObservablePlugin

All Implemented Interfaces:

ObservablePluginNotifier, ObservablePlugin, Plugin

public abstract class AbstractThreadedObservablePlugin
extends AbstractObservablePlugin

Provides the means to observe a plugin (insertion/removal of readers) using a monitoring thread.

Since:

0.9

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.keyple.core.service.event.ObservablePlugin

ObservablePlugin.PluginObserver

Field Summary

Fields

Modifier and Type	Field and Description
protected long	threadWaitTimeout Thread wait timeout in ms

Fields inherited from class org.eclipse.keyple.core.plugin.AbstractPlugin

readers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractThreadedObservablePlugin(java.lang.String name) Instantiates a threaded observable plugin.

Method Summary

Modifier and Type	Method and Description
void	addObserver(ObservablePlugin.PluginObserver observer) Add a plugin observer.
void	clearObservers() Remove all observers at once
protected abstract Reader	fetchNativeReader(java.lang.String name) Fetch connected native reader (from third party library) by its name Returns the current AbstractReader if it is already listed.
protected abstract java.util.SortedSet<java.lang.String>	fetchNativeReadersNames() Fetch the list of connected native reader (usually from third party library) and returns their names (or id)
protected abstract PluginObservationExceptionHandler	getObservationExceptionHandler() Allows to call the defined handler when an exception condition needs to be transmitted to the application level.
void	removeObserver(ObservablePlugin.PluginObserver observer) Remove a plugin observer.

Methods inherited from class org.eclipse.keyple.core.plugin.AbstractObservablePlugin

countObservers, notifyObservers, unregister

Methods inherited from class org.eclipse.keyple.core.plugin.AbstractPlugin

getName, getReader, getReaderNames, getReaders, initNativeReaders, register

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.keyple.core.service.Plugin

getName, getReader, getReaderNames, getReaders

Field Detail

threadWaitTimeout

protected long threadWaitTimeout

Thread wait timeout in ms

This timeout value will determined the latency to detect changes

Constructor Detail

AbstractThreadedObservablePlugin

protected AbstractThreadedObservablePlugin(java.lang.String name)

Instantiates a threaded observable plugin.

Parameters:

name - name of the plugin

Throws:

KeypleReaderException - when an issue is raised with reader

Since:

0.9

Method Detail

fetchNativeReadersNames

protected abstract java.util.SortedSet<java.lang.String> fetchNativeReadersNames()

Fetch the list of connected native reader (usually from third party library) and returns their names (or id)

Returns:

connected readers' name list

Throws:

KeypleReaderIOException - if the communication with the reader or the card has failed

Since:

0.9

fetchNativeReader

protected abstract Reader fetchNativeReader(java.lang.String name)

Fetch connected native reader (from third party library) by its name Returns the current AbstractReader if it is already listed. Creates and returns a new AbstractReader if not.

Parameters:

name - the reader name

Returns:

the list of AbstractReader objects.

Throws:

KeypleReaderNotFoundException - if the reader was not found by its name

KeypleReaderIOException - if the communication with the reader or the card has failed

Since:

0.9

addObserver

public final void addObserver(ObservablePlugin.PluginObserver observer)

Add a plugin observer.

Overrides the method defined in AbstractObservablePlugin, a thread is created if it does not already exist (when the first observer is added).

Register the PluginObservationExceptionHandler returned by the plugin implementation of getObservationExceptionHandler as an uncaught exception handler.

Specified by:

addObserver in interface ObservablePlugin

Overrides:

addObserver in class AbstractObservablePlugin

Parameters:

observer - the observer object

Throws:

java.lang.IllegalStateException - If observer is null or no PluginObservationExceptionHandler has been set.

Since:

0.9

removeObserver

public final void removeObserver(ObservablePlugin.PluginObserver observer)

Remove a plugin observer.

Overrides the method defined in AbstractObservablePlugin, the monitoring thread is ended when the last observer is removed.

Specified by:

removeObserver in interface ObservablePlugin

Overrides:

removeObserver in class AbstractObservablePlugin

Parameters:

observer - the observer object

Since:

0.9

clearObservers

public final void clearObservers()

Remove all observers at once

In addition to the super method in AbstractObservablePlugin, the thread is ended.

Specified by:

clearObservers in interface ObservablePlugin

Overrides:

clearObservers in class AbstractObservablePlugin

Since:

0.9

getObservationExceptionHandler

protected abstract PluginObservationExceptionHandler getObservationExceptionHandler()

Allows to call the defined handler when an exception condition needs to be transmitted to the application level.

Must be implemented by the plugin provider.

Returns:

A not null reference to an object implementing the PluginObservationExceptionHandler interface.

Since:

1.0