Interface RemoteReaderServer

All Superinterfaces:
org.eclipse.keyple.core.common.KeypleReaderExtension

public interface RemoteReaderServer extends org.eclipse.keyple.core.common.KeypleReaderExtension
API of the Remote Reader Server provided by the Remote Plugin Server to be used in the Reader Client Side configuration mode.

It is a KeypleReaderExtension of a Keyple Reader (not observable) which provides some specific features.

Since:
2.0.0
  • Method Summary

    Modifier and Type
    Method
    Description
    Deprecated.
    Use getInitialCardContent(Class) instead, which lets the server application define the expected type of the initial card content.
    <T> T
    getInitialCardContent(Class<T> initialCardContentClass)
    Gets the initial content of the smart card if it is set, as an instance of the expected type.
    <T> T
    getInputData(Class<T> inputDataClass)
    Gets the input data if it is set.
    Gets the ID of the remote service to execute server side.
  • Method Details

    • getServiceId

      String getServiceId()
      Gets the ID of the remote service to execute server side.
      Returns:
      A not empty string.
      Since:
      2.0.0
    • getInitialCardContent

      @Deprecated Object getInitialCardContent()
      Deprecated.
      Use getInitialCardContent(Class) instead, which lets the server application define the expected type of the initial card content.
      Gets the initial content of the smart card if it is set.

      The returned org.calypsonet.terminal.reader.selection.SmartCard object can be cast into the expected type.

      Returns:
      Null if there is no initial card content.
      Since:
      2.0.0
    • getInitialCardContent

      <T> T getInitialCardContent(Class<T> initialCardContentClass)
      Gets the initial content of the smart card if it is set, as an instance of the expected type.

      The expected type is usually the interface of the smart card provided by the card extension (e.g. org.eclipse.keypop.calypso.card.card.CalypsoCard), or Properties for the clients using the Server JSON API (the initial card content then contains the processed card selection scenario). The initial card content must be a smart card or a Properties object of the expected type.

      Type Parameters:
      T - The expected type of the initial card content.
      Parameters:
      initialCardContentClass - The expected type of the initial card content.
      Returns:
      Null if there is no initial card content.
      Throws:
      IllegalArgumentException - If the provided class is null.
      IllegalStateException - If the initial card content is not a smart card or a Properties object of the expected type.
      Since:
      2.6.0
    • getInputData

      <T> T getInputData(Class<T> inputDataClass)
      Gets the input data if it is set.
      Type Parameters:
      T - The type of the expected input data.
      Parameters:
      inputDataClass - The expected input data type.
      Returns:
      Null if there is no input data.
      Throws:
      IllegalArgumentException - If the provided class is null.
      Since:
      2.0.0