atg.repository.search.indexing

Class ConfigStatePersister

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.repository.search.indexing.RepositoryLockingService

atg.repository.search.indexing.ConfigStatePersister

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, atg.nucleus.PostStartupAction, Service, ServiceListener, java.util.EventListener

public class ConfigStatePersister
extends atg.repository.search.indexing.RepositoryLockingService
implements atg.nucleus.PostStartupAction

Handles persisting information about the state of the indexing configuration stored in the 'searchConfig' item descriptor. Specifically, persists such information as:

• current generation number
• last indexing activity time
• last full index time
• last incremental index time
• server claiming the config for indexing
• generation claimed by that server.

A generation is merely a version number for a set of changes. The generation mechanism exists so that the incremental loader can queue up a set of changes (see IncrementalItemQueue), claim that generation and begin processing it, even as change events get queued up in the next generation.

Created: April 15 2005

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ConfigStatePersister.ConfigState Class which represents the configuration state.

Nested classes/interfaces inherited from class atg.repository.search.indexing.RepositoryLockingService

atg.repository.search.indexing.RepositoryLockingService.IndexingReadLockedTransactionAction, atg.repository.search.indexing.RepositoryLockingService.IndexingWriteLockedTransactionAction

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
ConfigStatePersister()

Method Summary

Modifier and Type	Method and Description
int	claimAndIncrementGeneration(java.lang.String pConfigPath, java.lang.String pContentId, boolean pForIncrementalUpdate, boolean pUseConfigurationClaims, IndexingOutputConfig pIOC) Claim the current generation, increment the generation count, and return the number for the generation we just claimed.
void	completedFullIndex(java.lang.String pConfigPath, java.lang.String pContentId, int pGeneration, boolean pCompletedSuccessfully, boolean pUseConfigurationClaims) Handle the completion of an full index of the specified generation.
void	completedIncrementalIndex(java.lang.String pConfigPath, java.lang.String pContentId, int pGeneration, boolean pCompletedSuccessfully, boolean pUseConfigurationClaims) Handle the completion of an incremental index of the specified generation.
protected void	completedIndex(java.lang.String pConfigPath, java.lang.String pContentId, int pGeneration, boolean pCompletedSuccessfully, boolean pIncremental, boolean pUseConfigurationClaims) Release any claim on that generation.
protected ConfigStatePersister.ConfigState	createConfigState(RepositoryItem pItem) Create a configuration state from the specified repository item.
void	doStartService() Start up the service...
java.lang.String	encodeKey(java.lang.String pConfigPath, java.lang.String pContentId) Create encoded key for config state item
protected RepositoryItem[]	getClaimedConfigStateItems() Return the configuration items claimed by some server.
java.lang.String	getClaimedGenerationPropertyName() Get the claimed generation property name.
java.lang.String	getClaimedLockName()
java.lang.String	getConfigPathPropertyName()
protected RepositoryItem[]	getConfigStateItemsByUniqueServerId(java.lang.String pUniqueServerId) Return the repository items that are owned by the specified server Id.
RepositoryItem[]	getConfigStateItemsForConfig(java.lang.String pConfigPath)
java.lang.Object	getConfigStateProperty(java.lang.String pConfigPath, java.lang.String pContentId, java.lang.String pPropertyName) Return the specified property value of the configuration state.
java.lang.String	getContentIdPropertyName()
int	getCurrentGenerationForConfig(java.lang.String pConfigPath, java.lang.String pContentId) Get the current generation for the specified configuration.
int	getGenerationForConfig(java.lang.String pConfigPath, java.lang.String pContentId) Get the generation for the specified config.
int	getGenerationForIncremental(IndexingOutputConfig pOutputConfig, java.lang.String pContentId) Get the generation for the specified config.
java.lang.String	getGenerationPropertyName()
RepositoryItemDescriptor	getItemDescriptor() Get the item descriptor used for storage.
java.lang.String	getItemDescriptorName()
protected RepositoryItem	getItemForConfig(java.lang.String pConfigPath, java.lang.String pContentId, boolean pMutable) Get or create the repository item for the specified configuration and content set ID.
java.lang.String	getLastActivityPropertyName()
java.lang.String	getLastFullIndexPropertyName()
java.util.Date	getLastFullIndexTime(java.lang.String pConfigPath, java.lang.String pContentId) Get the last full index time.
java.lang.String	getLastIncrementalIndexPropertyName()
java.util.Date	getLastIncrementalIndexTime(java.lang.String pConfigPath, java.lang.String pContentId) Get the last incremental index time from the assocaited "configState" item.
java.net.InetAddress	getLocalHost() Returns the InetAddress of this host
java.lang.Integer	getNextIncrementalGeneration(java.lang.String pConfigPath, java.lang.String pContentId) Get the next incremental generation value from the configuration record.
java.lang.String	getNextIncrementalGenerationPropertyName()
long	getRefreshCurrentGenerationMsecs() The number of seconds before cached information about the current generation for a configuration is considered stale.
java.net.InetAddress	getSessionIdAddress() Returns the IP address that will be stamped into generated session id's
int	getSessionIdPort() Returns the IP address that will be stamped into generated session id's
long	getTimeOutMsecs() Get the number of milliseconds of inactivity before a claimed index is considered timed out.
protected RepositoryItem[]	getUnclaimedConfigStateItems() Return the configuration items claimed by some server.
ConfigStatePersister.ConfigState[]	getUnclaimedConfigStates() Get the generation for the specified config.
java.lang.String	getUniqueServerId() This is a uniq id for each dyanmo server.
java.lang.String	getUniqueServerIdPropertyName()
protected boolean	hasTimedOut(long pLastActivity) Whether the last activity time is considered timed out.
protected boolean	hasTimedOut(RepositoryItem pItem) Whether the lastActivity property on pItem is longer ago than timeOutMsecs.
boolean	isUseConfigurationClaims() Whether to use configuration claims.
protected void	logReleseConfigrationMessage(MutableRepositoryItem pConfigStateItem) Log a detailed warning message when releasing expired configuration claims.
void	performAction() Called after Nucleus starts, after this point it's safe to use the ClientLockManager and get actual global locks.
void	releaseAllConfigurations() Release all configurations claimed by this server.
void	releaseTimedOutConfigurations() Release all configurations claimed by this server.
void	removedCachedValueForConfig(java.lang.String pConfigPath, java.lang.String pContentId) Remove cached information for the specified configuration path, so that it will be fetched anew next time it is needed.
void	removeObsoleteConfigState(ConfigStatePersister.ConfigState pConfigState) Remove config state represented by pConfigState.
void	setClaimedGenerationPropertyName(java.lang.String pClaimedGenerationPropertyName) Set the claimed generation property name.
void	setConfigPathPropertyName(java.lang.String pConfigPathPropertyName)
void	setConfigStateProperty(java.lang.String pConfigPath, java.lang.String pContentId, java.lang.String pPropertyName, java.lang.Object pValue) Set the specified property value of the configuration state.
void	setContentIdPropertyName(java.lang.String pContentIdPropertyName)
void	setGenerationPropertyName(java.lang.String pGenerationPropertyName)
void	setItemDescriptorName(java.lang.String pItemDescriptorName)
void	setLastActivityPropertyName(java.lang.String pLastActivityPropertyName)
void	setLastFullIndexPropertyName(java.lang.String pLastFullIndexPropertyName)
void	setLastIncrementalIndexPropertyName(java.lang.String pLastIncrementalIndexPropertyName)
protected void	setNextIncrementalGeneration(java.lang.String pConfigPath, java.lang.String pContentId, int pGeneration) Set the next incremental version to a spcific value.
void	setNextIncrementalGenerationPropertyName(java.lang.String pNextIncrementalGenerationPropertyName)
void	setRefreshCurrentGenerationMsecs(long pRefreshCurrentGenerationMsecs) The number of seconds before cached information about the current generation for a configuration is considered stale.
void	setSessionIdAddress(java.net.InetAddress pSessionIdAddress) Sets the IP address that will be stamped into generated session id's
void	setSessionIdPort(int pSessionIdPort) Sets the IP address that will be stamped into generated session id's
void	setTimeOutMsecs(long pTimeOutMsecs) Set the number of milliseconds of inactivity before a claimed index is considered timed out.
void	setUniqueServerIdPropertyName(java.lang.String pUniqueServerIdPropertyName)
void	setUseConfigurationClaims(boolean pUseConfigurationClaims) Whether to use configuration claims.
void	updateLastActivityTime(java.lang.String pConfigPath, java.lang.String pContentId, int pGeneration) Update the activity time for the specified generation.
void	updateLastActivityTime(java.lang.String pConfigPath, java.lang.String pContentId, int pGeneration, long pLastActivityTime) Update the activity time for the specified generation in the appropriate "searchConfig" item.

