atg.endeca.index
Class LocalSynchronizationInvokerService

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.endeca.index.LocalSynchronizationInvokerService

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, atg.search.core.SynchronizationInvoker, java.util.EventListener

public class LocalSynchronizationInvokerService
extends GenericService
implements atg.search.core.SynchronizationInvoker

A very minimal implementation of a SynchronizationInvoker. Only implements onCADeploymentChanges so it can be used with an IndexingDeploymentListener.

Created: January 03 2012

Field Summary

static java.lang.String	CLASS_VERSION Class version string from source code control system.
protected java.util.Set<SimpleIndexingAdmin>	mSimpleIndexingAdmins The set of SimpleIndexingAdmin instances to notify.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.search.core.SynchronizationInvoker

SYNC_TYPE_FULL, SYNC_TYPE_INCREMENTAL, SYNC_TYPE_POST_INDEX_CUSTOMIZATIONS

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

LocalSynchronizationInvokerService()

Method Summary

void	addSimpleIndexingAdmin(SimpleIndexingAdmin pAdmin) Add a simple indexing admin to the set of admins that will be consulted upon onCADeploymentChanges.
java.lang.String	executeBasicSynchronization(java.lang.String pProjectName, java.lang.String pSyncTaskDescription, java.lang.String pType, java.lang.String[] pTargetEnvironmentNames)
void	executeIndexingJobsFor(java.lang.String pCATargetName, java.lang.String pIndexingType, java.util.Map<java.lang.String,java.lang.String> pAffectedItemTypes, java.util.Set<java.lang.String> pAllIndexingOutputConfigPaths, java.util.Set<java.lang.String> pIncrementalIndexingOutputConfigPaths, java.util.Set<java.lang.String> pAncillaryIndexingOutputConfigPaths)
java.lang.String	executeSynchronizationBySyncTaskDefId(java.lang.String pSyncTaskDefId)
java.util.Set<java.lang.String>	getIndexingOutputConfigPaths() Optional method which returns additional IOC paths which should be verified on CA deployment changes in IndexingDeploymentListener.
java.util.Set<SimpleIndexingAdmin>	getSimpleIndexingAdmins() Return all registered simple indexing admins.
void	onCADeploymentChanges(java.util.Set<java.lang.String> pAffectedIOCPaths)
void	removeSimpleIndexingAdmin(SimpleIndexingAdmin pAdmin) Remove simple indexing admin from the set of admins that will be consulted upon onCADeploymentChanges.

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 from source code control system.

See Also:

Constant Field Values

mSimpleIndexingAdmins

protected java.util.Set<SimpleIndexingAdmin> mSimpleIndexingAdmins

The set of SimpleIndexingAdmin instances to notify.

Constructor Detail

LocalSynchronizationInvokerService

public LocalSynchronizationInvokerService()

Method Detail

getSimpleIndexingAdmins

public java.util.Set<SimpleIndexingAdmin> getSimpleIndexingAdmins()

Return all registered simple indexing admins.

addSimpleIndexingAdmin

public void addSimpleIndexingAdmin(SimpleIndexingAdmin pAdmin)

Add a simple indexing admin to the set of admins that will be consulted upon onCADeploymentChanges.

Parameters:

pSimpleIndexingAdmin - the simple admin to add.

removeSimpleIndexingAdmin

public void removeSimpleIndexingAdmin(SimpleIndexingAdmin pAdmin)

Remove simple indexing admin from the set of admins that will be consulted upon onCADeploymentChanges.

Parameters:

pSimpleIndexingAdmin - the simple admin to add.

executeSynchronizationBySyncTaskDefId

public java.lang.String executeSynchronizationBySyncTaskDefId(java.lang.String pSyncTaskDefId)
                                                       throws atg.search.SearchAdminException

Specified by:

executeSynchronizationBySyncTaskDefId in interface atg.search.core.SynchronizationInvoker

Throws:

atg.search.SearchAdminException

executeBasicSynchronization

public java.lang.String executeBasicSynchronization(java.lang.String pProjectName,
                                                    java.lang.String pSyncTaskDescription,
                                                    java.lang.String pType,
                                                    java.lang.String[] pTargetEnvironmentNames)
                                             throws atg.search.SearchAdminException

Specified by:

executeBasicSynchronization in interface atg.search.core.SynchronizationInvoker

Throws:

atg.search.SearchAdminException

executeIndexingJobsFor

public void executeIndexingJobsFor(java.lang.String pCATargetName,
                                   java.lang.String pIndexingType,
                                   java.util.Map<java.lang.String,java.lang.String> pAffectedItemTypes,
                                   java.util.Set<java.lang.String> pAllIndexingOutputConfigPaths,
                                   java.util.Set<java.lang.String> pIncrementalIndexingOutputConfigPaths,
                                   java.util.Set<java.lang.String> pAncillaryIndexingOutputConfigPaths)
                            throws atg.search.SearchAdminException

Specified by:

executeIndexingJobsFor in interface atg.search.core.SynchronizationInvoker

Throws:

atg.search.SearchAdminException

onCADeploymentChanges

public void onCADeploymentChanges(java.util.Set<java.lang.String> pAffectedIOCPaths)

Specified by:

onCADeploymentChanges in interface atg.search.core.SynchronizationInvoker

getIndexingOutputConfigPaths

public java.util.Set<java.lang.String> getIndexingOutputConfigPaths()

Optional method which returns additional IOC paths which should be verified on CA deployment changes in IndexingDeploymentListener.

Returns:

a set of IOC paths