org.alfresco.repo.solr

Class SOLRTrackingComponentImpl

java.lang.Object

org.alfresco.repo.solr.SOLRTrackingComponentImpl

All Implemented Interfaces:

SOLRTrackingComponent

public class SOLRTrackingComponentImpl
extends Object
implements SOLRTrackingComponent

Component providing data for SOLR tracking

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SOLRTrackingComponentImpl.NodeMetaDataQueryRowHandler Class that passes results from a result entity into the client callback
protected class	SOLRTrackingComponentImpl.NodeQueryRowHandler Class that passes results from a result entity into the client callback

Nested classes/interfaces inherited from interface org.alfresco.repo.solr.SOLRTrackingComponent

SOLRTrackingComponent.NodeMetaDataQueryCallback, SOLRTrackingComponent.NodeQueryCallback

Constructor Summary

Constructors

Constructor and Description
SOLRTrackingComponentImpl()

Method Summary

Modifier and Type	Method and Description
protected org.alfresco.service.cmr.repository.NodeRef	convertVersionNodeRefToVersionedNodeRef(org.alfresco.service.cmr.repository.NodeRef versionNodeRef)
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
protected Map<org.alfresco.service.namespace.QName,Serializable>	getProperties(Long nodeId)
ShardRegistry	getShardRegistry() Get the shard registry
List<Transaction>	getTransactions(Long minTxnId, Long fromCommitTime, Long maxTxnId, Long toCommitTime, int maxResults) Get the transactions from either minTxnId or fromCommitTime, optionally limited to maxResults
void	init() Initialize
boolean	isEnabled()
void	registerShardState(org.alfresco.repo.index.shard.ShardState shardState) Register and update a shard state
void	setAclDAO(AclDAO aclDAO)
void	setAspectIndexFilter(AspectIndexFilter aspectIndexFilter)
void	setCacheAncestors(boolean cacheAncestors)
void	setDictionaryDAO(org.alfresco.repo.dictionary.DictionaryDAO dictionaryDAO)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setEnabled(boolean enabled)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setNodeDAO(NodeDAO nodeDAO)
void	setOwnableService(OwnableService ownableService)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setQnameDAO(QNameDAO qnameDAO)
void	setShardRegistry(ShardRegistry shardRegistry)
void	setSolrDAO(SOLRDAO solrDAO)
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
void	setTypeIndexFilter(TypeIndexFilter typeIndexFilter)

Methods inherited from class java.lang.Object

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

Constructor Detail

SOLRTrackingComponentImpl

public SOLRTrackingComponentImpl()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface SOLRTrackingComponent

Returns:

boolean

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface SOLRTrackingComponent

Parameters:

enabled - boolean

setCacheAncestors

public void setCacheAncestors(boolean cacheAncestors)

Parameters:

cacheAncestors - the cacheAncestors to set

setSolrDAO

public void setSolrDAO(SOLRDAO solrDAO)

setNodeDAO

public void setNodeDAO(NodeDAO nodeDAO)

setQnameDAO

public void setQnameDAO(QNameDAO qnameDAO)

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

setOwnableService

public void setOwnableService(OwnableService ownableService)

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setAclDAO

public void setAclDAO(AclDAO aclDAO)

setDictionaryDAO

public void setDictionaryDAO(org.alfresco.repo.dictionary.DictionaryDAO dictionaryDAO)

setTypeIndexFilter

public void setTypeIndexFilter(TypeIndexFilter typeIndexFilter)

setAspectIndexFilter

public void setAspectIndexFilter(AspectIndexFilter aspectIndexFilter)

setShardRegistry

public void setShardRegistry(ShardRegistry shardRegistry)

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)

init

public void init()

Initialize

getAclChangeSets

public List<AclChangeSet> getAclChangeSets(Long minAclChangeSetId,
                                           Long fromCommitTime,
                                           Long maxAclChangeSetId,
                                           Long toCommitTime,
                                           int maxResults)

Description copied from interface: SOLRTrackingComponent

