org.alfresco.repo.solr
Interface SOLRTrackingComponent

All Known Implementing Classes:

SOLRTrackingComponentImpl

public interface SOLRTrackingComponent

Interface for component to provide tracking data for SOLR.

Since:

4.0

Nested Class Summary

static interface	SOLRTrackingComponent.NodeMetaDataQueryCallback The interface that will be used to give query results to the calling code.
static interface	SOLRTrackingComponent.NodeQueryCallback The interface that will be used to give query results to the calling code.

Method Summary

java.util.List	getAclChangeSets(java.lang.Long minAclChangeSetId, java.lang.Long fromCommitTime, int maxResults) Get the ACL changesets for given range parameters
java.util.List	getAcls(java.util.List aclChangeSetIds, java.lang.Long minAclId, int maxResults) Get the ACLs with paging options for a specific ACL ChangeSet
java.util.List	getAclsReaders(java.util.List aclIds) Get the ACL readers ("authorities who can read this ACL") for a given set of ACL IDs
java.lang.Long	getMaxTxnCommitTime() Get the last transaction timestamp from the repo
AlfrescoModel	getModel(org.alfresco.service.namespace.QName modelName) Returns the Alfresco model given by the name modelName
java.util.List	getModelDiffs(java.util.Map models) Returns a list of diffs representing differences between the current Repository models and those passed in the models parameter.
void	getNodes(NodeParameters nodeParameters, SOLRTrackingComponent.NodeQueryCallback callback) Get the nodes satisfying the constraints in nodeParameters
void	getNodesMetadata(NodeMetaDataParameters nodeMetaDataParameters, MetaDataResultsFilter resultFilter, SOLRTrackingComponent.NodeMetaDataQueryCallback callback) Returns metadata for a set of node ids
java.util.List	getTransactions(java.lang.Long minTxnId, java.lang.Long fromCommitTime, int maxResults) Get the transactions from either minTxnId or fromCommitTime, optionally limited to maxResults
boolean	isEnabled()
void	setEnabled(boolean enabled)

Method Detail

getAclChangeSets

java.util.List getAclChangeSets(java.lang.Long minAclChangeSetId,
                                java.lang.Long fromCommitTime,
                                int maxResults)

Get the ACL changesets for given range parameters

Parameters:

minAclChangeSetId - minimum ACL changeset ID - (inclusive and optional)

fromCommitTime - minimum ACL commit time - (inclusive and optional)

maxResults - limit the results. 0 or Integer.MAX_VALUE does not limit the results

Returns:

list of ACL changesets

getAcls

java.util.List getAcls(java.util.List aclChangeSetIds,
                       java.lang.Long minAclId,
                       int maxResults)

Get the ACLs with paging options for a specific ACL ChangeSet

Parameters:

aclChangeSetIds - the ACL ChangeSet IDs

minAclId - the minimum ACL ID - (inclusive and optional).

maxResults - the maximum number of results (must be greater than zero and less than MAX)

Returns:

list of ACLs

getAclsReaders

java.util.List getAclsReaders(java.util.List aclIds)

Get the ACL readers ("authorities who can read this ACL") for a given set of ACL IDs

Parameters:

aclIds - the ACL IDs

Returns:

Returns the list of ACL readers (includes original ACL IDs)

getTransactions

java.util.List getTransactions(java.lang.Long minTxnId,
                               java.lang.Long fromCommitTime,
                               int maxResults)

Get the transactions from either minTxnId or fromCommitTime, optionally limited to maxResults

Parameters:

minTxnId - greater than or equal to minTxnId

fromCommitTime - greater than or equal to transaction commit time

maxResults - limit the results. 0 or Integer.MAX_VALUE does not limit the results

Returns:

list of transactions

getNodes

void getNodes(NodeParameters nodeParameters,
              SOLRTrackingComponent.NodeQueryCallback callback)

Get the nodes satisfying the constraints in nodeParameters

Parameters:

nodeParameters - set of constraints for which nodes to return

maxResults - limit the results. 0 or Integer.MAX_VALUE does not limit the results

callback - a callback to receive the results

getNodesMetadata

void getNodesMetadata(NodeMetaDataParameters nodeMetaDataParameters,
                      MetaDataResultsFilter resultFilter,
                      SOLRTrackingComponent.NodeMetaDataQueryCallback callback)

Returns metadata for a set of node ids

Parameters:

nodeIds - a set of nodeIds for which to return node metadata

maxResults - limit the results. 0 or Integer.MAX_VALUE does not limit the results

callback - a callback to receive the results

getModel

AlfrescoModel getModel(org.alfresco.service.namespace.QName modelName)

Returns the Alfresco model given by the name modelName

Parameters:

modelName - the name of the model

Returns:

the model plus a checksum

getModelDiffs

java.util.List getModelDiffs(java.util.Map models)

Returns a list of diffs representing differences between the current Repository models and those passed in the models parameter.

Parameters:

models - a set of mappings of model names to checksums

Returns:

a list of diffs between those in the repository and those passed in the models parameter

isEnabled

boolean isEnabled()

Returns:

setEnabled

void setEnabled(boolean enabled)

Parameters:

enabled -

getMaxTxnCommitTime

java.lang.Long getMaxTxnCommitTime()

Get the last transaction timestamp from the repo

Returns: