Class CalypsoExtensionService

  • All Implemented Interfaces:
    org.eclipse.keyple.core.common.KeypleCardExtension

    public final class CalypsoExtensionService
    extends java.lang.Object
    implements org.eclipse.keyple.core.common.KeypleCardExtension
    Card extension dedicated to the management of Calypso cards.
    Since:
    2.0.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PRODUCT_TYPE  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.calypsonet.terminal.calypso.transaction.CardSecuritySetting createCardSecuritySetting()
      Creates an instance of CalypsoCardSelection that can be supplemented later with specific commands.
      org.calypsonet.terminal.calypso.card.CalypsoCardSelection createCardSelection()
      Creates an instance of CalypsoCardSelection that can be supplemented later with specific commands.
      org.calypsonet.terminal.calypso.transaction.CardTransactionManager createCardTransaction​(org.calypsonet.terminal.reader.CardReader reader, org.calypsonet.terminal.calypso.card.CalypsoCard calypsoCard, org.calypsonet.terminal.calypso.transaction.CardSecuritySetting cardSecuritySetting)
      Creates a card transaction manager to handle operations secured with a SAM.
      org.calypsonet.terminal.calypso.transaction.CardTransactionManager createCardTransactionWithoutSecurity​(org.calypsonet.terminal.reader.CardReader reader, org.calypsonet.terminal.calypso.card.CalypsoCard calypsoCard)
      Creates a card transaction manager to handle non-secured operations.
      org.eclipse.keyple.core.service.resource.spi.CardResourceProfileExtension createSamResourceProfileExtension​(org.calypsonet.terminal.calypso.sam.CalypsoSamSelection calypsoSamSelection)
      Creates an instance of CardResourceProfileExtension to be provided to the CardResourceService.
      org.calypsonet.terminal.calypso.sam.CalypsoSamSelection createSamSelection()
      Creates an instance of CalypsoCardSelection.
      org.calypsonet.terminal.calypso.transaction.SearchCommandData createSearchCommandData()
      Creates an instance of SearchCommandData to be used to define the parameters of the CardTransactionManager.prepareSearchRecords(SearchCommandData) method.
      java.lang.String getCardApiVersion()
      java.lang.String getCommonApiVersion()
      static CalypsoExtensionService getInstance()
      Gets the single instance of CalypsoExtensionService.
      java.lang.String getReaderApiVersion()
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getInstance

        public static CalypsoExtensionService getInstance()
        Gets the single instance of CalypsoExtensionService.
        Returns:
        The instance of CalypsoExtensionService.
        Since:
        2.0.0
      • getReaderApiVersion

        public java.lang.String getReaderApiVersion()
        Specified by:
        getReaderApiVersion in interface org.eclipse.keyple.core.common.KeypleCardExtension
        Since:
        2.0.0
      • getCardApiVersion

        public java.lang.String getCardApiVersion()
        Specified by:
        getCardApiVersion in interface org.eclipse.keyple.core.common.KeypleCardExtension
        Since:
        2.0.0
      • getCommonApiVersion

        public java.lang.String getCommonApiVersion()
        Specified by:
        getCommonApiVersion in interface org.eclipse.keyple.core.common.KeypleCardExtension
        Since:
        2.0.0
      • createSearchCommandData

        public org.calypsonet.terminal.calypso.transaction.SearchCommandData createSearchCommandData()
        Creates an instance of SearchCommandData to be used to define the parameters of the CardTransactionManager.prepareSearchRecords(SearchCommandData) method.
        Returns:
        A not null reference.
        Since:
        2.1.0
      • createCardSelection

        public org.calypsonet.terminal.calypso.card.CalypsoCardSelection createCardSelection()
        Creates an instance of CalypsoCardSelection that can be supplemented later with specific commands.
        Returns:
        A not null reference.
        Since:
        2.0.0
      • createSamSelection

        public org.calypsonet.terminal.calypso.sam.CalypsoSamSelection createSamSelection()
        Creates an instance of CalypsoCardSelection.
        Returns:
        A not null reference.
        Since:
        2.0.0
      • createSamResourceProfileExtension

        public org.eclipse.keyple.core.service.resource.spi.CardResourceProfileExtension createSamResourceProfileExtension​(org.calypsonet.terminal.calypso.sam.CalypsoSamSelection calypsoSamSelection)
        Creates an instance of CardResourceProfileExtension to be provided to the CardResourceService.

        The provided argument defines the selection rules to be applied to the SAM when detected by the card resource service.

        Parameters:
        calypsoSamSelection - A not null CalypsoSamSelection.
        Returns:
        A not null reference.
        Throws:
        java.lang.IllegalArgumentException - If calypsoSamSelection is null.
        Since:
        2.0.0
      • createCardSecuritySetting

        public org.calypsonet.terminal.calypso.transaction.CardSecuritySetting createCardSecuritySetting()
        Creates an instance of CalypsoCardSelection that can be supplemented later with specific commands.
        Returns:
        A not null reference.
        Since:
        2.0.0
      • createCardTransaction

        public org.calypsonet.terminal.calypso.transaction.CardTransactionManager createCardTransaction​(org.calypsonet.terminal.reader.CardReader reader,
                                                                                                        org.calypsonet.terminal.calypso.card.CalypsoCard calypsoCard,
                                                                                                        org.calypsonet.terminal.calypso.transaction.CardSecuritySetting cardSecuritySetting)
        Creates a card transaction manager to handle operations secured with a SAM.

        The reader and the card's initial data are those from the selection.
        The provided CardSecuritySetting must match the specific needs of the card (SAM card resource profile and other optional settings).

        Parameters:
        reader - The reader through which the card communicates.
        calypsoCard - The initial card data provided by the selection process.
        cardSecuritySetting - The security settings.
        Returns:
        A not null reference.
        Throws:
        java.lang.IllegalArgumentException - If one of the provided argument is null or if the CalypsoCard has a null or unknown product type.
        Since:
        2.0.0
      • createCardTransactionWithoutSecurity

        public org.calypsonet.terminal.calypso.transaction.CardTransactionManager createCardTransactionWithoutSecurity​(org.calypsonet.terminal.reader.CardReader reader,
                                                                                                                       org.calypsonet.terminal.calypso.card.CalypsoCard calypsoCard)
        Creates a card transaction manager to handle non-secured operations.
        Parameters:
        reader - The reader through which the card communicates.
        calypsoCard - The initial card data provided by the selection process.
        Returns:
        A not null reference.
        Throws:
        java.lang.IllegalArgumentException - If one of the provided argument is null or if the CalypsoCard has a null or unknown product type.
        Since:
        2.0.0