Package org.eclipse.keyple.core.service

Interface SmartCardService

  • public interface SmartCardService
    Keyple main service.
    Since:
    2.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void checkCardExtension​(org.eclipse.keyple.core.common.KeypleCardExtension cardExtension)
      Verifies the compatibility with the service of the provided card extension.
      org.eclipse.keypop.reader.CardReader findReader​(java.lang.String readerNameRegex)
      Returns the first reader whose name matches the provided regular expression.
      DistributedLocalService getDistributedLocalService​(java.lang.String distributedLocalServiceName)
      Returns the distributed local service having the provided name.
      Plugin getPlugin​(java.lang.String pluginName)
      Returns the plugin whose name is provided as an argument.
      Plugin getPlugin​(org.eclipse.keypop.reader.CardReader reader)
      Returns the plugin associated to the provided CardReader.
      java.util.Set<java.lang.String> getPluginNames()
      Returns the names of all registered plugins.
      java.util.Set<Plugin> getPlugins()
      Returns all registered plugins.
      org.eclipse.keypop.reader.CardReader getReader​(java.lang.String readerName)
      Returns the reader associated to the provided unique name.
      org.eclipse.keypop.reader.ReaderApiFactory getReaderApiFactory()
      Returns the factory to create the Reader API objects.
      DistributedLocalService registerDistributedLocalService​(org.eclipse.keyple.core.common.KeypleDistributedLocalServiceExtensionFactory distributedLocalServiceExtensionFactory)
      Registers a new distributed local service to the service.
      Plugin registerPlugin​(org.eclipse.keyple.core.common.KeyplePluginExtensionFactory pluginFactory)
      Registers a new plugin to the service.
      void unregisterDistributedLocalService​(java.lang.String distributedLocalServiceName)
      Attempts to unregister the distributed local service having the provided name from the service.
      void unregisterPlugin​(java.lang.String pluginName)
      Attempts to unregister the plugin having the provided name from the service.

    • Method Detail

      • registerPlugin

        Plugin registerPlugin​(org.eclipse.keyple.core.common.KeyplePluginExtensionFactory pluginFactory)
        Registers a new plugin to the service.
        Parameters:
        pluginFactory - The plugin factory.
        Returns:
        A not null reference to the registered Plugin.
        Throws:
        KeyplePluginException - If instantiation failed.
        java.lang.IllegalStateException - If the plugin has already been registered.
        Since:
        2.0.0

      • unregisterPlugin

        void unregisterPlugin​(java.lang.String pluginName)
        Attempts to unregister the plugin having the provided name from the service.
        Parameters:
        pluginName - The plugin name.
        Since:
        2.0.0

      • getPluginNames

        java.util.Set<java.lang.String> getPluginNames()
        Returns the names of all registered plugins.
        Returns:
        A not null Set String.
        Since:
        2.0.0

      • getPlugins

        java.util.Set<Plugin> getPlugins()
        Returns all registered plugins.
        Returns:
        A not null Set of Plugin.
        Since:
        2.0.0

      • getPlugin

        Plugin getPlugin​(java.lang.String pluginName)
        Returns the plugin whose name is provided as an argument.
        Parameters:
        pluginName - The plugin name.
        Returns:
        Null if the plugin is not found or no longer registered.
        Since:
        2.0.0

      • getPlugin

        Plugin getPlugin​(org.eclipse.keypop.reader.CardReader reader)
        Returns the plugin associated to the provided CardReader.
        Parameters:
        reader - The card reader.
        Returns:
        Null if the plugin is not found or no longer registered.
        Since:
        2.1.0

      • getReader

        org.eclipse.keypop.reader.CardReader getReader​(java.lang.String readerName)
        Returns the reader associated to the provided unique name.
        Parameters:
        readerName - The name of the card reader.
        Returns:
        Null if the reader is not found or no longer registered.
        Since:
        2.1.0

      • findReader

        org.eclipse.keypop.reader.CardReader findReader​(java.lang.String readerNameRegex)
        Returns the first reader whose name matches the provided regular expression.
        Parameters:
        readerNameRegex - The name of the card reader as a regular expression string.
        Returns:
        Null if the reader is not found or no longer registered.
        Throws:
        java.lang.IllegalArgumentException - If the provided regex is invalid.
        Since:
        3.1.0

      • checkCardExtension

        void checkCardExtension​(org.eclipse.keyple.core.common.KeypleCardExtension cardExtension)
        Verifies the compatibility with the service of the provided card extension.

        The verification is based on the comparison of the respective API versions.

        Parameters:
        cardExtension - A not null KeypleCardExtension reference object
        Since:
        2.0.0

      • registerDistributedLocalService

        DistributedLocalService registerDistributedLocalService​(org.eclipse.keyple.core.common.KeypleDistributedLocalServiceExtensionFactory distributedLocalServiceExtensionFactory)
        Registers a new distributed local service to the service.
        Parameters:
        distributedLocalServiceExtensionFactory - Factory to use to instantiate a Distributed Local Service extension
        Returns:
        A not null reference to the registered DistributedLocalService.
        Throws:
        java.lang.IllegalStateException - If the distributed local service has already been registered.
        Since:
        2.0.0

      • unregisterDistributedLocalService

        void unregisterDistributedLocalService​(java.lang.String distributedLocalServiceName)
        Attempts to unregister the distributed local service having the provided name from the service.
        Parameters:
        distributedLocalServiceName - The distributed local service name.
        Since:
        2.0.0

      • getDistributedLocalService

        DistributedLocalService getDistributedLocalService​(java.lang.String distributedLocalServiceName)
        Returns the distributed local service having the provided name.
        Parameters:
        distributedLocalServiceName - The name of the distributed local service.
        Returns:
        Null if the distributed local service is not found or no longer registered.
        Since:
        2.0.0

      • getReaderApiFactory

        org.eclipse.keypop.reader.ReaderApiFactory getReaderApiFactory()
        Returns the factory to create the Reader API objects.
        Returns:
        A not null reference.
        Since:
        3.0.0