com.ibm.commerce.payments.plugin.impl

Class PluginConfigurationImpl

  • java.lang.Object
    • com.ibm.commerce.payments.plugin.impl.PluginConfigurationImpl
  • All Implemented Interfaces:
    PluginConfiguration, java.io.Serializable, java.lang.Cloneable

    public class PluginConfigurationImpl
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, PluginConfiguration

    This class is the Plugin meta-data and configuration.

    The PluginConfiguration is an in-memory image of the Plugin deployment descriptor. The Plugin deployment descriptor describes a Plugin implementation. It also provides plugin-specific properties that can be used by the Plugin during the processing of financial transactions.

    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor and Description
      PluginConfigurationImpl(java.lang.String name, java.lang.String lookupName, java.lang.String homeClass, java.lang.String vendor, java.lang.String version, boolean indepedentCredit, java.lang.String virtualTerminal, boolean synchronizedLocalPaymentReversal, java.util.HashMap properties)
      This method creates a Plugin configuration container.
      PluginConfigurationImpl(java.lang.String name, java.lang.String lookupName, java.lang.String homeClass, java.lang.String vendor, java.lang.String version, boolean indepedentCredit, java.lang.String virtualTerminal, java.util.HashMap properties)
      This method creates a Plugin configuration container.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Object clone()
      This method returns a shallow copy of this PluginConfigurationImpl instance.
      java.lang.String getHomeClass()
      This method gets the full-qualified name of the Plugin's implementation EJB SSB home class.
      java.lang.String getLookupName()
      This method gets the JNDI lookup name for the Plugin's EJB SSB home.
      java.lang.String getName()
      This method gets the name.
      java.util.HashMap getProperties()
      This method gets the list of Plugin-specific properties.
      java.lang.String getVendor()
      This method gets the name of the vendor implementing the Plugin.
      java.lang.String getVersion()
      This method gets the version of the Plugin implementation.
      java.lang.String getVirtualTerminal()
      This method gets the URL of the payment back-end system administration UI.
      boolean isIndepedentCreditSupported()
      This method checks if the Plugin supports independent credits.
      boolean isSynchronizedLocalPaymentReversal()
      This method gets value of SynchronizedLocalPaymentReversal.
      void setHomeClass(java.lang.String homeClass)
      This method sets the full-qualified name of the Plugin's implementation EJB SSB home class.
      void setIndepedentCredit(boolean indepedentCredit)
      This method sets if the Plugin supports independent credits.
      void setLookupName(java.lang.String lookupName)
      This method sets the JNDI lookup name for the Plugin's EJB SSB home.
      void setName(java.lang.String name)
      This method sets he name of the Plugin implementation.
      void setProperties(java.util.HashMap properties)
      This method sets the list of Plugin-specific properties.
      void setSynchronizedLocalPaymentReversal(boolean synchronizedLocalPaymentReversal)
      This method sets value of SynchronizedLocalPaymentReversal.
      void setVendor(java.lang.String vendor)
      This method sets the name of the vendor implementing the Plugin.
      void setVersion(java.lang.String version)
      This method sets the version of the Plugin implementation.
      void setVirtualTerminal(java.lang.String virtualTerminal)
      This method sets the URL of the payment back-end system administration UI.
      java.lang.String toString()
      This method obtains a human-readable representation of the PluginConfiguration.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PluginConfigurationImpl

        public PluginConfigurationImpl(java.lang.String name,
                               java.lang.String lookupName,
                               java.lang.String homeClass,
                               java.lang.String vendor,
                               java.lang.String version,
                               boolean indepedentCredit,
                               java.lang.String virtualTerminal,
                               java.util.HashMap properties)

        This method creates a Plugin configuration container.

        Parameters:
        name - The name of the Plugin implementation.
        lookupName - The JNDI lookup name for the Plugin's EJB SSB home.
        homeClass - The full-qualified name of the Plugin's implementation EJB SSB home class.
        vendor - The name of the vendor implementing the Plugin.
        version - The version of the Plugin implementation.
        indepedentCredit - If the Plugin supports independent credits.
        virtualTerminal - The URL of the payment back-end system administration UI.
        properties - The list of Plugin-specific properties.

      • PluginConfigurationImpl

        public PluginConfigurationImpl(java.lang.String name,
                               java.lang.String lookupName,
                               java.lang.String homeClass,
                               java.lang.String vendor,
                               java.lang.String version,
                               boolean indepedentCredit,
                               java.lang.String virtualTerminal,
                               boolean synchronizedLocalPaymentReversal,
                               java.util.HashMap properties)

        This method creates a Plugin configuration container.

        Parameters:
        name - The name of the Plugin implementation.
        lookupName - The JNDI lookup name for the Plugin's EJB SSB home.
        homeClass - The full-qualified name of the Plugin's implementation EJB SSB home class.
        vendor - The name of the vendor implementing the Plugin.
        version - The version of the Plugin implementation.
        indepedentCredit - If the Plugin supports independent credits.
        virtualTerminal - The URL of the payment back-end system administration UI.
        synchronizedLocalPaymentReversal - The configuration point for locally partial reverse approval.
        properties - The list of Plugin-specific properties.

    • Method Detail

      • setHomeClass

        public void setHomeClass(java.lang.String homeClass)
        This method sets the full-qualified name of the Plugin's implementation EJB SSB home class.
        Parameters:
        homeClass - The full-qualified name of the Plugin's implementation EJB SSB home class.

      • getHomeClass

        public java.lang.String getHomeClass()
        This method gets the full-qualified name of the Plugin's implementation EJB SSB home class.
        Specified by:
        getHomeClass in interface PluginConfiguration
        Returns:
        The full-qualified name of the Plugin's implementation EJB SSB home class.

      • setIndepedentCredit

        public void setIndepedentCredit(boolean indepedentCredit)
        This method sets if the Plugin supports independent credits.
        Parameters:
        indepedentCredit - If the Plugin supports independent credits.

      • isIndepedentCreditSupported

        public boolean isIndepedentCreditSupported()

        This method checks if the Plugin supports independent credits.

        Specified by:
        isIndepedentCreditSupported in interface PluginConfiguration
        Returns:
        If the Plugin supports independent credits.

      • setLookupName

        public void setLookupName(java.lang.String lookupName)
        This method sets the JNDI lookup name for the Plugin's EJB SSB home.
        Parameters:
        lookupName - The JNDI lookup name for the Plugin's EJB SSB home.

      • getLookupName

        public java.lang.String getLookupName()
        This method gets the JNDI lookup name for the Plugin's EJB SSB home.
        Specified by:
        getLookupName in interface PluginConfiguration
        Returns:
        The JNDI lookup name for the Plugin's EJB SSB home.

      • setName

        public void setName(java.lang.String name)
        This method sets he name of the Plugin implementation.
        Parameters:
        name - The name of the Plugin implementation.

      • getName

        public java.lang.String getName()
        This method gets the name. This is to be used internally by the Plugin controller.
        Specified by:
        getName in interface PluginConfiguration
        Returns:
        The name of the Plugin implementation.

      • setProperties

        public void setProperties(java.util.HashMap properties)
        This method sets the list of Plugin-specific properties.
        Parameters:
        properties - The list of Plugin-specific properties.

      • getProperties

        public java.util.HashMap getProperties()
        This method gets the list of Plugin-specific properties.
        Specified by:
        getProperties in interface PluginConfiguration
        Returns:
        The list of Plugin-specific properties.

      • setVendor

        public void setVendor(java.lang.String vendor)
        This method sets the name of the vendor implementing the Plugin.
        Parameters:
        vendor - The name of the vendor implementing the Plugin.

      • getVendor

        public java.lang.String getVendor()
        This method gets the name of the vendor implementing the Plugin.
        Specified by:
        getVendor in interface PluginConfiguration
        Returns:
        The name of the vendor implementing the Plugin.

      • setVersion

        public void setVersion(java.lang.String version)
        This method sets the version of the Plugin implementation.
        Parameters:
        version - The version of the Plugin implementation.

      • getVersion

        public java.lang.String getVersion()
        This method gets the version of the Plugin implementation.
        Specified by:
        getVersion in interface PluginConfiguration
        Returns:
        The version of the Plugin implementation.

      • setVirtualTerminal

        public void setVirtualTerminal(java.lang.String virtualTerminal)
        This method sets the URL of the payment back-end system administration UI.
        Parameters:
        virtualTerminal - The URL of the payment back-end system administration UI.

      • getVirtualTerminal

        public java.lang.String getVirtualTerminal()
        This method gets the URL of the payment back-end system administration UI.
        Specified by:
        getVirtualTerminal in interface PluginConfiguration
        Returns:
        The URL of the payment back-end system administration UI.

      • isSynchronizedLocalPaymentReversal

        public boolean isSynchronizedLocalPaymentReversal()
        This method gets value of SynchronizedLocalPaymentReversal.
        Returns:
        the configuration value of SynchronizedLocalPaymentReversal. The default value is false in case you do not configure it.

      • setSynchronizedLocalPaymentReversal

        public void setSynchronizedLocalPaymentReversal(boolean synchronizedLocalPaymentReversal)
        This method sets value of SynchronizedLocalPaymentReversal.
        Parameters:
        synchronizedLocalPaymentReversal - the configuration value of SynchronizedLocalPaymentReversal. The default value is false in case you do not set it.

      • toString

        public java.lang.String toString()

        This method obtains a human-readable representation of the PluginConfiguration.

        Specified by:
        toString in interface PluginConfiguration
        Overrides:
        toString in class java.lang.Object
        Returns:
        A human-readable representation of the PluginConfiguration.

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

        This method returns a shallow copy of this PluginConfigurationImpl instance.

        Overrides:
        clone in class java.lang.Object
        Returns:
        A shallow copy of this PluginConfigurationImpl instance.
        Throws:
        java.lang.CloneNotSupportedException - If the instance cannot be cloned.
Skip navigation links