Methods inherited from class atg.repository.search.indexing.RepositoryLockingService

getAcquireLockTimeoutMs, getClientLockManager, getRepository, getTransactionManager, isAlwaysAcquireWriteLock, isRequireGlobalLock, setAcquireLockTimeoutMs, setAlwaysAcquireWriteLock, setClientLockManager, setRepository, setRequireGlobalLock, setTransactionManager

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

ConfigStatePersister

public ConfigStatePersister()

Method Detail

setItemDescriptorName

public void setItemDescriptorName(java.lang.String pItemDescriptorName)

getItemDescriptorName

public java.lang.String getItemDescriptorName()

getItemDescriptor

public RepositoryItemDescriptor getItemDescriptor()

Get the item descriptor used for storage.

setConfigPathPropertyName

public void setConfigPathPropertyName(java.lang.String pConfigPathPropertyName)

getConfigPathPropertyName

public java.lang.String getConfigPathPropertyName()

setContentIdPropertyName

public void setContentIdPropertyName(java.lang.String pContentIdPropertyName)

getContentIdPropertyName

public java.lang.String getContentIdPropertyName()

setGenerationPropertyName

public void setGenerationPropertyName(java.lang.String pGenerationPropertyName)

getGenerationPropertyName

public java.lang.String getGenerationPropertyName()

