com.ibm.commerce.bi

Class BIConfigRegistry

  • java.lang.Object
    • com.ibm.commerce.bi.BIConfigRegistry
  • All Implemented Interfaces:
    Registry


    public class BIConfigRegistry
    extends java.lang.Object
    implements Registry
    Provides a cached registry for access to various Analytics configuration parameters
    • Field Summary

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

      Constructors 
      Constructor and Description
      BIConfigRegistry() 
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Set getAllBIProviders(java.lang.Integer storeId)
      Returns all the business intelligence providers for the given store.
      java.lang.String getBIProvider(java.lang.Integer storeId)
      Returns the default business intelligence provider for the given store.
      java.lang.String getClientId(java.lang.Integer storeId)
      Returns the clientId for the store specified by the storeId
      java.lang.String getClientId(java.lang.Integer storeId, java.lang.String biProvider)
      Returns the clientId for the store specified by the storeId
      java.lang.String getConfigPath()
      Returns the Configuration Path
      java.lang.String getFooter(java.lang.Integer storeId)
      Returns the code snippet defined in the <footer> section of the configuration file
      java.lang.String getFooter(java.lang.Integer storeId, java.lang.String biProvider)
      Returns the code snippet defined in the <footer> section of the configuration file
      java.lang.String getHeader(java.lang.Integer storeId)
      Returns the code snippet defined in the <header> section of the configuration file
      java.lang.String getHeader(java.lang.Integer storeId, java.lang.String biProvider)
      Returns the code snippet defined in the <header> section of the configuration file
      static BIConfigRegistry getInstance()
      Singleton method to return an instance of this class
      java.lang.String getInstrumentation(java.lang.Integer storeId)
      Returns the code snippet defined in the <instrumentation> section of the configuration file
      java.lang.String getInstrumentation(java.lang.Integer storeId, java.lang.String biProvider)
      Returns the code snippet defined in the <instrumentation> section of the configuration file
      java.lang.String getMarketingCenterURL(java.lang.Integer storeId)
      Returns the marketingCenterUrl for the store specified by the storeId
      java.lang.String getMarketingCenterURL(java.lang.Integer storeId, java.lang.String biProvider)
      Returns the marketingCenterURL for the store specified by the storeId
      java.util.HashMap getOptionsAsHashMap(java.lang.Integer storeId)
      Returns the value of the options properly as a HashMap for the store specified by the storeId.
      java.util.HashMap getOptionsAsHashMap(java.lang.Integer storeId, java.lang.String biProvider)
      Returns the value of the options property as a HashMap for the store specified by the storeId.
      java.lang.String getOptionValue(java.lang.Integer storeId, java.lang.String optionName)
      Returns the value of the given option entry in the options property
      java.lang.String getOptionValue(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String optionName)
      Returns the value of the given option entry in the options property
      boolean getOptionValueAsBoolean(java.lang.Integer storeId, java.lang.String optionName)
      Returns the value of the given option entry in the options property as a boolean value.
      boolean getOptionValueAsBoolean(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String optionName)
      Returns the value of the given option entry in the options property as a boolean value.
      java.lang.String getOutputSection(java.lang.Integer storeId, java.lang.String sectionName)
      Returns the snippet that is added under the CDATA section of the output tag
      java.lang.String getOutputSection(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String sectionName)
      Returns the snippet that is added under the CDATA section of the output tag
      java.lang.String getSegmentExportMode(java.lang.Integer storeId)
      Returns the segment export mode specified in the biConfig.xml.
      java.lang.String getSegmentExportMode(java.lang.Integer storeId, java.lang.String biProvider)
      Returns the segment export mode specified in the biConfig.xml.
      java.lang.String getSSOKey()
      Returns the single sign-on (SSO) key to encrypt sensitive values.
      java.lang.String getStoreParam(java.lang.Integer storeId, java.lang.String paramName)
      Returns the Parameter value in the Store Node.
      java.lang.String getStoreParam(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName)
      Returns the Parameter value in the Store Node.
      java.util.HashMap getStoreParamAsHashMap(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName)
      Returns the Parameter value in the Store Node as a HashMap
      java.lang.Object getStoreParamAsObject(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName)
      Returns the Parameter value in the Store Node.
      java.lang.String getURL(java.lang.Integer storeId)
      Returns the url for the store specified by the storeId
      java.lang.String getURL(java.lang.Integer storeId, java.lang.String biProvider)
      Returns the url for the store specified by the storeId
      boolean includeShipAdjustInProductPrice(java.lang.Integer storeId)
      Checks if the includeShipAdjustInProductPrice flag is enabled for a particular store flag is on or off for a particular store
      boolean includeShipAdjustInProductPrice(java.lang.Integer storeId, java.lang.String biProvider)
      Checks if the includeShipAdjustInProductPrice flag is enabled for a particular store flag is on or off for a particular store
      void initialize()
      Initialize the registry by reading the BI configuration file (biConfig.xml) and setting the class properties
      boolean isDebug(java.lang.Integer storeId)
      Returns a boolean value specifying whether the debug flag is ON for a particular store.
      boolean isDebug(java.lang.Integer storeId, java.lang.String biProvider)
      Returns a boolean value specifying whether the debug flag is ON for a particular store.
      boolean isEnabled(java.lang.Integer storeId)
      Checks if the analytics feature is enabled for a particular store
      boolean isEnabled(java.lang.Integer storeId, java.lang.String biProvider)
      Checks if the analytics feature is enabled for a particular store
      boolean isJavaScriptDebug(java.lang.Integer storeId)
      This method is for IBM internal use only.
      boolean isJavaScriptDebug(java.lang.Integer storeId, java.lang.String biProvider)
      This method is for IBM internal use only.
      boolean isMarketingCenterEnabled(java.lang.Integer storeId)
      Checks if the marketing center is enabled.
      void refresh()
      Re-initializes the registry.
      java.lang.String selectBIProvider(java.lang.Integer storeId)
      Returns the BI Provider for the store only if there is one BI Provider set.
      void setBIProvider(java.lang.Integer storeId, java.lang.String biProvider)
      Sets the business intelligence provider for the given store.
      void setDebug(java.lang.Integer storeId, boolean bDebug)
      Sets the debug attribute for a particular store
      void setDebug(java.lang.Integer storeId, java.lang.String biProvider, boolean bDebug)
      Sets the debug attribute for a particular store
      void setEnabled(java.lang.Integer storeId, boolean bEnabled)
      Sets the enabled attribute for the store
      void setEnabled(java.lang.Integer storeId, java.lang.String biProvider, boolean bEnabled)
      Sets the enabled attribute for the store
      void setStoreParam(java.lang.Integer storeId, java.lang.String paramName, java.lang.String paramValue)
      Sets the Parameter value in the Store Node.
      void setStoreParam(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName, java.lang.Object paramValue)
      Sets the Parameter value in the Store Node.
      void setStoreParam(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName, java.lang.String paramValue)
      Sets the Parameter value in the Store Node.
      boolean useCMSetupOther(java.lang.Integer storeId)
      Checks if the useCMSetupOther flag is enabled for a particular store flag is on or off for a particular store
      boolean useCMSetupOther(java.lang.Integer storeId, java.lang.String biProvider)
      Checks if the useCMSetupOther flag is enabled for a particular store flag is on or off for a particular store
      boolean useCookies(java.lang.Integer storeId)
      Returns whether or not cookies are used to track the current category in the catalog.
      boolean useCookies(java.lang.Integer storeId, java.lang.String biProvider)
      Returns whether or not cookies are used to track the current category in the catalog.
      boolean useEmailForCustomerId(java.lang.Integer storeId)
      Returns a boolean value denoting whether the emailId of the customer should be used in place of the userId value for a particular store
      boolean useEmailForCustomerId(java.lang.Integer storeId, java.lang.String biProvider)
      Returns a boolean value denoting whether the emailId of the customer should be used in place of the userId value for a particular store
      boolean useHostedLibraries(java.lang.Integer storeId)
      Checks if the useHostedCMLibraries flag is enabled for a particular store flag is on or off for a particular store
      boolean useHostedLibraries(java.lang.Integer storeId, java.lang.String biProvider)
      Checks if the useHostedCMLibraries flag is enabled for a particular store flag is on or off for a particular store
      • Methods inherited from class java.lang.Object

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

      • COPYRIGHT

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

      • BIConfigRegistry

        public BIConfigRegistry()
    • Method Detail

      • initialize

        public void initialize()
                        throws java.lang.Exception
        Initialize the registry by reading the BI configuration file (biConfig.xml) and setting the class properties
        Specified by:
        initialize in interface Registry
        Throws:
        java.lang.Exception - Indicates that biConfig.xml file cannot be found.
      • refresh

        public void refresh()
                     throws java.lang.Exception
        Re-initializes the registry. If the biConfig.xml file has changed, it will be re-read and re-parsed.
        Specified by:
        refresh in interface Registry
        Throws:
        java.lang.Exception - If the biConfig.xml file cannot be found.
      • getInstance

        public static BIConfigRegistry getInstance()
        Singleton method to return an instance of this class
        Returns:
        BIConfigRegistry
      • getFooter

        public java.lang.String getFooter(java.lang.Integer storeId)
        Returns the code snippet defined in the <footer> section of the configuration file
        Parameters:
        storeId - The storeId.
        Returns:
        String Footer snippet code.
      • getFooter

        public java.lang.String getFooter(java.lang.Integer storeId,
                                          java.lang.String biProvider)
        Returns the code snippet defined in the <footer> section of the configuration file
        Parameters:
        storeId - The storeId.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        String Footer snippet code.
      • getHeader

        public java.lang.String getHeader(java.lang.Integer storeId)
        Returns the code snippet defined in the <header> section of the configuration file
        Parameters:
        storeId - The Store Id.
        Returns:
        String Header snippet code.
      • getHeader

        public java.lang.String getHeader(java.lang.Integer storeId,
                                          java.lang.String biProvider)
        Returns the code snippet defined in the <header> section of the configuration file
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        String Header snippet code.
      • getInstrumentation

        public java.lang.String getInstrumentation(java.lang.Integer storeId)
        Returns the code snippet defined in the <instrumentation> section of the configuration file
        Parameters:
        storeId - The Store Id.
        Returns:
        String Instrumentation snippet code.
      • getInstrumentation

        public java.lang.String getInstrumentation(java.lang.Integer storeId,
                                                   java.lang.String biProvider)
        Returns the code snippet defined in the <instrumentation> section of the configuration file
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        String Instrumentation snippet code.
      • isDebug

        public boolean isDebug(java.lang.Integer storeId)
        Returns a boolean value specifying whether the debug flag is ON for a particular store.
        Parameters:
        storeId - The Store Id.
        Returns:
        Returns the debug state for business intelligence (analytics) for the specified store.
      • isDebug

        public boolean isDebug(java.lang.Integer storeId,
                               java.lang.String biProvider)
        Returns a boolean value specifying whether the debug flag is ON for a particular store.
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        Returns the debug state for business intelligence (analytics) for the specified store.
      • setDebug

        public void setDebug(java.lang.Integer storeId,
                             boolean bDebug)
        Sets the debug attribute for a particular store
        Parameters:
        storeId - The Store Id.
        bDebug - Debug mode Sets whether business intelligence (analytics) is in debug mode for the specified store.
      • setDebug

        public void setDebug(java.lang.Integer storeId,
                             java.lang.String biProvider,
                             boolean bDebug)
        Sets the debug attribute for a particular store
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        bDebug - Debug mode Sets whether business intelligence (analytics) is in debug mode for the specified store.
      • isJavaScriptDebug

        public boolean isJavaScriptDebug(java.lang.Integer storeId)
        This method is for IBM internal use only. Returns a boolean value specifying whether the javascript debug flag is ON for a particular store.
        Parameters:
        storeId - The Store Id.
        Returns:
        Returns the javascript debug state for business intelligence (analytics) for the specified store.
      • isJavaScriptDebug

        public boolean isJavaScriptDebug(java.lang.Integer storeId,
                                         java.lang.String biProvider)
        This method is for IBM internal use only. Returns a boolean value specifying whether the javascript debug flag is ON for a particular store.
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        Returns the javascript debug state for business intelligence (analytics) for the specified store.
      • isEnabled

        public boolean isEnabled(java.lang.Integer storeId)
        Checks if the analytics feature is enabled for a particular store
        Parameters:
        storeId - The store Id.
        Returns:
        boolean Whether the analytics featured is turned ON for the store
      • isEnabled

        public boolean isEnabled(java.lang.Integer storeId,
                                 java.lang.String biProvider)
        Checks if the analytics feature is enabled for a particular store
        Parameters:
        storeId - The store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        boolean Whether the analytics featured is turned ON for the store
      • setEnabled

        public void setEnabled(java.lang.Integer storeId,
                               boolean bEnabled)
        Sets the enabled attribute for the store
        Parameters:
        storeId - The store Id.
        bEnabled - Sets whether business intelligence (analytics) is enabled for the specified store.
      • setEnabled

        public void setEnabled(java.lang.Integer storeId,
                               java.lang.String biProvider,
                               boolean bEnabled)
        Sets the enabled attribute for the store
        Parameters:
        storeId - The store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        bEnabled - Sets whether business intelligence (analytics) is enabled for the specified store.
      • getAllBIProviders

        public java.util.Set getAllBIProviders(java.lang.Integer storeId)
        Returns all the business intelligence providers for the given store. For example, "coremetrics".
        Parameters:
        storeId - The store identifier
        Returns:
        the business intelligence providers for the given store. If one isn't defined or the store identifier is invalid, null is returned.
      • getBIProvider

        public java.lang.String getBIProvider(java.lang.Integer storeId)
        Returns the default business intelligence provider for the given store. For example, "coremetrics".
        Parameters:
        storeId - The store identifier
        Returns:
        the business intelligence provider for the given store. If one isn't defined or the store identifier is invalid, an empty string is returned.
      • setBIProvider

        public void setBIProvider(java.lang.Integer storeId,
                                  java.lang.String biProvider)
        Sets the business intelligence provider for the given store.
        Parameters:
        storeId - The store identifier
        biProvider - A string that represents a business intelligence provider as defined in biConfig.xml
      • useCookies

        public boolean useCookies(java.lang.Integer storeId)
        Returns whether or not cookies are used to track the current category in the catalog.
        Parameters:
        storeId - The store id.
        Returns:
        Returns true if cookies are used to track the current category in the catalog.
      • useCookies

        public boolean useCookies(java.lang.Integer storeId,
                                  java.lang.String biProvider)
        Returns whether or not cookies are used to track the current category in the catalog.
        Parameters:
        storeId - The store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        Returns true if cookies are used to track the current category in the catalog.
      • getClientId

        public java.lang.String getClientId(java.lang.Integer storeId)
        Returns the clientId for the store specified by the storeId
        Parameters:
        storeId - The storeId of the store for which the clientId will be returned
        Returns:
        The clientId
      • getClientId

        public java.lang.String getClientId(java.lang.Integer storeId,
                                            java.lang.String biProvider)
        Returns the clientId for the store specified by the storeId
        Parameters:
        storeId - The storeId of the store for which the clientId will be returned
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        The clientId
      • getOptionsAsHashMap

        public java.util.HashMap getOptionsAsHashMap(java.lang.Integer storeId)
        Returns the value of the options properly as a HashMap for the store specified by the storeId.
        Parameters:
        storeId - The storeId of the store for which the options will be returned.
        Returns:
        The options as a HashMap. Null if options is not defined.
      • getOptionsAsHashMap

        public java.util.HashMap getOptionsAsHashMap(java.lang.Integer storeId,
                                                     java.lang.String biProvider)
        Returns the value of the options property as a HashMap for the store specified by the storeId.
        Parameters:
        storeId - The storeId of the store for which the options will be returned.
        biProvider - The name of the BI provider as defined in biConfig.xml.
        Returns:
        The options as a HashMap. Null if options is not defined.
      • getOptionValue

        public java.lang.String getOptionValue(java.lang.Integer storeId,
                                               java.lang.String optionName)
        Returns the value of the given option entry in the options property
        Parameters:
        storeId - The Store Id.
        optionName - The name of the option entry
        Returns:
        Returns the value of the given option entry in the options property. Null if the option does not exist.
      • getOptionValue

        public java.lang.String getOptionValue(java.lang.Integer storeId,
                                               java.lang.String biProvider,
                                               java.lang.String optionName)
        Returns the value of the given option entry in the options property
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        optionName - The name of the option entry
        Returns:
        Returns the value of the given option entry in the options property. Null if the option does not exist.
      • getOptionValueAsBoolean

        public boolean getOptionValueAsBoolean(java.lang.Integer storeId,
                                               java.lang.String optionName)
        Returns the value of the given option entry in the options property as a boolean value.
        Parameters:
        storeId - The Store Id.
        optionName - The name of the option entry
        Returns:
        Returns the value of the given option entry in the options property as a boolean value. True if the option exist and it is set to true (implicitly or explicitly), false otherwise (even if the option contains a non-boolean value).
      • getOptionValueAsBoolean

        public boolean getOptionValueAsBoolean(java.lang.Integer storeId,
                                               java.lang.String biProvider,
                                               java.lang.String optionName)
        Returns the value of the given option entry in the options property as a boolean value.
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        optionName - The name of the option entry
        Returns:
        Returns the value of the given option entry in the options property as a boolean value. True if the option exist and it is set to true (implicitly or explicitly), false otherwise (even if the option contains a non-boolean value).
      • getURL

        public java.lang.String getURL(java.lang.Integer storeId)
        Returns the url for the store specified by the storeId
        Parameters:
        storeId - The storeId of the store for which the url will be returned
        Returns:
        The url
      • getURL

        public java.lang.String getURL(java.lang.Integer storeId,
                                       java.lang.String biProvider)
        Returns the url for the store specified by the storeId
        Parameters:
        storeId - The storeId of the store for which the url will be returned
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        The url
      • getMarketingCenterURL

        public java.lang.String getMarketingCenterURL(java.lang.Integer storeId)
        Returns the marketingCenterUrl for the store specified by the storeId
        Parameters:
        storeId - The storeId of the store for which the marketingCenterUrl will be returned
        Returns:
        The marketingCenterUrl
      • getMarketingCenterURL

        public java.lang.String getMarketingCenterURL(java.lang.Integer storeId,
                                                      java.lang.String biProvider)
        Returns the marketingCenterURL for the store specified by the storeId
        Parameters:
        storeId - The storeId of the store for which the marketingCenterURL will be returned
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        The marketingCenterURL
      • useHostedLibraries

        public boolean useHostedLibraries(java.lang.Integer storeId)
        Checks if the useHostedCMLibraries flag is enabled for a particular store flag is on or off for a particular store
        Parameters:
        storeId - The Store Id.
        Returns:
        boolean Whether the useHostedCMLibraries is turned ON for the store
      • useHostedLibraries

        public boolean useHostedLibraries(java.lang.Integer storeId,
                                          java.lang.String biProvider)
        Checks if the useHostedCMLibraries flag is enabled for a particular store flag is on or off for a particular store
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        boolean Whether the useHostedCMLibraries is turned ON for the store
      • useEmailForCustomerId

        public boolean useEmailForCustomerId(java.lang.Integer storeId)
        Returns a boolean value denoting whether the emailId of the customer should be used in place of the userId value for a particular store
        Parameters:
        storeId - The Store Id.
        Returns:
        Returns a boolean value
      • useEmailForCustomerId

        public boolean useEmailForCustomerId(java.lang.Integer storeId,
                                             java.lang.String biProvider)
        Returns a boolean value denoting whether the emailId of the customer should be used in place of the userId value for a particular store
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        Returns a boolean value
      • useCMSetupOther

        public boolean useCMSetupOther(java.lang.Integer storeId)
        Checks if the useCMSetupOther flag is enabled for a particular store flag is on or off for a particular store
        Parameters:
        storeId - The Store Id.
        Returns:
        boolean Whether the useCMSetupOther is turned ON for the store. useCMSetupOther is on by default.
      • useCMSetupOther

        public boolean useCMSetupOther(java.lang.Integer storeId,
                                       java.lang.String biProvider)
        Checks if the useCMSetupOther flag is enabled for a particular store flag is on or off for a particular store
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        boolean Whether the useCMSetupOther is turned ON for the store. useCMSetupOther is on by default.
      • includeShipAdjustInProductPrice

        public boolean includeShipAdjustInProductPrice(java.lang.Integer storeId)
        Checks if the includeShipAdjustInProductPrice flag is enabled for a particular store flag is on or off for a particular store
        Parameters:
        storeId - The Store Id.
        Returns:
        boolean Whether the includeShipAdjustInProductPrice is turned ON for the store. includeShipAdjustInProductPrice is on by default.
      • includeShipAdjustInProductPrice

        public boolean includeShipAdjustInProductPrice(java.lang.Integer storeId,
                                                       java.lang.String biProvider)
        Checks if the includeShipAdjustInProductPrice flag is enabled for a particular store flag is on or off for a particular store
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        boolean Whether the includeShipAdjustInProductPrice is turned ON for the store. includeShipAdjustInProductPrice is on by default.
      • getOutputSection

        public java.lang.String getOutputSection(java.lang.Integer storeId,
                                                 java.lang.String sectionName)
        Returns the snippet that is added under the CDATA section of the output tag
        Parameters:
        storeId - The Store Id.
        sectionName - The name of the section which is associated with the snippet
        Returns:
        The snippet added in the CDATA section
      • getOutputSection

        public java.lang.String getOutputSection(java.lang.Integer storeId,
                                                 java.lang.String biProvider,
                                                 java.lang.String sectionName)
        Returns the snippet that is added under the CDATA section of the output tag
        Parameters:
        storeId - The Store Id.
        biProvider - The name of the BI provider as defined in biConfig.xml
        sectionName - The name of the section which is associated with the snippet
        Returns:
        The snippet added in the CDATA section
      • getSegmentExportMode

        public java.lang.String getSegmentExportMode(java.lang.Integer storeId)
        Returns the segment export mode specified in the biConfig.xml. If a mode is not specified, the method returns null
        Parameters:
        storeId - The store identifier
        Returns:
        The segment export mode
      • getSegmentExportMode

        public java.lang.String getSegmentExportMode(java.lang.Integer storeId,
                                                     java.lang.String biProvider)
        Returns the segment export mode specified in the biConfig.xml. If a mode is not specified, the method returns null
        Parameters:
        storeId - The store identifier
        biProvider - The name of the BI provider as defined in biConfig.xml
        Returns:
        The segment export mode
      • getSSOKey

        public java.lang.String getSSOKey()
        Returns the single sign-on (SSO) key to encrypt sensitive values. If not defined, an empty string is returned.
        Returns:
        The SSO key or empty string if the key is not configured.
      • getStoreParam

        public java.lang.String getStoreParam(java.lang.Integer storeId,
                                              java.lang.String paramName)
        Returns the Parameter value in the Store Node.
        Parameters:
        storeId - The store identifier
        paramName - parameter name
        Returns:
        Store Parameter
      • getStoreParam

        public java.lang.String getStoreParam(java.lang.Integer storeId,
                                              java.lang.String biProvider,
                                              java.lang.String paramName)
        Returns the Parameter value in the Store Node.
        Parameters:
        storeId - The store identifier
        biProvider - The name of the BI provider as defined in biConfig.xml
        paramName - parameter name
        Returns:
        Store Parameter
      • getStoreParamAsObject

        public java.lang.Object getStoreParamAsObject(java.lang.Integer storeId,
                                                      java.lang.String biProvider,
                                                      java.lang.String paramName)
        Returns the Parameter value in the Store Node.
        Parameters:
        storeId - The store identifier
        biProvider - The name of the BI provider as defined in biConfig.xml
        paramName - parameter name
        Returns:
        Store Parameter
      • getStoreParamAsHashMap

        public java.util.HashMap getStoreParamAsHashMap(java.lang.Integer storeId,
                                                        java.lang.String biProvider,
                                                        java.lang.String paramName)
        Returns the Parameter value in the Store Node as a HashMap
        Parameters:
        storeId - The store identifier
        biProvider - The name of the BI provider as defined in biConfig.xml
        paramName - parameter name
        Returns:
        Store Parameter as a HashMap
      • setStoreParam

        public void setStoreParam(java.lang.Integer storeId,
                                  java.lang.String paramName,
                                  java.lang.String paramValue)
        Sets the Parameter value in the Store Node.
        Parameters:
        storeId - The store identifier
        paramName - parameter name
        paramValue - parameter value
      • setStoreParam

        public void setStoreParam(java.lang.Integer storeId,
                                  java.lang.String biProvider,
                                  java.lang.String paramName,
                                  java.lang.String paramValue)
        Sets the Parameter value in the Store Node.
        Parameters:
        storeId - The store identifier
        biProvider - The name of the BI provider as defined in biConfig.xml
        paramName - parameter name
        paramValue - parameter value
      • setStoreParam

        public void setStoreParam(java.lang.Integer storeId,
                                  java.lang.String biProvider,
                                  java.lang.String paramName,
                                  java.lang.Object paramValue)
        Sets the Parameter value in the Store Node.
        Parameters:
        storeId - The store identifier
        biProvider - The name of the BI provider as defined in biConfig.xml
        paramName - parameter name
        paramValue - parameter value
      • getConfigPath

        public java.lang.String getConfigPath()
        Returns the Configuration Path
        Returns:
        Configuration Path
      • selectBIProvider

        public java.lang.String selectBIProvider(java.lang.Integer storeId)
        Returns the BI Provider for the store only if there is one BI Provider set. It returns a default BI provider otherwise.
        Parameters:
        storeId - The store identifier.
        Returns:
        BI Provider name.
      • isMarketingCenterEnabled

        public boolean isMarketingCenterEnabled(java.lang.Integer storeId)
        Checks if the marketing center is enabled.
        Parameters:
        storeId - a store ID
        Returns:
        true if the marketing center is enabled.