atg.adc
Class ADCConfiguration

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.adc.ADCConfiguration

All Implemented Interfaces:

atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

Direct Known Subclasses:

CommerceADCConfiguration

public class ADCConfiguration
extends GenericService

This is the base class for the global configuration of the auto-tagging feature.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

ADCConfiguration()

Method Summary

java.lang.String[]	getCategoryIdQueryArgs()
java.lang.String[]	getCategoryPages()
Cache	getCategoryPagesCache()
java.lang.String	getDefaultCategory()
java.lang.String	getDefaultPageName()
atg.core.util.OrderedHashtable	getPageCategories()
Cache	getPageCategoryCache()
Cache	getPageNameCache()
atg.core.util.OrderedHashtable	getPageNames()
java.lang.String[]	getProductIdQueryArgs()
boolean	isDevMode()
boolean	isSimulationMode()
boolean	isTagWebApps()
boolean	isUsePreviousRequestCategoryId()
void	setCategoryIdQueryArgs(java.lang.String[] pCategoryIdQueryArgs) An array of query arguments that specify which product category is being viewed
void	setCategoryPages(java.lang.String[] pCategoryPages) The pages on which the categoryIdQueryArgs should be looked for.
void	setCategoryPagesCache(Cache pCategoryPagesCache) The cache storing whether URLs match CategoryPagePatterns
void	setDefaultCategory(java.lang.String pDefaultCategory) The default category.
void	setDefaultPageName(java.lang.String pDefaultPageName) The default page name.
void	setDevMode(boolean pDevMode) boolean indicating if running in development mode, as opposed to production mode
void	setPageCategories(atg.core.util.OrderedHashtable pPageCategories) The set of available page categories.
void	setPageCategoryCache(Cache pPageCategoryCache) The cache in which site URLs are stored with their mapped page categories.
void	setPageNameCache(Cache pPageNameCache) The cache in which site URLs are stored with their mapped page names.
void	setPageNames(atg.core.util.OrderedHashtable pPageNames) The set of available page names.
void	setProductIdQueryArgs(java.lang.String[] pProductIdQueryArgs) An array of query arguments that specify which product is being viewed.
void	setSimulationMode(boolean pSimulationMode) Boolean indicating if running in "simulation" mode
void	setTagWebApps(boolean pTagWebApps) boolean indicating if the ADCDataInsertServlet should tag JSP pages in web apps.
void	setUsePreviousRequestCategoryId(boolean pUsePreviousRequestCategoryId) Boolean indicating if the category associated with the previous request should be used to get the category parameter value if the category was not set by a droplet, JSP tag, or query string parameter.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ADCConfiguration

public ADCConfiguration()

Method Detail

setCategoryIdQueryArgs

public void setCategoryIdQueryArgs(java.lang.String[] pCategoryIdQueryArgs)

An array of query arguments that specify which product category is being viewed

Parameters:

pCategoryIdQueryArgs - an array of query arguments that specify the product category being viewed

getCategoryIdQueryArgs

public java.lang.String[] getCategoryIdQueryArgs()

Returns:

An array of query arguments that specify which product category is being viewed

setCategoryPages

public void setCategoryPages(java.lang.String[] pCategoryPages)

The pages on which the categoryIdQueryArgs should be looked for. Wildcard characters can be used. If this property is null, the categoryIdQueryArgs are looked for on all pages.

Parameters:

pCategoryPages - the pages on which the categoryIdQueryArgs should be looked for.

getCategoryPages

public java.lang.String[] getCategoryPages()

Returns:

the pages on which the categoryIdQueryArgs should be looked for.

setCategoryPagesCache

public void setCategoryPagesCache(Cache pCategoryPagesCache)

The cache storing whether URLs match CategoryPagePatterns

Parameters:

pCategoryPageCache - the cache storing whether URLs match CategoryPagePatterns

getCategoryPagesCache

public Cache getCategoryPagesCache()

Returns:

The cache storing whether URLs match CategoryPagePatterns

setDefaultCategory

public void setDefaultCategory(java.lang.String pDefaultCategory)

The default category. If the category can't be found from the request URL, this category can be used.

Parameters:

pDefaultCategory - the default category

