atg.endeca.assembler
Class AssemblerTools

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.endeca.assembler.AssemblerTools

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

public class AssemblerTools
extends GenericService

Tools class for the Assembler.

Field Summary

static java.lang.String	CONTENT_ITEM_TO_RENDERER_PATH_MAPPER Mapper from ContentItem to a rendering path to include to (typically a JSP).
static java.lang.String	CONTENT_PREFIX Custom content prefix "contentPrefix" request parameter name.

Fields inherited from class atg.nucleus.GenericService

CLASS_VERSION, 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

AssemblerTools()

Method Summary

AssemblerFactory	getAssemblerFactory()
AssemblerSettings	getAssemblerSettings()
ContentItemToRendererPath	getContentItemToRendererPathForRequest(javax.servlet.http.HttpServletRequest pRequest) Return the CatridgerRenderingMapper to use for the specified request.
java.lang.String	getContentPath() Returns the full path used to query for content in the Java Content Repository.
java.lang.String	getContentPathPrefix() Firstly checks the request for a "contentPath" parameter, if its not set returns the default prefix for either Experience Manager or Guided Search.
ContentItemToRendererPath	getDefaultContentItemToRendererPath() Returns property defaultContentItemToRendererPath.
ContentItem	invokeAssembler(ContentItem pContentItem) Query the content repository for content using the assembler API.
boolean	isExperienceManager() Returns the value of NucleusAssemblerSettings.isExperienceManager
boolean	isRemoveContextRoot()
boolean	isRemoveSiteBaseURL()
protected boolean	removeContextRoot(java.lang.StringBuilder pResourceBuilder) Removes the context root
protected boolean	removeSiteBaseURL(java.lang.StringBuilder pResourceBuilder) Removes the site base url.
void	setAssemblerFactory(AssemblerFactory pAssemblerFactory) Set a new assembler factory
void	setAssemblerSettings(AssemblerSettings pAssemblerSettings)
void	setDefaultContentItemToRendererPath(ContentItemToRendererPath pDefaultContentItemToRendererPath) Sets property defaultContentItemToRendererPath.
void	setRemoveContextRoot(boolean pRemoveContextRoot)
void	setRemoveSiteBaseURL(boolean pRemoveSiteBaseURL)

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

CONTENT_PREFIX

public static final java.lang.String CONTENT_PREFIX

Custom content prefix "contentPrefix" request parameter name. This will be prepended to the request made by the assembler.

See Also:

Constant Field Values

CONTENT_ITEM_TO_RENDERER_PATH_MAPPER

public static final java.lang.String CONTENT_ITEM_TO_RENDERER_PATH_MAPPER

Mapper from ContentItem to a rendering path to include to (typically a JSP).

See Also:

Constant Field Values

Constructor Detail

AssemblerTools

public AssemblerTools()

Method Detail

getAssemblerSettings

public AssemblerSettings getAssemblerSettings()

Returns:

AssemblerSettings bean

setAssemblerSettings

public void setAssemblerSettings(AssemblerSettings pAssemblerSettings)

Parameters:

pAssemblerSettings - Set a new AssemblerSettings

getAssemblerFactory

public AssemblerFactory getAssemblerFactory()

Returns:

An assembler factory responsible for creating an Assembler.

setAssemblerFactory

public void setAssemblerFactory(AssemblerFactory pAssemblerFactory)

Set a new assembler factory

Parameters:

pAssemblerFactory -

isRemoveSiteBaseURL

public boolean isRemoveSiteBaseURL()

Returns:

If true the site base url (productionURL) is removed from the path passed to the assembler.

setRemoveSiteBaseURL

public void setRemoveSiteBaseURL(boolean pRemoveSiteBaseURL)

Parameters:

pRemoveSiteBaseURL - Set a new removeSiteBaseURL property

isRemoveContextRoot

public boolean isRemoveContextRoot()

Returns:

If true the context root is removed from the path passed to the assembler

setRemoveContextRoot

public void setRemoveContextRoot(boolean pRemoveContextRoot)

Parameters:

pRemoveContextRoot - Set a new removeContextRoot property

setDefaultContentItemToRendererPath

public void setDefaultContentItemToRendererPath(ContentItemToRendererPath pDefaultContentItemToRendererPath)

Sets property defaultContentItemToRendererPath. The default cartridge rendering mapper to use.

getDefaultContentItemToRendererPath

public ContentItemToRendererPath getDefaultContentItemToRendererPath()

Returns property defaultContentItemToRendererPath. The default cartridge rendering mapper to use.

invokeAssembler

public ContentItem invokeAssembler(ContentItem pContentItem)
                            throws AssemblerException

Query the content repository for content using the assembler API. The pContentItem is used in the query. The ContentItem returned from this invocation is returned.

Parameters:

pContentItem -

Returns:

Response ContentItem

Throws:

AssemblerException

getContentPath

public java.lang.String getContentPath()

Returns the full path used to query for content in the Java Content Repository. Prepends the content path prefix to the resource path determined from the url. The resource path depends on the removeSiteBaseURL and removeContextRoot properties.

Returns:

The path to query for content in the Java Content Repository

getContentPathPrefix

public java.lang.String getContentPathPrefix()

Firstly checks the request for a "contentPath" parameter, if its not set returns the default prefix for either Experience Manager or Guided Search.

Returns:

The content path prefix.

isExperienceManager

public boolean isExperienceManager()

Returns the value of NucleusAssemblerSettings.isExperienceManager

Returns:

A boolean indicating if Experience Manager is available

removeSiteBaseURL

protected boolean removeSiteBaseURL(java.lang.StringBuilder pResourceBuilder)

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

Parameters:

pResourceBuilder -

removeContextRoot

protected boolean removeContextRoot(java.lang.StringBuilder pResourceBuilder)

Removes the context root

Parameters:

pResourceBuilder -

getContentItemToRendererPathForRequest

public ContentItemToRendererPath getContentItemToRendererPathForRequest(javax.servlet.http.HttpServletRequest pRequest)

Return the CatridgerRenderingMapper to use for the specified request. Will generally be the value of our defaultContentItemToRendererPath property, unless the current web-app has an override init-param value for "contentItemToRendererPath".

Returns:

pRequest the request to use.