Package org.alfresco.solr.tracker

Class AbstractTracker

java.lang.Object

org.alfresco.solr.tracker.AbstractTracker

All Implemented Interfaces:

Tracker

Direct Known Subclasses:

AclTracker, CascadeTracker, CommitTracker, ContentTracker, MetadataTracker, ModelTracker

public abstract class AbstractTracker
extends Object
implements Tracker

Abstract base class that provides common Tracker behaviour.

Author:

Matt Ward

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.solr.tracker.Tracker

Tracker.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alfrescoVersion
protected long	batchCount
protected org.alfresco.solr.client.SOLRAPIClient	client
protected String	coreName
protected InformationServer	infoSrv
protected boolean	isMaster
protected boolean	isSlave
protected static org.slf4j.Logger	log
protected Properties	props
protected boolean	rollback
protected boolean	runPostModelLoadInit
static String	SHARD_METHOD_ACLID
static String	SHARD_METHOD_DBID
protected int	shardCount
protected int	shardInstance
protected String	shardMethod
protected String	shardTemplate
protected org.alfresco.solr.TrackerState	state
protected org.alfresco.service.cmr.repository.StoreRef	storeRef
protected ThreadHandler	threadHandler
static long	TIME_STEP_1_HR_IN_MS
static long	TIME_STEP_32_DAYS_IN_MS
protected org.alfresco.solr.tracker.TrackerStats	trackerStats
protected boolean	transformContent
protected Tracker.Type	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTracker(Properties p, org.alfresco.solr.client.SOLRAPIClient client, String coreName, InformationServer informationServer, Tracker.Type type)
protected	AbstractTracker(Tracker.Type type)	Default constructor, strictly for testing.

Method Summary

Modifier and Type	Method	Description
protected void	checkShutdown()
protected abstract void	doTrack()	Subclasses must implement behaviour that completes the following steps, in order: Purge Reindex Index Track repository
String	getAlfrescoVersion()
int	getMaxLiveSearchers()
Properties	getProps()
boolean	getRollback()
Semaphore	getRunLock()
org.alfresco.solr.TrackerState	getTrackerState()
Tracker.Type	getType()
Semaphore	getWriteLock()
void	invalidateState()
void	setRollback(boolean rollback)
void	setShutdown(boolean shutdown)
void	shutdown()
void	track()	Template method - subclasses must implement the Tracker-specific indexing by implementing the abstract method doTrack().
protected void	waitForAsynchronous()	Allows time for the scheduled asynchronous tasks to complete

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.alfresco.solr.tracker.Tracker

hasMaintenance, maintenance

Field Detail

TIME_STEP_32_DAYS_IN_MS

public static final long TIME_STEP_32_DAYS_IN_MS

See Also:

Constant Field Values

TIME_STEP_1_HR_IN_MS

public static final long TIME_STEP_1_HR_IN_MS

See Also:

Constant Field Values

SHARD_METHOD_ACLID

public static final String SHARD_METHOD_ACLID

See Also:

Constant Field Values

SHARD_METHOD_DBID

public static final String SHARD_METHOD_DBID

See Also:

Constant Field Values

log

protected static final org.slf4j.Logger log

props

protected Properties props

client

protected org.alfresco.solr.client.SOLRAPIClient client

infoSrv

protected InformationServer infoSrv

coreName

protected String coreName

storeRef

protected org.alfresco.service.cmr.repository.StoreRef storeRef

batchCount

protected long batchCount

isSlave

protected boolean isSlave

isMaster

protected boolean isMaster

alfrescoVersion

protected String alfrescoVersion

trackerStats

protected org.alfresco.solr.tracker.TrackerStats trackerStats

runPostModelLoadInit

protected boolean runPostModelLoadInit

state

protected volatile org.alfresco.solr.TrackerState state

shardCount

protected int shardCount

shardInstance

protected int shardInstance

shardMethod

protected String shardMethod

transformContent

protected boolean transformContent

shardTemplate

protected String shardTemplate

rollback

protected volatile boolean rollback

type

protected final Tracker.Type type

threadHandler

protected ThreadHandler threadHandler

Constructor Detail

AbstractTracker

protected AbstractTracker(Tracker.Type type)

Default constructor, strictly for testing.

AbstractTracker

protected AbstractTracker(Properties p,
                          org.alfresco.solr.client.SOLRAPIClient client,
                          String coreName,
                          InformationServer informationServer,
                          Tracker.Type type)

Method Detail

doTrack

protected abstract void doTrack()
                         throws Throwable

Subclasses must implement behaviour that completes the following steps, in order:

1. Purge
2. Reindex
3. Index
4. Track repository

Throws:

Throwable

track

public void track()

Template method - subclasses must implement the Tracker-specific indexing by implementing the abstract method doTrack().

Specified by:

track in interface Tracker

getRollback

public boolean getRollback()

Specified by:

getRollback in interface Tracker

setRollback

public void setRollback(boolean rollback)

Specified by:

setRollback in interface Tracker

invalidateState

public void invalidateState()

Specified by:

invalidateState in interface Tracker

getTrackerState

public org.alfresco.solr.TrackerState getTrackerState()

Specified by:

getTrackerState in interface Tracker

waitForAsynchronous

protected void waitForAsynchronous()

Allows time for the scheduled asynchronous tasks to complete

getMaxLiveSearchers

public int getMaxLiveSearchers()

checkShutdown

protected void checkShutdown()

setShutdown

public void setShutdown(boolean shutdown)

Specified by:

setShutdown in interface Tracker

shutdown

public void shutdown()

Specified by:

shutdown in interface Tracker

getWriteLock

public Semaphore getWriteLock()

Specified by:

getWriteLock in interface Tracker

getRunLock

public Semaphore getRunLock()

getAlfrescoVersion

public String getAlfrescoVersion()

Specified by:

getAlfrescoVersion in interface Tracker

Returns:

Alfresco version Solr was built for

getProps

public Properties getProps()

Specified by:

getProps in interface Tracker

getType

public Tracker.Type getType()

Specified by:

getType in interface Tracker