getDefaultCategory

public java.lang.String getDefaultCategory()

Returns:

the default category. If the category can't be found from the requested url, this category can be used

setDefaultPageName

public void setDefaultPageName(java.lang.String pDefaultPageName)

The default page name. If the page name can't be found in the pageNames map from the request URL, this page name can be used.

Parameters:

pDefaultPageName - the default page name.

getDefaultPageName

public java.lang.String getDefaultPageName()

Returns:

the default page name. If the page name can't be found from the requested url, this page name can be used

setDevMode

public void setDevMode(boolean pDevMode)

boolean indicating if running in development mode, as opposed to production mode

Parameters:

pDevMode - boolean indicating if running in development mode, as opposed to production mode

isDevMode

public boolean isDevMode()

Returns:

boolean indicating if we are in development mode, as opposed to production mode

setPageCategories

public void setPageCategories(atg.core.util.OrderedHashtable pPageCategories)

The set of available page categories. This maps a url or partial url to a page category

Parameters:

pPageCategories - A map of URLs and partial URLs to page categories

getPageCategories

public atg.core.util.OrderedHashtable getPageCategories()

Returns:

The set of available pages categories. This maps a url or partial url to a page category.

setPageCategoryCache

public void setPageCategoryCache(Cache pPageCategoryCache)

The cache in which site URLs are stored with their mapped page categories.

Parameters:

pPageCategoryCache - The cache in which site URLs are stored with their mapped page categories.

getPageCategoryCache

public Cache getPageCategoryCache()

Returns:

The cache in which site URLs are stored with their mapped page categories.

setPageNameCache

public void setPageNameCache(Cache pPageNameCache)

The cache in which site URLs are stored with their mapped page names.

Parameters:

pPageNameCache - The cache in which site URLs are stored with their mapped page names.

getPageNameCache

public Cache getPageNameCache()

Returns:

The cache in which site URLs are stored with their mapped page names.

setPageNames

public void setPageNames(atg.core.util.OrderedHashtable pPageNames)

The set of available page names. This maps a url or partial url to a page name

Parameters:

pPageNames - A map of URLs and partial URLs to page names

getPageNames

public atg.core.util.OrderedHashtable getPageNames()

Returns:

The set of available page names. This maps a url or partial url to a page name.

setProductIdQueryArgs

public void setProductIdQueryArgs(java.lang.String[] pProductIdQueryArgs)

An array of query arguments that specify which product is being viewed.

Parameters:

pProductIdQueryArgs - an array of query arguments that specify which product is being viewed

getProductIdQueryArgs

public java.lang.String[] getProductIdQueryArgs()

Returns:

An array of query arguments that specify which product is being viewed

setSimulationMode

public void setSimulationMode(boolean pSimulationMode)

Boolean indicating if running in "simulation" mode

Parameters:

pSimulation - boolean indicating if running in "simulation" mode

isSimulationMode

public boolean isSimulationMode()

Returns:

boolean indicating if running in "simulation" mode

setTagWebApps

public void setTagWebApps(boolean pTagWebApps)

boolean indicating if the ADCDataInsertServlet should tag JSP pages in web apps. If this property is "false", then the ADCDataInsertFilter should be used to tag JSP pages.

Parameters:

pTagWebApps - boolean indicating if the ADCDataInsertServlet should tag JSP pages in web apps

isTagWebApps

public boolean isTagWebApps()

Returns:

boolean indicating if the ADCDataInsertServlet should tag JSP pages in WebApps

setUsePreviousRequestCategoryId

public void setUsePreviousRequestCategoryId(boolean pUsePreviousRequestCategoryId)

Boolean indicating if the category associated with the previous request should be used to get the category parameter value if the category was not set by a droplet, JSP tag, or query string parameter.

Parameters:

pUseParentCategory - Boolean indicating if the category associated with the previous request should be used to get the category parameter value if the category was not set by a droplet, JSP tag, or query string parameter.

isUsePreviousRequestCategoryId

public boolean isUsePreviousRequestCategoryId()

Returns:

Boolean indicating if the category associated with the previous request should be used to get the category parameter value if the category was not set by a droplet, JSP tag, or query string parameter.