atg.projects.store.assembler

Class StoreAssemblerTools

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.assembler.AssemblerTools

atg.projects.store.assembler.StoreAssemblerTools

All Implemented Interfaces:

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

public class StoreAssemblerTools
extends atg.endeca.assembler.AssemblerTools

This AssemblerTools extension includes extra functionality allow configuration of default page content paths.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.2/Endeca/Assembler/src/atg/projects/store/assembler/StoreAssemblerTools.java#1 $$Change: 1179550 $

Author:

Oracle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.endeca.assembler.AssemblerTools

CONTENT_ITEM_TO_RENDERER_PATH_MAPPER, CONTENT_PREFIX, CONTENT_RENDERER, JSON_FORMAT, XML_FORMAT

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

Constructors

Constructor and Description
StoreAssemblerTools()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentPath(atg.servlet.DynamoHttpServletRequest pRequest) Returns a path based on the current request URI that can used to query the assembler for content.
java.lang.String	getDefaultPagePath()
java.lang.String	getSiteDefaultPagePathPropertyName()
protected boolean	removeSiteBaseURL(java.lang.StringBuilder pResourceBuilder) Removes the site base url.
void	setDefaultPagePath(java.lang.String pDefaultPagePath)
void	setSiteDefaultPagePathPropertyName(java.lang.String pSiteDefaultPagePathPropertyName)

Methods inherited from class atg.endeca.assembler.AssemblerTools

doStartService, getApplicationLogging, getAssemblerFactory, getAssemblerSettings, getBeanFilterService, getCallbacks, getContentItemToRendererPathForRequest, getContentPathPrefix, getDefaultContentItemToRendererPath, getDefaultContentRenderer, getRendererPathForContentItem, getResponseGenerator, invokeAssembler, invokeAssembler, isExperienceManager, isIncludeAdditionalProductionURLs, isOptimizeWriteResponse, isRemoveContextRoot, isRemoveSiteBaseURL, isUseMapper, removeContextRoot, serializeContentItemToResponse, setApplicationLogging, setAssemblerFactory, setAssemblerSettings, setBeanFilterService, setCallbacks, setDefaultContentItemToRendererPath, setDefaultContentRenderer, setIncludeAdditionalProductionURLs, setOptimizeWriteResponse, setRemoveContextRoot, setRemoveSiteBaseURL, setResponseGenerator, setUseMapper, updateURL

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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 java.lang.String CLASS_VERSION

Class version string

Constructor Detail

StoreAssemblerTools

public StoreAssemblerTools()

Method Detail

setSiteDefaultPagePathPropertyName

public void setSiteDefaultPagePathPropertyName(java.lang.String pSiteDefaultPagePathPropertyName)

Parameters:

pSiteDefaultPagePathPropertyName - The siteConfiguration's 'defaultPageContentPath' property name.

getSiteDefaultPagePathPropertyName

public java.lang.String getSiteDefaultPagePathPropertyName()

Returns:

The siteConfiguration's 'defaultPageContentPath' property name.

setDefaultPagePath

public void setDefaultPagePath(java.lang.String pDefaultPagePath)

Parameters:

pDefaultPagePath - The page path that will be used when the servlet path is '/'. For example, if the default page you wish to set is /home, the value should be set to home (no preceding forward slash). When no site specific default path is needed, a default path can be set using this property. This could be used when no site has been defined or all sites share a common default page path.

getDefaultPagePath

public java.lang.String getDefaultPagePath()

Returns:

The page path that will be used when the servlet path is '/'. For example, if the default page you wish to set is /home, the value should be set to home (no preceding forward slash). When no site specific default path is needed, a default path can be set using this property. This could be used when no site has been defined or all sites share a common default page path.

getContentPath

public java.lang.String getContentPath(atg.servlet.DynamoHttpServletRequest pRequest)

Returns a path based on the current request URI that can used to query the assembler for content. If the servlet path is '/', a default content path will be appended if one exists in this component's 'defaultPagePath' property or the current site has a 'defaultPageContentPath' property value defined.

Overrides:

getContentPath in class atg.endeca.assembler.AssemblerTools

Returns:

The path to query for content in the Java Content Repository.

removeSiteBaseURL

protected boolean removeSiteBaseURL(java.lang.StringBuilder pResourceBuilder)

Removes the site base url. For example, the site base URL for storeSiteUS would be /crs/storeus.

Overrides:

removeSiteBaseURL in class atg.endeca.assembler.AssemblerTools

Parameters:

pResourceBuilder -