Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
Constructor and Description |
---|
BIConfigRegistry() |
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 |
void |
setDebug(java.lang.Integer storeId,
java.lang.String biProvider,
boolean bDebug)
Sets the
debug |
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 |
public static final java.lang.String COPYRIGHT
public void initialize() throws java.lang.Exception
initialize
in interface Registry
java.lang.Exception
- Indicates that biConfig.xml file cannot be found.public void refresh() throws java.lang.Exception
public static BIConfigRegistry getInstance()
public java.lang.String getFooter(java.lang.Integer storeId)
storeId
- The storeId.public java.lang.String getFooter(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The storeId.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic java.lang.String getHeader(java.lang.Integer storeId)
storeId
- The Store Id.public java.lang.String getHeader(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic java.lang.String getInstrumentation(java.lang.Integer storeId)
storeId
- The Store Id.public java.lang.String getInstrumentation(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic boolean isDebug(java.lang.Integer storeId)
storeId
- The Store Id.public boolean isDebug(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic void setDebug(java.lang.Integer storeId, boolean bDebug)
debug attribute for a particular store
storeId
- The Store Id.bDebug
- Debug mode Sets whether business intelligence (analytics) is in debug mode for the specified store.public void setDebug(java.lang.Integer storeId, java.lang.String biProvider, boolean bDebug)
debug attribute for a particular store
storeId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlbDebug
- Debug mode Sets whether business intelligence (analytics) is in debug mode for the specified store.public boolean isJavaScriptDebug(java.lang.Integer storeId)
storeId
- The Store Id.public boolean isJavaScriptDebug(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic boolean isEnabled(java.lang.Integer storeId)
storeId
- The store Id.public boolean isEnabled(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic void setEnabled(java.lang.Integer storeId, boolean bEnabled)
enabled
attribute for the storestoreId
- The store Id.bEnabled
- Sets whether business intelligence (analytics) is enabled for the specified store.public void setEnabled(java.lang.Integer storeId, java.lang.String biProvider, boolean bEnabled)
enabled
attribute for the storestoreId
- The store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlbEnabled
- Sets whether business intelligence (analytics) is enabled for the specified store.public java.util.Set getAllBIProviders(java.lang.Integer storeId)
storeId
- The store identifierpublic java.lang.String getBIProvider(java.lang.Integer storeId)
storeId
- The store identifierpublic void setBIProvider(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The store identifierbiProvider
- A string that represents a business intelligence provider as defined in biConfig.xmlpublic boolean useCookies(java.lang.Integer storeId)
storeId
- The store id.public boolean useCookies(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic java.lang.String getClientId(java.lang.Integer storeId)
clientId
for the store specified by the storeId
storeId
- The storeId
of the store for which the clientId
will be returnedclientId
public java.lang.String getClientId(java.lang.Integer storeId, java.lang.String biProvider)
clientId
for the store specified by the storeId
storeId
- The storeId
of the store for which the clientId
will be returnedbiProvider
- The name of the BI provider as defined in biConfig.xmlclientId
public java.util.HashMap getOptionsAsHashMap(java.lang.Integer storeId)
options
properly as a HashMap for the store specified by the storeId
.storeId
- The storeId
of the store for which the options
will be returned.options
as a HashMap. Null if options
is not defined.public java.util.HashMap getOptionsAsHashMap(java.lang.Integer storeId, java.lang.String biProvider)
options
property as a HashMap for the store specified by the storeId
.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.options
as a HashMap. Null if options
is not defined.public java.lang.String getOptionValue(java.lang.Integer storeId, java.lang.String optionName)
options
propertystoreId
- The Store Id.optionName
- The name of the option entryoptions
property. Null if the option does not exist.public java.lang.String getOptionValue(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String optionName)
options
propertystoreId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmloptionName
- The name of the option entryoptions
property. Null if the option does not exist.public boolean getOptionValueAsBoolean(java.lang.Integer storeId, java.lang.String optionName)
options
property as a boolean value.storeId
- The Store Id.optionName
- The name of the option entryoptions
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).public boolean getOptionValueAsBoolean(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String optionName)
options
property as a boolean value.storeId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmloptionName
- The name of the option entryoptions
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).public java.lang.String getURL(java.lang.Integer storeId)
url
for the store specified by the storeId
storeId
- The storeId
of the store for which the url
will be returnedurl
public java.lang.String getURL(java.lang.Integer storeId, java.lang.String biProvider)
url
for the store specified by the storeId
storeId
- The storeId
of the store for which the url
will be returnedbiProvider
- The name of the BI provider as defined in biConfig.xmlurl
public java.lang.String getMarketingCenterURL(java.lang.Integer storeId)
marketingCenterUrl
for the store specified by the storeId
storeId
- The storeId
of the store for which the marketingCenterUrl
will be returnedmarketingCenterUrl
public java.lang.String getMarketingCenterURL(java.lang.Integer storeId, java.lang.String biProvider)
marketingCenterURL
for the store specified by the storeId
storeId
- The storeId
of the store for which the marketingCenterURL
will be returnedbiProvider
- The name of the BI provider as defined in biConfig.xmlmarketingCenterURL
public boolean useHostedLibraries(java.lang.Integer storeId)
useHostedCMLibraries
flag is enabled for a particular store
flag is on or off for a particular storestoreId
- The Store Id.public boolean useHostedLibraries(java.lang.Integer storeId, java.lang.String biProvider)
useHostedCMLibraries
flag is enabled for a particular store
flag is on or off for a particular storestoreId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic boolean useEmailForCustomerId(java.lang.Integer storeId)
emailId
of the customer should be
used in place of the userId
value for a particular storestoreId
- The Store Id.public boolean useEmailForCustomerId(java.lang.Integer storeId, java.lang.String biProvider)
emailId
of the customer should be
used in place of the userId
value for a particular storestoreId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic boolean useCMSetupOther(java.lang.Integer storeId)
useCMSetupOther
flag is enabled for a particular store
flag is on or off for a particular storestoreId
- The Store Id.public boolean useCMSetupOther(java.lang.Integer storeId, java.lang.String biProvider)
useCMSetupOther
flag is enabled for a particular store
flag is on or off for a particular storestoreId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic boolean includeShipAdjustInProductPrice(java.lang.Integer storeId)
includeShipAdjustInProductPrice
flag is enabled for a particular store
flag is on or off for a particular storestoreId
- The Store Id.public boolean includeShipAdjustInProductPrice(java.lang.Integer storeId, java.lang.String biProvider)
includeShipAdjustInProductPrice
flag is enabled for a particular store
flag is on or off for a particular storestoreId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlpublic java.lang.String getOutputSection(java.lang.Integer storeId, java.lang.String sectionName)
output
tagstoreId
- The Store Id.sectionName
- The name of the section which is associated with the snippetpublic java.lang.String getOutputSection(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String sectionName)
output
tagstoreId
- The Store Id.biProvider
- The name of the BI provider as defined in biConfig.xmlsectionName
- The name of the section which is associated with the snippetpublic java.lang.String getSegmentExportMode(java.lang.Integer storeId)
storeId
- The store identifierpublic java.lang.String getSegmentExportMode(java.lang.Integer storeId, java.lang.String biProvider)
storeId
- The store identifierbiProvider
- The name of the BI provider as defined in biConfig.xmlpublic java.lang.String getSSOKey()
public java.lang.String getStoreParam(java.lang.Integer storeId, java.lang.String paramName)
storeId
- The store identifierparamName
- parameter namepublic java.lang.String getStoreParam(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName)
storeId
- The store identifierbiProvider
- The name of the BI provider as defined in biConfig.xmlparamName
- parameter namepublic java.lang.Object getStoreParamAsObject(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName)
storeId
- The store identifierbiProvider
- The name of the BI provider as defined in biConfig.xmlparamName
- parameter namepublic java.util.HashMap getStoreParamAsHashMap(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName)
storeId
- The store identifierbiProvider
- The name of the BI provider as defined in biConfig.xmlparamName
- parameter namepublic void setStoreParam(java.lang.Integer storeId, java.lang.String paramName, java.lang.String paramValue)
storeId
- The store identifierparamName
- parameter nameparamValue
- parameter valuepublic void setStoreParam(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName, java.lang.String paramValue)
storeId
- The store identifierbiProvider
- The name of the BI provider as defined in biConfig.xmlparamName
- parameter nameparamValue
- parameter valuepublic void setStoreParam(java.lang.Integer storeId, java.lang.String biProvider, java.lang.String paramName, java.lang.Object paramValue)
storeId
- The store identifierbiProvider
- The name of the BI provider as defined in biConfig.xmlparamName
- parameter nameparamValue
- parameter valuepublic java.lang.String getConfigPath()
public java.lang.String selectBIProvider(java.lang.Integer storeId)
storeId
- The store identifier.public boolean isMarketingCenterEnabled(java.lang.Integer storeId)
storeId
- a store ID