atg.repository.search.indexing.listener

Class QueueingPropertiesChangeListener

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.repository.search.indexing.listener.QueueingPropertiesChangeListener

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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, PropertiesChangedListener, java.util.EventListener

public class QueueingPropertiesChangeListener
extends GenericService
implements PropertiesChangedListener

An PropertiesChangedListener that can queue incremental indexing changes to a referenced items. This is useful when a repository item that affects indexing references the indexed repository item, rather than vice versa. For example, pricelist items.

Created: April 07 2014

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	QueueingPropertiesChangeListener.IndexedRepositoryAndType A class that represents the target repository and type.

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
QueueingPropertiesChangeListener()

Method Summary

Modifier and Type	Method and Description
protected void	addOrRemoveAsPropertiesChangedListener(boolean pAdd) Add or remove ourselves as a property change listener to our item descriptor, and any subtypes.
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
void	doStopService() This is called when a Service is required to shut down.
atg.repository.search.indexing.IncrementalLoaderImpl	getIncrementalLoader() Returns property incrementalLoader.
RepositoryItemDescriptor	getItemDescriptor() Returns property itemDescriptor.
java.lang.String	getItemDescriptorName() Returns property itemDescriptorName.
java.util.Set<RepositoryPropertyDescriptor>	getMonitoredPropertyDescriptors() Returns property monitoredPropertyDescriptors.
java.lang.String[]	getMonitoredPropertyNames() Returns property monitoredPropertyNames.
java.util.Map<java.lang.String,java.lang.String>	getReferencingPropertyToIndexedRepositoryAndType() Returns property referencingPropertyToIndexedRepositoryAndType.
atg.nucleus.DelayedResolver<Repository>	getRepository() Returns property repository.
protected java.lang.String[]	getRepositoryIdsFromValue(java.lang.Object pValue) Return the repository IDs from the specified value.
protected void	handlePropertiesChanged(PropertiesChangedEvent pEvent, RepositoryItem pItem) Actually handle the properties change event.
boolean	isDelayStartup() Returns property delayStartup.
void	propertiesChanged(PropertiesChangedEvent pEvent)
protected boolean	queueItemChanged(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pSubTypeItemDescriptorName, java.lang.String pRepositoryId, int pEventType) Queue that the specified repository item has changed.
void	setDelayStartup(boolean pDelayStartup) Sets property delayStartup.
void	setIncrementalLoader(atg.repository.search.indexing.IncrementalLoaderImpl pIncrementalLoader) Sets property incrementalLoader.
void	setItemDescriptor(RepositoryItemDescriptor pItemDescriptor) Sets property itemDescriptor.
void	setItemDescriptorName(java.lang.String pItemDescriptorName) Sets property itemDescriptorName.
void	setMonitoredPropertyNames(java.lang.String[] pMonitoredPropertyNames) Sets property monitoredPropertyNames.
void	setReferencingPropertyToIndexedRepositoryAndType(java.util.Map<java.lang.String,java.lang.String> pReferencingPropertyToIndexedRepositoryAndType) Sets property referencingPropertyToIndexedRepositoryAndType.
void	setRepository(atg.nucleus.DelayedResolver<Repository> pRepository) Sets property repository.
void	setup() Do any actual startup work.
protected boolean	shouldQueueChange(PropertiesChangedEvent pEvent) Return whether should queue a change.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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, toString

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

QueueingPropertiesChangeListener

public QueueingPropertiesChangeListener()

Method Detail

setIncrementalLoader

public void setIncrementalLoader(atg.repository.search.indexing.IncrementalLoaderImpl pIncrementalLoader)

Sets property incrementalLoader. The incremental loader to use when queueing property changes.

getIncrementalLoader

@NotNull
public atg.repository.search.indexing.IncrementalLoaderImpl getIncrementalLoader()

Returns property incrementalLoader. The incremental loader to use when queueing property changes.

setReferencingPropertyToIndexedRepositoryAndType

public void setReferencingPropertyToIndexedRepositoryAndType(java.util.Map<java.lang.String,java.lang.String> pReferencingPropertyToIndexedRepositoryAndType)

Sets property referencingPropertyToIndexedRepositoryAndType. A map that maps from the source property name to the referenced target repository item and repository item type. Should be of the form "repositoryPath:itemDescriptorName".

getReferencingPropertyToIndexedRepositoryAndType

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

Returns property referencingPropertyToIndexedRepositoryAndType. A map that maps from the source property name to the referenced target repository item and repository item type. Should be of the form "repositoryPath:itemDescriptorName".

