Package org.alfresco.repo.solr
Interface SOLRTrackingComponent
-
- All Known Implementing Classes:
SOLRTrackingComponentImpl
public interface SOLRTrackingComponentInterface for component to provide tracking data for SOLR.- Since:
- 4.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceSOLRTrackingComponent.NodeMetaDataQueryCallbackThe interface that will be used to give query results to the calling code.static interfaceSOLRTrackingComponent.NodeQueryCallbackThe interface that will be used to give query results to the calling code.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<AclChangeSet>getAclChangeSets(java.lang.Long minAclChangeSetId, java.lang.Long fromCommitTime, java.lang.Long maxAclChangeSetId, java.lang.Long toCommitTime, int maxResults)Get the ACL changesets for given range parametersjava.util.List<Acl>getAcls(java.util.List<java.lang.Long> aclChangeSetIds, java.lang.Long minAclId, int maxResults)Get the ACLs with paging options for a specific ACL ChangeSetjava.util.List<AclReaders>getAclsReaders(java.util.List<java.lang.Long> aclIds)Get the ACL readers ("authorities who can read this ACL") for a given set of ACL IDslonggetCRC(java.lang.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.java.lang.LonggetMaxChangeSetCommitTime()java.lang.LonggetMaxChangeSetId()java.lang.LonggetMaxTxnCommitTime()Get the last transaction timestamp from the repojava.lang.LonggetMaxTxnId()Get the last transaction id from the repoAlfrescoModelgetModel(org.alfresco.service.namespace.QName modelName)Returns the Alfresco model given by the name modelNamejava.util.List<AlfrescoModelDiff>getModelDiffs(java.util.Map<org.alfresco.service.namespace.QName,java.lang.Long> models)Returns a list of diffs representing differences between the current Repository models and those passed in the models parameter.voidgetNodes(NodeParameters nodeParameters, SOLRTrackingComponent.NodeQueryCallback callback)Get the nodes satisfying the constraints in nodeParametersvoidgetNodesMetadata(NodeMetaDataParameters nodeMetaDataParameters, MetaDataResultsFilter resultFilter, SOLRTrackingComponent.NodeMetaDataQueryCallback callback)Returns metadata for a set of node idsShardRegistrygetShardRegistry()Get the shard registryjava.util.List<Transaction>getTransactions(java.lang.Long minTxnId, java.lang.Long fromCommitTime, java.lang.Long maxTxnId, java.lang.Long toCommitTimeint, int maxResults)Get the transactions from either minTxnId or fromCommitTime, optionally limited to maxResultsbooleanisEnabled()voidregisterShardState(org.alfresco.repo.index.shard.ShardState shardState)Register and update a shard statevoidsetEnabled(boolean enabled)
-
-
-
Method Detail
-
getAclChangeSets
java.util.List<AclChangeSet> getAclChangeSets(java.lang.Long minAclChangeSetId, java.lang.Long fromCommitTime, java.lang.Long maxAclChangeSetId, java.lang.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
java.util.List<Acl> getAcls(java.util.List<java.lang.Long> aclChangeSetIds, java.lang.Long minAclId, int maxResults)
Get the ACLs with paging options for a specific ACL ChangeSet- Parameters:
aclChangeSetIds- the ACL ChangeSet IDsminAclId- 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<AclReaders> getAclsReaders(java.util.List<java.lang.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
java.util.List<Transaction> getTransactions(java.lang.Long minTxnId, java.lang.Long fromCommitTime, java.lang.Long maxTxnId, java.lang.Long toCommitTimeint, int maxResults)
Get the transactions from either minTxnId or fromCommitTime, optionally limited to maxResults- Parameters:
minTxnId- greater than or equal to minTxnIdfromCommitTime- greater than or equal to transaction commit timemaxTxnId- less than maxTxnIdtoCommitTimeint- less then toCommitTimeintmaxResults- 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 returncallback- 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- NodeMetaDataParametersresultFilter- MetaDataResultsFiltercallback- 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<AlfrescoModelDiff> getModelDiffs(java.util.Map<org.alfresco.service.namespace.QName,java.lang.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
java.lang.Long getMaxTxnCommitTime()
Get the last transaction timestamp from the repo- Returns:
- Long
-
getMaxTxnId
java.lang.Long getMaxTxnId()
Get the last transaction id from the repo- Returns:
- Long
-
getMaxChangeSetCommitTime
java.lang.Long getMaxChangeSetCommitTime()
- Returns:
- Long
-
getMaxChangeSetId
java.lang.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(java.lang.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:
-
-