Package org.eclipse.keyple.card.calypso

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.calypsonet.terminal.calypso.transaction.BasicSignatureComputationData createBasicSignatureComputationData()
      Returns a new instance of BasicSignatureComputationData to use to define the parameters of the CommonTransactionManager.prepareComputeSignature(CommonSignatureComputationData) and CommonTransactionManager.prepareComputeSignature(CommonSignatureComputationData) methods.
      org.calypsonet.terminal.calypso.transaction.BasicSignatureVerificationData createBasicSignatureVerificationData()
      Returns a new instance of BasicSignatureVerificationData to use to define the parameters of the CommonTransactionManager.prepareVerifySignature(CommonSignatureVerificationData) and CommonTransactionManager.prepareVerifySignature(CommonSignatureVerificationData) methods.
      org.calypsonet.terminal.calypso.transaction.CardSecuritySetting createCardSecuritySetting()
      Returns a new instance of CardSecuritySetting to use for secure card operations.
      org.calypsonet.terminal.calypso.card.CalypsoCardSelection createCardSelection()
      Returns a new instance of CalypsoCardSelection to use when selecting a card.
      org.calypsonet.terminal.calypso.transaction.CardTransactionManager createCardTransaction​(org.calypsonet.terminal.reader.CardReader cardReader, org.calypsonet.terminal.calypso.card.CalypsoCard calypsoCard, org.calypsonet.terminal.calypso.transaction.CardSecuritySetting cardSecuritySetting)
      Return a new card transaction manager to handle operations secured with a control SAM.
      org.calypsonet.terminal.calypso.transaction.CardTransactionManager createCardTransactionWithoutSecurity​(org.calypsonet.terminal.reader.CardReader cardReader, org.calypsonet.terminal.calypso.card.CalypsoCard calypsoCard)
      Returns a new card transaction manager to handle non-secured operations.
      org.eclipse.keyple.core.service.resource.spi.CardResourceProfileExtension createSamResourceProfileExtension​(org.calypsonet.terminal.calypso.sam.CalypsoSamSelection calypsoSamSelection)
      Returns a new instance of CardResourceProfileExtension to provide to the CardResourceService service.
      org.calypsonet.terminal.calypso.transaction.SamSecuritySetting createSamSecuritySetting()
      Returns a new instance of SamSecuritySetting to use for secure SAM operations.
      org.calypsonet.terminal.calypso.sam.CalypsoSamSelection createSamSelection()
      Returns a new instance of CalypsoSamSelection to use when selecting a SAM.
      org.calypsonet.terminal.calypso.transaction.SamTransactionManager createSamTransaction​(org.calypsonet.terminal.reader.CardReader samReader, org.calypsonet.terminal.calypso.sam.CalypsoSam calypsoSam, org.calypsonet.terminal.calypso.transaction.SamSecuritySetting samSecuritySetting)
      Returns a new SAM transaction manager to handle operations secured with a control SAM.
      org.calypsonet.terminal.calypso.transaction.SamTransactionManager createSamTransactionWithoutSecurity​(org.calypsonet.terminal.reader.CardReader samReader, org.calypsonet.terminal.calypso.sam.CalypsoSam calypsoSam)
      Returns a new SAM transaction manager to handle non-secured operations.
      org.calypsonet.terminal.calypso.transaction.SearchCommandData createSearchCommandData()
      Returns a new instance of SearchCommandData to use to define the parameters of the CardTransactionManager.prepareSearchRecords(SearchCommandData) method.
      org.calypsonet.terminal.calypso.transaction.TraceableSignatureComputationData createTraceableSignatureComputationData()
      Returns a new instance of TraceableSignatureComputationData to use to define the parameters of the CommonTransactionManager.prepareComputeSignature(CommonSignatureComputationData) and CommonTransactionManager.prepareComputeSignature(CommonSignatureComputationData) methods.
      org.calypsonet.terminal.calypso.transaction.TraceableSignatureVerificationData createTraceableSignatureVerificationData()
      Returns a new instance of TraceableSignatureVerificationData to use to define the parameters of the CommonTransactionManager.prepareVerifySignature(CommonSignatureVerificationData) and CommonTransactionManager.prepareVerifySignature(CommonSignatureVerificationData) methods.
      java.lang.String getCardApiVersion()
      java.lang.String getCommonApiVersion()
      ContextSetting getContextSetting()
      Returns the context setting.
      static CalypsoExtensionService getInstance()
      Returns the service instance.
      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()
        Returns the service instance.
        Returns:
        A not null reference.
        Since:
        2.0.0

      • getContextSetting

        public ContextSetting getContextSetting()
        Returns the context setting.
        Returns:
        A not null ContextSetting.
        Since:
        2.3.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()
        Returns a new instance of SearchCommandData to use to define the parameters of the CardTransactionManager.prepareSearchRecords(SearchCommandData) method.
        Returns:
        A not null reference.
        Since:
        2.1.0

      • createBasicSignatureComputationData

        public org.calypsonet.terminal.calypso.transaction.BasicSignatureComputationData createBasicSignatureComputationData()
        Returns a new instance of BasicSignatureComputationData to use to define the parameters of the CommonTransactionManager.prepareComputeSignature(CommonSignatureComputationData) and CommonTransactionManager.prepareComputeSignature(CommonSignatureComputationData) methods.
        Returns:
        A not null reference.
        Since:
        2.2.0

      • createTraceableSignatureComputationData

        public org.calypsonet.terminal.calypso.transaction.TraceableSignatureComputationData createTraceableSignatureComputationData()
        Returns a new instance of TraceableSignatureComputationData to use to define the parameters of the CommonTransactionManager.prepareComputeSignature(CommonSignatureComputationData) and CommonTransactionManager.prepareComputeSignature(CommonSignatureComputationData) methods.
        Returns:
        A not null reference.
        Since:
        2.2.0

      • createBasicSignatureVerificationData

        public org.calypsonet.terminal.calypso.transaction.BasicSignatureVerificationData createBasicSignatureVerificationData()
        Returns a new instance of BasicSignatureVerificationData to use to define the parameters of the CommonTransactionManager.prepareVerifySignature(CommonSignatureVerificationData) and CommonTransactionManager.prepareVerifySignature(CommonSignatureVerificationData) methods.
        Returns:
        A not null reference.
        Since:
        2.2.0

      • createTraceableSignatureVerificationData

        public org.calypsonet.terminal.calypso.transaction.TraceableSignatureVerificationData createTraceableSignatureVerificationData()
        Returns a new instance of TraceableSignatureVerificationData to use to define the parameters of the CommonTransactionManager.prepareVerifySignature(CommonSignatureVerificationData) and CommonTransactionManager.prepareVerifySignature(CommonSignatureVerificationData) methods.
        Returns:
        A not null reference.
        Since:
        2.2.0

      • createCardSelection

        public org.calypsonet.terminal.calypso.card.CalypsoCardSelection createCardSelection()
        Returns a new instance of CalypsoCardSelection to use when selecting a card.
        Returns:
        A not null reference.
        Since:
        2.0.0

      • createSamSelection

        public org.calypsonet.terminal.calypso.sam.CalypsoSamSelection createSamSelection()
        Returns a new instance of CalypsoSamSelection to use when selecting a SAM.
        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)
        Returns a new instance of CardResourceProfileExtension to provide to the CardResourceService service.

        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()
        Returns a new instance of CardSecuritySetting to use for secure card operations.
        Returns:
        A not null reference.
        Since:
        2.0.0

      • createCardTransaction

        public org.calypsonet.terminal.calypso.transaction.CardTransactionManager createCardTransaction​(org.calypsonet.terminal.reader.CardReader cardReader,
                                                                                                org.calypsonet.terminal.calypso.card.CalypsoCard calypsoCard,
                                                                                                org.calypsonet.terminal.calypso.transaction.CardSecuritySetting cardSecuritySetting)
        Return a new card transaction manager to handle operations secured with a control 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:
        cardReader - 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 "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 cardReader,
                                                                                                               org.calypsonet.terminal.calypso.card.CalypsoCard calypsoCard)
        Returns a new card transaction manager to handle non-secured operations.
        Parameters:
        cardReader - 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 "calypsoCard" has a null or unknown product type.
        Since:
        2.0.0

      • createSamSecuritySetting

        public org.calypsonet.terminal.calypso.transaction.SamSecuritySetting createSamSecuritySetting()
        Returns a new instance of SamSecuritySetting to use for secure SAM operations.
        Returns:
        A not null reference.
        Since:
        2.2.0

      • createSamTransaction

        public org.calypsonet.terminal.calypso.transaction.SamTransactionManager createSamTransaction​(org.calypsonet.terminal.reader.CardReader samReader,
                                                                                              org.calypsonet.terminal.calypso.sam.CalypsoSam calypsoSam,
                                                                                              org.calypsonet.terminal.calypso.transaction.SamSecuritySetting samSecuritySetting)
        Returns a new SAM transaction manager to handle operations secured with a control SAM.

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

        Parameters:
        samReader - The reader through which the SAM communicates.
        calypsoSam - The initial SAM data provided by the selection process.
        samSecuritySetting - The security settings.
        Returns:
        A not null reference.
        Throws:
        java.lang.IllegalArgumentException - If one of the provided argument is null or if "calypsoSam" has a null or unknown product type.
        Since:
        2.2.0

      • createSamTransactionWithoutSecurity

        public org.calypsonet.terminal.calypso.transaction.SamTransactionManager createSamTransactionWithoutSecurity​(org.calypsonet.terminal.reader.CardReader samReader,
                                                                                                             org.calypsonet.terminal.calypso.sam.CalypsoSam calypsoSam)
        Returns a new SAM transaction manager to handle non-secured operations.
        Parameters:
        samReader - The reader through which the SAM communicates.
        calypsoSam - The initial SAM 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 "calypsoSam" has a null or unknown product type.
        Since:
        2.2.0