setRepository

public void setRepository(atg.nucleus.DelayedResolver<Repository> pRepository)

Sets property repository. The repository whose changes we will be monitoring.

getRepository

@NotNull
public atg.nucleus.DelayedResolver<Repository> getRepository()

Returns property repository. The repository whose changes we will be monitoring.

setItemDescriptorName

public void setItemDescriptorName(java.lang.String pItemDescriptorName)

Sets property itemDescriptorName. The item descriptor we will be monitoring.

getItemDescriptorName

public java.lang.String getItemDescriptorName()

Returns property itemDescriptorName. The item descriptor we will be monitoring.

setItemDescriptor

public void setItemDescriptor(RepositoryItemDescriptor pItemDescriptor)

Sets property itemDescriptor. The item descriptor. Will be initialized from ItemDescriptorName.

getItemDescriptor

public RepositoryItemDescriptor getItemDescriptor()

Returns property itemDescriptor. The item descriptor. Will be initialized from ItemDescriptorName.

setDelayStartup

public void setDelayStartup(boolean pDelayStartup)

Sets property delayStartup. Whether to delay startup and resolving various components (such as repositories) until after Nucleus starts up.

isDelayStartup

public boolean isDelayStartup()

Returns property delayStartup. Whether to delay startup and resolving various components (such as repositories) until after Nucleus starts up.

setMonitoredPropertyNames

public void setMonitoredPropertyNames(java.lang.String[] pMonitoredPropertyNames)

Sets property monitoredPropertyNames. The array of monitored properties.

getMonitoredPropertyNames

public java.lang.String[] getMonitoredPropertyNames()

Returns property monitoredPropertyNames. The array of monitored properties.

getMonitoredPropertyDescriptors

public java.util.Set<RepositoryPropertyDescriptor> getMonitoredPropertyDescriptors()

Returns property monitoredPropertyDescriptors. The set of property descriptors we monitor. An empty set means treat every change event as a change.

queueItemChanged

protected boolean queueItemChanged(java.lang.String pRepositoryPath,
                                   java.lang.String pItemDescriptorName,
                                   java.lang.String pSubTypeItemDescriptorName,
                                   java.lang.String pRepositoryId,
                                   int pEventType)

Queue that the specified repository item has changed.

Parameters:

pRepositoryPath - the path of the repository.

pItemDescriptorName - the item descriptor name of the item actually mentioned in the IOC.

pSubTypeItemDescriptorName - the ACTUAL subtype of the actual item.

pRepositoryId - the ID of the repository item to queue a change for.

pEventType - the even type, such as PropertiesChangedEvent.UPDATE.

propertiesChanged

public void propertiesChanged(PropertiesChangedEvent pEvent)

Specified by:

propertiesChanged in interface PropertiesChangedListener

shouldQueueChange

protected boolean shouldQueueChange(PropertiesChangedEvent pEvent)

Return whether should queue a change.

Parameters:

pEvent - the event to possibly queue.

handlePropertiesChanged

protected void handlePropertiesChanged(PropertiesChangedEvent pEvent,
                                       RepositoryItem pItem)
                                throws RepositoryException

Actually handle the properties change event. Only called if when the repository item could be resolved to an actual item.

Parameters:

pEvent - the originating properties changed event.

pItem - the item in question.

Throws:

RepositoryException

getRepositoryIdsFromValue

protected java.lang.String[] getRepositoryIdsFromValue(java.lang.Object pValue)

Return the repository IDs from the specified value. Currently

Parameters:

pValue - the value. May be a string repository ID, or a RepositoryItem, but could be extended to handle collections of values.

Returns:

null or an array of (non-null) IDs.

setup

public void setup()

Do any actual startup work. Separated out into a separate method to handle delayed startup.

addOrRemoveAsPropertiesChangedListener

protected void addOrRemoveAsPropertiesChangedListener(boolean pAdd)
                                               throws RepositoryException

Add or remove ourselves as a property change listener to our item descriptor, and any subtypes.

Parameters:

pAdd - if true, add. If false, remove.

Throws:

RepositoryException

doStartService

public void doStartService()
                    throws ServiceException

Description copied from class: GenericService

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

doStopService

public void doStopService()
                   throws ServiceException

Description copied from class: GenericService

This is called when a Service is required to shut down. The Service should respond by stopping any processes that it has started.

Overrides:

doStopService in class GenericService

Throws:

ServiceException - if the Service had a problem shutting down