Get the ACL changesets for given range parameters

Specified by:

getAclChangeSets in interface SOLRTrackingComponent

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

public List<Acl> getAcls(List<Long> aclChangeSetIds,
                         Long minAclId,
                         int maxResults)

Description copied from interface: SOLRTrackingComponent

Get the ACLs with paging options for a specific ACL ChangeSet

Specified by:

getAcls in interface SOLRTrackingComponent

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

public List<AclReaders> getAclsReaders(List<Long> aclIds)

Description copied from interface: SOLRTrackingComponent

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

Specified by:

getAclsReaders in interface SOLRTrackingComponent

Parameters:

aclIds - the ACL IDs

Returns:

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

getTransactions

public List<Transaction> getTransactions(Long minTxnId,
                                         Long fromCommitTime,
                                         Long maxTxnId,
                                         Long toCommitTime,
                                         int maxResults)

Description copied from interface: SOLRTrackingComponent

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

Specified by:

getTransactions in interface SOLRTrackingComponent

Parameters:

minTxnId - greater than or equal to minTxnId

fromCommitTime - greater than or equal to transaction commit time

maxTxnId - less than maxTxnId

toCommitTime - less then toCommitTimeint

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

Returns:

list of transactions

getNodes

public void getNodes(NodeParameters nodeParameters,
                     SOLRTrackingComponent.NodeQueryCallback callback)

Get the nodes satisfying the constraints in nodeParameters

Specified by:

getNodes in interface SOLRTrackingComponent

Parameters:

nodeParameters - set of constraints for which nodes to return

callback - a callback to receive the results

getProperties

protected Map<org.alfresco.service.namespace.QName,Serializable> getProperties(Long nodeId)

getCRC

public long getCRC(Long nodeId)

Description copied from interface: SOLRTrackingComponent

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.

Specified by:

getCRC in interface SOLRTrackingComponent

Returns:

getNodesMetadata

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

Returns metadata for a set of node ids

Specified by:

getNodesMetadata in interface SOLRTrackingComponent

Parameters:

nodeMetaDataParameters - NodeMetaDataParameters

resultFilter - MetaDataResultsFilter

callback - a callback to receive the results

convertVersionNodeRefToVersionedNodeRef

protected org.alfresco.service.cmr.repository.NodeRef convertVersionNodeRefToVersionedNodeRef(org.alfresco.service.cmr.repository.NodeRef versionNodeRef)

getModel

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

Returns the Alfresco model given by the name modelName

Specified by:

getModel in interface SOLRTrackingComponent

Parameters:

modelName - the name of the model

Returns:

the model plus a checksum

getModelDiffs

public 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.

Specified by:

getModelDiffs in interface SOLRTrackingComponent

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

getMaxTxnCommitTime

public Long getMaxTxnCommitTime()

Description copied from interface: SOLRTrackingComponent

Get the last transaction timestamp from the repo

Specified by:

getMaxTxnCommitTime in interface SOLRTrackingComponent

Returns:

Long

getMaxTxnId

public Long getMaxTxnId()

Description copied from interface: SOLRTrackingComponent

Get the last transaction id from the repo

Specified by:

getMaxTxnId in interface SOLRTrackingComponent

Returns:

Long

getMaxChangeSetCommitTime

public Long getMaxChangeSetCommitTime()

Specified by:

getMaxChangeSetCommitTime in interface SOLRTrackingComponent

Returns:

Long

getMaxChangeSetId

public Long getMaxChangeSetId()

Specified by:

getMaxChangeSetId in interface SOLRTrackingComponent

Returns:

Long

registerShardState

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

Description copied from interface: SOLRTrackingComponent

Register and update a shard state

Specified by:

registerShardState in interface SOLRTrackingComponent

getShardRegistry

public ShardRegistry getShardRegistry()

Description copied from interface: SOLRTrackingComponent

Get the shard registry

Specified by:

getShardRegistry in interface SOLRTrackingComponent

Returns:

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