setUniqueServerIdPropertyName

public void setUniqueServerIdPropertyName(java.lang.String pUniqueServerIdPropertyName)

getUniqueServerIdPropertyName

public java.lang.String getUniqueServerIdPropertyName()

setLastActivityPropertyName

public void setLastActivityPropertyName(java.lang.String pLastActivityPropertyName)

getLastActivityPropertyName

public java.lang.String getLastActivityPropertyName()

setLastFullIndexPropertyName

public void setLastFullIndexPropertyName(java.lang.String pLastFullIndexPropertyName)

getLastFullIndexPropertyName

public java.lang.String getLastFullIndexPropertyName()

setLastIncrementalIndexPropertyName

public void setLastIncrementalIndexPropertyName(java.lang.String pLastIncrementalIndexPropertyName)

getLastIncrementalIndexPropertyName

public java.lang.String getLastIncrementalIndexPropertyName()

setTimeOutMsecs

public void setTimeOutMsecs(long pTimeOutMsecs)

Set the number of milliseconds of inactivity before a claimed index is considered timed out.

getTimeOutMsecs

public long getTimeOutMsecs()

Get the number of milliseconds of inactivity before a claimed index is considered timed out.

setRefreshCurrentGenerationMsecs

public void setRefreshCurrentGenerationMsecs(long pRefreshCurrentGenerationMsecs)

The number of seconds before cached information about the current generation for a configuration is considered stale.

getRefreshCurrentGenerationMsecs

public long getRefreshCurrentGenerationMsecs()

The number of seconds before cached information about the current generation for a configuration is considered stale.

setClaimedGenerationPropertyName

public void setClaimedGenerationPropertyName(java.lang.String pClaimedGenerationPropertyName)

Set the claimed generation property name.

getClaimedGenerationPropertyName

public java.lang.String getClaimedGenerationPropertyName()

Get the claimed generation property name.

setNextIncrementalGenerationPropertyName

public void setNextIncrementalGenerationPropertyName(java.lang.String pNextIncrementalGenerationPropertyName)

getNextIncrementalGenerationPropertyName

public java.lang.String getNextIncrementalGenerationPropertyName()

getUniqueServerId

public java.lang.String getUniqueServerId()

