com.ibm.commerce.campaigns.cache

Class EmarketingSpotInvocationRegistry

  • java.lang.Object
    • com.ibm.commerce.campaigns.cache.EmarketingSpotInvocationRegistry
  • All Implemented Interfaces:
    com.ibm.commerce.registry.Registry


    public class EmarketingSpotInvocationRegistry
    extends java.lang.Object
    implements com.ibm.commerce.registry.Registry
    Provides a registry for access to the campaigns/cache/eMarketingSpotInvocationList.xml file used for campaign caching.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CAMPAIGN_ESPOT_INVOCATION_CONFIG_XML
      The XML file used to configure the e-Marketing Spot invocations for the site.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Collection getEMarketingSpotInvokerEntries(java.lang.Integer storeId, java.lang.String commandName)
      Returns a Collection of EMarketingSpotInvoker objects that represent the EMarketingSpots a command will invoke.
      static EmarketingSpotInvocationRegistry getInstance()
      Returns an instance of this class.
      void initialize()
      Initializes the registry by loading the campaigns/cache/EmarketingSpotInvocationList.xml file found in the classpath.
      void refresh()
      Refreshes the registry.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • CAMPAIGN_ESPOT_INVOCATION_CONFIG_XML

        public static final java.lang.String CAMPAIGN_ESPOT_INVOCATION_CONFIG_XML
        The XML file used to configure the e-Marketing Spot invocations for the site.
        See Also:
        Constant Field Values
      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • EmarketingSpotInvocationRegistry

        public EmarketingSpotInvocationRegistry()
    • Method Detail

      • getEMarketingSpotInvokerEntries

        public java.util.Collection getEMarketingSpotInvokerEntries(java.lang.Integer storeId,
                                                                    java.lang.String commandName)
        Returns a Collection of EMarketingSpotInvoker objects that represent the EMarketingSpots a command will invoke.
        Parameters:
        storeId - The store ID underwhich the command is running.
        commandName - The name of the command that is to be executed.
        Returns:
        a Collection of EMarketingSpotInvoker objects.
      • initialize

        public void initialize()
                        throws java.lang.Exception
        Initializes the registry by loading the campaigns/cache/EmarketingSpotInvocationList.xml file found in the classpath.
        Specified by:
        initialize in interface com.ibm.commerce.registry.Registry
        Throws:
        java.lang.Exception - thrown when the registry fails to initialize.
      • refresh

        public void refresh()
                     throws java.lang.Exception
        Refreshes the registry.
        Specified by:
        refresh in interface com.ibm.commerce.registry.Registry
        Throws:
        java.lang.Exception - thrown when the registry fails to refresh.