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

Nested Classes

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

Modifier and Type	Method and Description
List<AclChangeSet>	getAclChangeSets(Long minAclChangeSetId, Long fromCommitTime, Long maxAclChangeSetId, Long toCommitTime, int maxResults) Get the ACL changesets for given range parameters
List<Acl>	getAcls(List<Long> aclChangeSetIds, Long minAclId, int maxResults) Get the ACLs with paging options for a specific ACL ChangeSet
List<AclReaders>	getAclsReaders(List<Long> aclIds) Get the ACL readers ("authorities who can read this ACL") for a given set of ACL IDs
long	getCRC(Long nodeId) Compute the CRC for the parent associations to this node that can cause its PATH to change - primary & secondary associations and virtual associations from categories.
Long	getMaxChangeSetCommitTime()
Long	getMaxChangeSetId()
Long	getMaxTxnCommitTime() Get the last transaction timestamp from the repo
Long	getMaxTxnId() Get the last transaction id from the repo
AlfrescoModel	getModel(org.alfresco.service.namespace.QName modelName) Returns the Alfresco model given by the name modelName
List<AlfrescoModelDiff>	getModelDiffs(Map<org.alfresco.service.namespace.QName,Long> 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
ShardRegistry	getShardRegistry() Get the shard registry
List<Transaction>	getTransactions(Long minTxnId, Long fromCommitTime, Long maxTxnId, Long toCommitTimeint, int maxResults) Get the transactions from either minTxnId or fromCommitTime, optionally limited to maxResults
boolean	isEnabled()
void	registerShardState(org.alfresco.repo.index.shard.ShardState shardState) Register and update a shard state
void	setEnabled(boolean enabled)

Method Detail

getAclChangeSets

List<AclChangeSet> getAclChangeSets(Long minAclChangeSetId,
                                    Long fromCommitTime,
                                    Long maxAclChangeSetId,
                                    Long toCommitTime,
                                    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)

maxAclChangeSetId - max ACL changeset ID - (exclusive and optional)

toCommitTime - max ACL commit time - (exclusive and optional)

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

Returns:

list of ACL changesets

getAcls

List<Acl> getAcls(List<Long> aclChangeSetIds,
                  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

List<AclReaders> getAclsReaders(List<Long> 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

List<Transaction> getTransactions(Long minTxnId,
                                  Long fromCommitTime,
                                  Long maxTxnId,
                                  Long toCommitTimeint,
                                  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

maxTxnId - less than maxTxnId

toCommitTimeint - less then toCommitTimeint

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

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:

nodeMetaDataParameters - NodeMetaDataParameters

resultFilter - MetaDataResultsFilter

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

List<AlfrescoModelDiff> getModelDiffs(Map<org.alfresco.service.namespace.QName,Long> 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:

boolean

setEnabled

void setEnabled(boolean enabled)

Parameters:

enabled - boolean

getMaxTxnCommitTime

Long getMaxTxnCommitTime()

Get the last transaction timestamp from the repo

Returns:

Long

getMaxTxnId

Long getMaxTxnId()

Get the last transaction id from the repo

Returns:

Long

getMaxChangeSetCommitTime

Long getMaxChangeSetCommitTime()

Returns:

Long

getMaxChangeSetId

Long getMaxChangeSetId()

Returns:

Long

registerShardState

void registerShardState(org.alfresco.repo.index.shard.ShardState shardState)

Register and update a shard state

Parameters:

shardState -

getShardRegistry

ShardRegistry getShardRegistry()

Get the shard registry

Returns:

the shard registry or null if one is not registered. This is an optional feature.

getCRC

long getCRC(Long nodeId)

Compute the CRC for the parent associations to this node that can cause its PATH to change - primary & secondary associations and virtual associations from categories.

Parameters:

nodeId -

Returns: