com.ibm.commerce.payments.plugin

Interface PluginConfiguration

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    PluginConfigurationImpl

    public interface PluginConfiguration
extends java.io.Serializable

    This interface is the plug-in metadata and configuration.

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

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The IBM copyright notice field.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getHomeClass()
      This method gets the fully qualified name of the plug-in's Stateless Session Bean home class.
      java.lang.String getLookupName()
      This method gets the Java Naming and Directory Interface (JNDI) lookup name for the plug-in's Stateless Session Bean home.
      java.lang.String getName()
      This method gets the name of the plug-in implementation.
      java.util.HashMap getProperties()
      This method gets the list of plug-in specific properties.
      java.lang.String getVendor()
      This method gets the name of the vendor implementing the plug-in.
      java.lang.String getVersion()
      This method gets the version of the plug-in implementation.
      java.lang.String getVirtualTerminal()
      This method gets the URL of the payment back-end system administration user interface.
      boolean isIndepedentCreditSupported()
      This method checks if the plug-in supports independent credits.
      java.lang.String toString()
      This method Obtains a human-readable representation of the PluginConfiguration.

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The IBM copyright notice field.
        See Also:
        Constant Field Values

    • Method Detail

      • getHomeClass

        java.lang.String getHomeClass()
        This method gets the fully qualified name of the plug-in's Stateless Session Bean home class.
        Returns:
        The fully qualified name of the plug-in's Stateless Session Bean home class.

      • isIndepedentCreditSupported

        boolean isIndepedentCreditSupported()

        This method checks if the plug-in supports independent credits.

        For a description of dependent and independent credits, please refer to Credit.

        Returns:
        If the plug-in supports independent credits.

      • getLookupName

        java.lang.String getLookupName()
        This method gets the Java Naming and Directory Interface (JNDI) lookup name for the plug-in's Stateless Session Bean home.
        Returns:
        The Java Naming and Directory Interface (JNDI) lookup name for the plug-in's Stateless Session Bean Home.

      • getName

        java.lang.String getName()
        This method gets the name of the plug-in implementation.
        Returns:
        The name of the plug-in implementation.

      • getProperties

        java.util.HashMap getProperties()
        This method gets the list of plug-in specific properties.
        Returns:
        The list of plug-in specific properties.

      • getVendor

        java.lang.String getVendor()
        This method gets the name of the vendor implementing the plug-in.
        Returns:
        The name of the vendor implementing the plug-in.

      • getVersion

        java.lang.String getVersion()
        This method gets the version of the plug-in implementation.
        Returns:
        The version of the plug-in implementation.

      • getVirtualTerminal

        java.lang.String getVirtualTerminal()
        This method gets the URL of the payment back-end system administration user interface.
        Returns:
        The URL of the payment back-end system administration user interface.

      • toString

        java.lang.String toString()

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

        Overrides:
        toString in class java.lang.Object
        Returns:
        A human-readable representation of the PluginConfiguration.
Skip navigation links