This is a uniq id for each dyanmo server. IpAddress and DprPort. (###.###.###.###:####)

getSessionIdAddress

public java.net.InetAddress getSessionIdAddress()

Returns the IP address that will be stamped into generated session id's

setSessionIdAddress

public void setSessionIdAddress(java.net.InetAddress pSessionIdAddress)

Sets the IP address that will be stamped into generated session id's

getSessionIdPort

public int getSessionIdPort()

Returns the IP address that will be stamped into generated session id's

setSessionIdPort

public void setSessionIdPort(int pSessionIdPort)

Sets the IP address that will be stamped into generated session id's

getLocalHost

public java.net.InetAddress getLocalHost()

Returns the InetAddress of this host

setUseConfigurationClaims

public void setUseConfigurationClaims(boolean pUseConfigurationClaims)

Whether to use configuration claims. No longer necessary in general since the SearchAdmin now controlls indexing. This should mean that no two IOCs/loaders are ever given the same indexing job at once. It may be necessary to re-enable locking (by setting this to true) if indexing is not initiated by the Search Admin and especially in cases where multiple ATG instances could initiate the index process for the same configuration.

Parameters:

pUseConfigurationClaims - true to use configuration claims

isUseConfigurationClaims

public boolean isUseConfigurationClaims()

Whether to use configuration claims. No longer necessary in general since the SearchAdmin now controlls indexing. This should mean that no two IOCs/loaders are ever given the same indexing job at once. It may be necessary to re-enable locking (by setting this to true) if indexing is not initiated by the Search Admin and especially in cases where multiple ATG instances could initiate the index process for the same configuration.

Returns:

true if using configuration claiming

encodeKey

public java.lang.String encodeKey(java.lang.String pConfigPath,
                                  java.lang.String pContentId)
                           throws RepositoryException

Create encoded key for config state item

Throws:

RepositoryException

getItemForConfig

protected RepositoryItem getItemForConfig(java.lang.String pConfigPath,
                                          java.lang.String pContentId,
                                          boolean pMutable)
                                   throws RepositoryException

Get or create the repository item for the specified configuration and content set ID.

Parameters:

pConfigPath - The absolute nucleus component path of the IOC

pContentId - The ID of the content set or null if not used.

pMutable - If true, return a mutable item

Throws:

RepositoryException

getGenerationForConfig

public int getGenerationForConfig(java.lang.String pConfigPath,
                                  java.lang.String pContentId)
                           throws IndexingException

Get the generation for the specified config. Will create a repository entry if none exists.

Throws:

IndexingException

getGenerationForIncremental

public int getGenerationForIncremental(IndexingOutputConfig pOutputConfig,
                                       java.lang.String pContentId)

Get the generation for the specified config. Won't create a repository entry if none exists.

updateLastActivityTime

public void updateLastActivityTime(java.lang.String pConfigPath,
                                   java.lang.String pContentId,
                                   int pGeneration)
                            throws IndexingException

Update the activity time for the specified generation. The specified generation must match the currently claimed generation.

Throws:

IndexingException

updateLastActivityTime

public void updateLastActivityTime(java.lang.String pConfigPath,
                                   java.lang.String pContentId,
                                   int pGeneration,
                                   long pLastActivityTime)
                            throws IndexingException

Update the activity time for the specified generation in the appropriate "searchConfig" item. The specified generation must match the currently claimed generation.

Parameters:

pConfigPath - the configuration path for the config status

pGeneration - the generation claimed whose last activity time needs to be updated

pLastActivityTime - the new last activity time to be written

Throws:

IndexingException

claimAndIncrementGeneration

public int claimAndIncrementGeneration(java.lang.String pConfigPath,
                                       java.lang.String pContentId,
                                       boolean pForIncrementalUpdate,
                                       boolean pUseConfigurationClaims,
                                       IndexingOutputConfig pIOC)
                                throws IndexingException,
                                       ConfigurationClaimedIndexingException

Claim the current generation, increment the generation count, and return the number for the generation we just claimed.

Parameters:

pConfigPath - The configuration path of the configuration to claim.

pContentId - The ID of the content set or null if not used.

pForIncrementalUpdate -

pUseConfigurationClaims - If true, use and enforce configruation claims by throwing ConfigurationClaimedIndexingException if configuration has been claimed by another process. Otherwise, claim configuration and warn if exception would have been thrown.

Returns:

the claimed generation, or -1 if this server already claimed the configuration (presumably in a different thread).

Throws:

IndexingException

ConfigurationClaimedIndexingException

completedFullIndex

public void completedFullIndex(java.lang.String pConfigPath,
                               java.lang.String pContentId,
                               int pGeneration,
                               boolean pCompletedSuccessfully,
                               boolean pUseConfigurationClaims)
                        throws IndexingException

Handle the completion of an full index of the specified generation. This updates the "searchConfig" item's lastIncrementalIndex, and clears the uniqueServerId and claimedGeneration properties, releasing this configuration.

Parameters:

pConfigPath - The path of the configuration.

pContentId - The ID of the content set or null if not used.

pGeneration - The generation we completed indexing.

pCompletedSuccessfully - If incremental indexing completed successfully.

pUseConfigurationClaims - If true, release configuration claim lock obtained at initialization

Throws:

IndexingException

completedIncrementalIndex

public void completedIncrementalIndex(java.lang.String pConfigPath,
                                      java.lang.String pContentId,
                                      int pGeneration,
                                      boolean pCompletedSuccessfully,
                                      boolean pUseConfigurationClaims)
                               throws IndexingException

Handle the completion of an incremental index of the specified generation. This updates the lastIncrementalIndex, and clears the uniqueServerId and claimedGeneration properties, releasing this configuration.

Parameters:

pConfigPath - The path of the configuration.

pContentId - The ID of the content set or null if not used.

pGeneration - The generation we completed indexing.

pCompletedSuccessfully - If incremental indexing completed successfully

pUseConfigurationClaims - If true, release configuration claim lock obtained at initialization

Throws:

IndexingException

getNextIncrementalGeneration

public java.lang.Integer getNextIncrementalGeneration(java.lang.String pConfigPath,
                                                      java.lang.String pContentId)
                                               throws IndexingException

Get the next incremental generation value from the configuration record.

Parameters:

pConfigPath - the configpath

Throws:

IndexingException

setNextIncrementalGeneration

protected void setNextIncrementalGeneration(java.lang.String pConfigPath,
                                            java.lang.String pContentId,
                                            int pGeneration)
                                     throws IndexingException

Set the next incremental version to a spcific value. This is used when external indexing errors, such as SearchAdmin, indexing engine, or deployment errors, occur and it is necessary to revert to a prior generation. It is assumed that the changes in the queue for these older generations have not been deleted.

Parameters:

pConfigPath - the IOC config path

pGeneration - the new, next incremental generation number

Throws:

IndexingException

completedIndex

protected void completedIndex(java.lang.String pConfigPath,
                              java.lang.String pContentId,
                              int pGeneration,
                              boolean pCompletedSuccessfully,
                              boolean pIncremental,
                              boolean pUseConfigurationClaims)
                       throws IndexingException

Release any claim on that generation. Increment nextIncrementalGeneration in "searchConfig" item if index was successful.

Parameters:

pCompletedSuccessfully - If incremental indexing completed successfully

Throws:

IndexingException

getLastFullIndexTime

public java.util.Date getLastFullIndexTime(java.lang.String pConfigPath,
                                           java.lang.String pContentId)
                                    throws IndexingException

Get the last full index time.

Throws:

IndexingException

getLastIncrementalIndexTime

public java.util.Date getLastIncrementalIndexTime(java.lang.String pConfigPath,
                                                  java.lang.String pContentId)
                                           throws IndexingException

Get the last incremental index time from the assocaited "configState" item.

Parameters:

pConfigPath -

pContentId -

Throws:

IndexingException

getConfigStateProperty

public java.lang.Object getConfigStateProperty(java.lang.String pConfigPath,
                                               java.lang.String pContentId,
                                               java.lang.String pPropertyName)
                                        throws IndexingException

Return the specified property value of the configuration state.

Parameters:

pConfigPath - the path of the configuration

pPropertyName - the property name. If null, return a ConfigState object.

Throws:

IndexingException

setConfigStateProperty

public void setConfigStateProperty(java.lang.String pConfigPath,
                                   java.lang.String pContentId,
                                   java.lang.String pPropertyName,
                                   java.lang.Object pValue)
                            throws IndexingException

Set the specified property value of the configuration state.

Parameters:

pConfigPath - the path of the configuration

pContentId - the content ID

pPropertyName - the property name. If null, return a ConfigState object.

pValue - the the new value for the ConfigState property.

Throws:

IndexingException

getConfigStateItemsByUniqueServerId

protected RepositoryItem[] getConfigStateItemsByUniqueServerId(java.lang.String pUniqueServerId)
                                                        throws RepositoryException

Return the repository items that are owned by the specified server Id. This method expects a transaction already in place.

Throws:

RepositoryException

getClaimedConfigStateItems

protected RepositoryItem[] getClaimedConfigStateItems()
                                               throws RepositoryException

Return the configuration items claimed by some server. Assumes a transaction is already in place.

Throws:

RepositoryException

getConfigStateItemsForConfig

public RepositoryItem[] getConfigStateItemsForConfig(java.lang.String pConfigPath)
                                              throws IndexingException

Throws:

IndexingException

getUnclaimedConfigStateItems

protected RepositoryItem[] getUnclaimedConfigStateItems()
                                                 throws RepositoryException

Return the configuration items claimed by some server. Assumes a transaction is already in place.

Throws:

RepositoryException

getUnclaimedConfigStates

public ConfigStatePersister.ConfigState[] getUnclaimedConfigStates()
                                                            throws IndexingException

Get the generation for the specified config. Will create a repository entry if none exists.

Throws:

IndexingException

createConfigState

protected ConfigStatePersister.ConfigState createConfigState(RepositoryItem pItem)

Create a configuration state from the specified repository item.

hasTimedOut

protected boolean hasTimedOut(RepositoryItem pItem)

Whether the lastActivity property on pItem is longer ago than timeOutMsecs.

Parameters:

pItem - the item whose lastActivity property will be consulted to look at timeout.

hasTimedOut

protected boolean hasTimedOut(long pLastActivity)

Whether the last activity time is considered timed out.

Parameters:

pLastActivity - The last activity time expressed in milliseconds.

releaseAllConfigurations

public void releaseAllConfigurations()
                              throws IndexingException

Release all configurations claimed by this server. This method is called by doStartService().

Throws:

IndexingException

logReleseConfigrationMessage

protected void logReleseConfigrationMessage(MutableRepositoryItem pConfigStateItem)

Log a detailed warning message when releasing expired configuration claims.

Parameters:

pConfigStateItem - The config state item being released.

releaseTimedOutConfigurations

public void releaseTimedOutConfigurations()
                                   throws IndexingException

Release all configurations claimed by this server. This method is called by doStartService().

Throws:

IndexingException

getCurrentGenerationForConfig

public int getCurrentGenerationForConfig(java.lang.String pConfigPath,
                                         java.lang.String pContentId)
                                  throws IndexingException

Get the current generation for the specified configuration.

Parameters:

pConfigPath - The absolute nucleus component path of the IOC

pContentId - The content set ID or null if not used

Returns:

the current generation for the specified configruation

Throws:

IndexingException

removedCachedValueForConfig

public void removedCachedValueForConfig(java.lang.String pConfigPath,
                                        java.lang.String pContentId)

Remove cached information for the specified configuration path, so that it will be fetched anew next time it is needed.

removeObsoleteConfigState

public void removeObsoleteConfigState(ConfigStatePersister.ConfigState pConfigState)
                               throws RepositoryException

Remove config state represented by pConfigState. Assumes an existing active tranascation.

Parameters:

pConfigState - The state to remove

Throws:

RepositoryException

doStartService

public void doStartService()
                    throws ServiceException

Start up the service...

Overrides:

doStartService in class atg.repository.search.indexing.RepositoryLockingService

Throws:

ServiceException - if the Service had a problem starting up

performAction

public void performAction()

Called after Nucleus starts, after this point it's safe to use the ClientLockManager and get actual global locks.

Specified by:

performAction in interface atg.nucleus.PostStartupAction

getClaimedLockName

public java.lang.String getClaimedLockName()

Specified by:

getClaimedLockName in class atg.repository.search.indexing.RepositoryLockingService