atg.endeca.assembler
Class NucleusAssemblerFactory

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

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 NucleusAssemblerFactory
extends GenericService

A Factory used to create a NucleusAssembler. The NucleusAssembler is responsible for returning a cartridge handler for a particular cartridge type. There are three ways to determine the mapping between the cartridge handler type and the cartridge component path:

handlerMapping

Map keyed by cartridge type. If a cartridge type is present in the Map, the matching value is the Nucleus path for the cartridge handler. If a cartridge type is not present in the map, the *HandlerPath properties (below) will be examined. Use handlerMapping when cartridge types do not match handler component names, as when many cartridge types share a common handler.

experienceManagerHandlerPath or guidedSearchHandlerPath

Paths for directories containing cartridge handler components. Either experienceManagerHandlerPath or guidedSearchHandlerPath will be used depending on the setting of AssemblerTools.experienceManager. The cartridge type is appended to the selected path as the name of the handler component.

defaultHandlerPath

Path for a directory containing cartridge handler components. If a handler component is not located in the directory specified by experienceManagerHandlerPath or guidedSearchHandlerPath, the handler is looked up in defaultHandlerPath.

See Also:

NucleusAssembler

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

NucleusAssemblerFactory()

Method Summary

void	addAssemblerEventListener(AssemblerEventListener pListener) Add the specified listener to the list of assembler event listeners.
Assembler	createAssembler() Construct a new NucleusAssembler
AssemblerEventListener[]	getAssemblerEventListeners() Returns property assemblerEventListeners.
AssemblerSettings	getAssemblerSettings()
AssemblerTools	getAssemblerTools()
java.lang.String	getDefaultHandlerPath()
java.lang.String	getExperienceManagerHandlerPath()
java.lang.String	getGuidedSearchHandlerPath()
java.util.Map<java.lang.String,java.lang.String>	getHandlerMapping()
void	removeAssemblerEventListener(AssemblerEventListener pListener) Remove the specified listener from the list of assembler event listeners.
void	setAssemblerSettings(AssemblerSettings pAssemblerSettings)
void	setAssemblerTools(AssemblerTools pAssemblerTools)
void	setDefaultHandlerPath(java.lang.String pDefaultHandlerPath)
void	setExperienceManagerHandlerPath(java.lang.String pExperienceManagerHandlerPath)
void	setGuidedSearchHandlerPath(java.lang.String pGuidedSearchHandlerPath)
void	setHandlerMapping(java.util.Map<java.lang.String,java.lang.String> pHandlerMapping)

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

Class version string

Constructor Detail

NucleusAssemblerFactory

public NucleusAssemblerFactory()

Method Detail

getAssemblerTools

public AssemblerTools getAssemblerTools()

Returns:

AssemblerTools bean containing useful methods for use with the assembler.

setAssemblerTools

public void setAssemblerTools(AssemblerTools pAssemblerTools)

Parameters:

mAssemblerTools - Set a new AssemblerTools

getAssemblerSettings

public AssemblerSettings getAssemblerSettings()

Returns:

Assembler settings

setAssemblerSettings

public void setAssemblerSettings(AssemblerSettings pAssemblerSettings)

Parameters:

pAssemblerSettings - Set a new assembler settings

getDefaultHandlerPath

public java.lang.String getDefaultHandlerPath()

Returns:

Path to the default handler directory.

setDefaultHandlerPath

public void setDefaultHandlerPath(java.lang.String pDefaultHandlerPath)

Parameters:

pDefaultHandlerPath - Set a new path to the default handler directory

getGuidedSearchHandlerPath

public java.lang.String getGuidedSearchHandlerPath()

Returns:

Path to a directory on the config path that contains cartridge handlers for use with Guided Search. If Guided Search is not in use this property can be ignored.

setGuidedSearchHandlerPath

public void setGuidedSearchHandlerPath(java.lang.String pGuidedSearchHandlerPath)

Parameters:

pGuidedSearchHandlerPath - Set a new guidedSearchHandlerPath

getExperienceManagerHandlerPath

public java.lang.String getExperienceManagerHandlerPath()

Returns:

Path to a directory on the config path that contains cartridge handlers for use with Experience Manager. If Experience Manager is not in use this property can be ignored.

setExperienceManagerHandlerPath

public void setExperienceManagerHandlerPath(java.lang.String pExperienceManagerHandlerPath)

Parameters:

pExperienceManagerHandlerPath - Set a new experienceManagerHandlerPath

getHandlerMapping

public java.util.Map<java.lang.String,java.lang.String> getHandlerMapping()

Returns:

A map whose keys are cartridge types and whose values are handler components.

setHandlerMapping

public void setHandlerMapping(java.util.Map<java.lang.String,java.lang.String> pHandlerMapping)

Parameters:

pHandlerMapping - Set a new handlerMapping map

getAssemblerEventListeners

public AssemblerEventListener[] getAssemblerEventListeners()

Returns property assemblerEventListeners. Array of listeners listening to assembler events.

addAssemblerEventListener

public void addAssemblerEventListener(AssemblerEventListener pListener)

Add the specified listener to the list of assembler event listeners.

Parameters:

pListener - the listener to add

removeAssemblerEventListener

public void removeAssemblerEventListener(AssemblerEventListener pListener)

Remove the specified listener from the list of assembler event listeners.

Parameters:

pListener - the listener to add

createAssembler

public Assembler createAssembler()
                          throws AssemblerException

Construct a new NucleusAssembler

Throws:

AssemblerException