org.eclipse.keyple.distributed

Interface RemotePluginServer

All Superinterfaces:

org.eclipse.keyple.core.service.event.ObservablePlugin, org.eclipse.keyple.core.service.Plugin

public interface RemotePluginServer
extends org.eclipse.keyple.core.service.event.ObservablePlugin

API of the Remote Plugin Server associated to the Local Service Client.

This plugin must be registered by the application installed on a Server not having local access to the smart card reader and that wishes to control the reader remotely :

• To register the plugin, use the method SmartCardService.registerPlugin(PluginFactory) using the factory RemotePluginServerFactory.
• To access the plugin, use the utility method RemotePluginServerUtils.getRemotePlugin().
• To unregister the plugin, use the method SmartCardService.unregisterPlugin(String) using the plugin name.

This plugin behaves like an ObservablePlugin but exposes additional services and contains only RemoteReaderServer and ObservableRemoteReaderServer readers.

Please note that this plugin is observable only to trigger ticketing services on the server side, but does not allow observation on the local plugin (reader insertion, etc...).

How to use it ?

1. Register the plugin.
2. Subscribe to plugin observation by implementing the interface ObservablePlugin.PluginObserver and using the plugin method ObservablePlugin.addObserver(PluginObserver)
3. Waiting to be notified of a plugin event of type PluginEvent.EventType#READER_CONNECTED.
4. Retrieve the name of the first reader contained in the event readers list using the method PluginEvent.getReaderNames().
5. Retrieve the remote reader from the plugin using the method getReader(String).
6. If you have activated the observation of the reader events, then you can cast the reader into an ObservableRemoteReaderServer.
7. Retrieve the service id from the reader using the method RemoteReaderServer.getServiceId().
8. Execute the ticketing service identified by the service id.
9. During the ticketing service execution, you can retrieve from the reader the user input data using the method RemoteReaderServer.getUserInputData(Class) and/or the initial smart card content transmitted by the client using the method RemoteReaderServer.getInitialCardContent(Class).
10. To terminate the remote ticketing service, invoke on the plugin the method terminateService(String, Object) by providing the associated reader name and optionally a user output data.

Since:

1.0

Nested Class Summary

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

org.eclipse.keyple.core.service.event.ObservablePlugin.PluginObserver

Method Summary

Modifier and Type	Method and Description
RemoteReaderServer	getReader(java.lang.String name)
java.util.Map<java.lang.String,org.eclipse.keyple.core.service.Reader>	getReaders()
void	terminateService(java.lang.String remoteReaderName, java.lang.Object userOutputData) Must be invoked to terminates the remote ticketing service associated to the provided remote reader name and returns to the client the provided user output data.

Methods inherited from interface org.eclipse.keyple.core.service.event.ObservablePlugin

addObserver, clearObservers, countObservers, removeObserver

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

getName, getReaderNames

Method Detail

getReaders

java.util.Map<java.lang.String,org.eclipse.keyple.core.service.Reader> getReaders()

Specified by:

getReaders in interface org.eclipse.keyple.core.service.Plugin

Returns:

a not null sorted set of Reader but you can cast them to RemoteReaderServer if needed.

Since:

1.0

getReader

RemoteReaderServer getReader(java.lang.String name)

Specified by:

getReader in interface org.eclipse.keyple.core.service.Plugin

Returns:

a not null reference.

Since:

1.0

terminateService

void terminateService(java.lang.String remoteReaderName,
                      java.lang.Object userOutputData)

Must be invoked to terminates the remote ticketing service associated to the provided remote reader name and returns to the client the provided user output data.

Parameters:

remoteReaderName - The remote reader name.

userOutputData - The object containing user output data.

Since:

1.0