com.ibm.commerce.emarketing.config

Class BiConfigEmailRegistry

java.lang.Object

com.ibm.commerce.emarketing.config.BiConfigEmailRegistry

All Implemented Interfaces:

com.ibm.commerce.registry.Registry

public class BiConfigEmailRegistry
extends java.lang.Object
implements com.ibm.commerce.registry.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
BiConfigEmailRegistry()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientId(java.lang.Integer storeId) Returns the clientId for the store specified by the storeId
static BiConfigEmailRegistry	getInstance() Singleton method to return an instance of this class
java.lang.String	getProvider(java.lang.Integer storeId) Gets the analytics provider for the given store
void	initialize() Initiative the registry by reading the BI configuration file (biConfig.xml) and setting the class properties
boolean	isEnabled(java.lang.Integer storeId) Checks whether coremetrics is enabled for the particluar store
void	refresh() Re-initializes the registry.

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

BiConfigEmailRegistry

public BiConfigEmailRegistry()

Method Detail

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

getInstance

public static BiConfigEmailRegistry getInstance()

Singleton method to return an instance of this class

Returns:

BiConfigEmailRegistry

getProvider

public java.lang.String getProvider(java.lang.Integer storeId)

Gets the analytics provider for the given store

Parameters:

storeId - The storeId of the store

Returns:

Returns the name of the analytics provider name or null if the storeId is invalid

initialize

public void initialize()
                throws java.lang.Exception

Initiative the registry by reading the BI configuration file (biConfig.xml) and setting the class properties

Specified by:

initialize in interface com.ibm.commerce.registry.Registry

Throws:

java.lang.Exception - Indicates that biConfig.xml file cannot be found.

isEnabled

public boolean isEnabled(java.lang.Integer storeId)

Checks whether coremetrics is enabled for the particluar store

Parameters:

storeId - The storeId of the store

Returns:

Returns the enablement state for business intelligence (analytics) for the specified store.

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 com.ibm.commerce.registry.Registry

Throws:

java.lang.Exception - If the biConfig.xml file cannot be found.