Package org.alfresco.solr

Class SolrInformationServer

java.lang.Object

org.alfresco.solr.SolrInformationServer

All Implemented Interfaces:

InformationServer, org.alfresco.solr.InformationServerCollectionProvider

public class SolrInformationServer
extends java.lang.Object
implements InformationServer

This is the Apache Solr implementation of the information server (index).

Since:

5.0

Author:

Ahmed Owian

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	AND
static java.lang.String	CASCADE_TRACKER_ENABLED	Shared property to determine if the cascade tracking is enabled.
static java.lang.String	DOC_TYPE_ACL
static java.lang.String	DOC_TYPE_ACL_TX
static java.lang.String	DOC_TYPE_NODE
static java.lang.String	DOC_TYPE_TX
static java.lang.String	OR
static java.lang.String	SOLR_BASEURL
static java.lang.String	SOLR_HOST
static java.lang.String	SOLR_PORT
static java.lang.String	UNIT_OF_TIME_DAY_FIELD_SUFFIX
static java.lang.String	UNIT_OF_TIME_DAY_OF_WEEK_FIELD_SUFFIX
static java.lang.String	UNIT_OF_TIME_DAY_OF_YEAR_FIELD_SUFFIX
static java.lang.String	UNIT_OF_TIME_HOUR_FIELD_SUFFIX
static java.lang.String	UNIT_OF_TIME_MINUTE_FIELD_SUFFIX
static java.lang.String	UNIT_OF_TIME_MONTH_FIELD_SUFFIX
static java.lang.String	UNIT_OF_TIME_QUARTER_FIELD_SUFFIX
static java.lang.String	UNIT_OF_TIME_SECOND_FIELD_SUFFIX
static java.lang.String	UNIT_OF_TIME_YEAR_FIELD_SUFFIX

Fields inherited from interface org.alfresco.solr.InformationServer

PROP_PREFIX_PARENT_ASPECT, PROP_PREFIX_PARENT_TYPE

Constructor Summary

Constructors

Constructor	Description
SolrInformationServer(AlfrescoCoreAdminHandler adminHandler, org.apache.solr.core.SolrCore core, org.alfresco.solr.client.SOLRAPIClient repositoryClient)

Method Summary

Modifier and Type	Method	Description
boolean	aclChangeSetInIndex(long changeSetId, boolean populateCache)
void	addCommonNodeReportInfo(org.alfresco.solr.NodeReport nodeReport)
void	addContentOutdatedAndUpdatedCounts(org.apache.solr.common.util.NamedList<java.lang.Object> report)	The outdated node are computed counting all nodes that have LATEST_APPLIED_CONTENT_VERSION_ID = DOC_TYPE = {@link #DOC_TYPE_NODE} The updated nodes are computed by simply subtracting the count above from the total number of documents that represent nodes. However, keep in mind that using the two fields LATEST_APPLIED_CONTENT_VERSION_ID and LAST_INCOMING_CONTENT_VERSION_ID there's another (more expensive) way to compute the same information: the following query should return the same result (i.e. number of updated nodes): facet.query={!frange key='UPDATED' l=0}sub(LAST_INCOMING_CONTENT_VERSION_ID,LATEST_APPLIED_CONTENT_VERSION_ID)
void	afterInitModels()
void	capIndex(long dbid)
void	cascadeNodes(java.util.List<org.alfresco.solr.client.NodeMetaData> nodeMetaDatas, boolean overwrite)
boolean	cascadeTrackingEnabled()	Check if cascade tracking is enabled.
org.alfresco.solr.AclReport	checkAclInIndex(java.lang.Long aclid, org.alfresco.solr.AclReport aclReport)
void	clearProcessedAclChangeSets()
void	clearProcessedTransactions()
void	commit()
boolean	commit(boolean openSearcher)
void	continueState(org.alfresco.solr.TrackerState state)
void	deleteByAclChangeSetId(java.lang.Long aclChangeSetId)
void	deleteByAclId(java.lang.Long aclId)
void	deleteByNodeId(java.lang.Long nodeId)
void	deleteByTransactionId(java.lang.Long transactionId)
void	dirtyTransaction(long txnId)
int	getAclTxDocsSize(java.lang.String aclTxId, java.lang.String aclTxCommitTime)
AlfrescoCoreAdminHandler	getAdminHandler()
java.util.List<org.alfresco.solr.client.AlfrescoModel>	getAlfrescoModels()
java.lang.String	getBaseUrl()
java.util.List<org.alfresco.solr.client.NodeMetaData>	getCascadeNodes(java.util.List<java.lang.Long> txnIds)
java.util.List<org.alfresco.solr.client.Transaction>	getCascades(int num)
java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>	getCoreStats()
org.alfresco.repo.dictionary.DictionaryComponent	getDictionaryService(java.lang.String alternativeDictionary)
int	getDocListSize(java.lang.String query)
java.util.List<AlfrescoSolrDataModel.TenantDbId>	getDocsWithUncleanContent()
java.util.Set<java.lang.Long>	getErrorDocIds()
long	getHoleRetention()
java.lang.String	getHostName()
long	getIndexCap()
org.alfresco.repo.dictionary.M2Model	getM2Model(org.alfresco.service.namespace.QName modelQName)
org.alfresco.solr.client.AclChangeSet	getMaxAclChangeSetIdAndCommitTimeInIndex()
org.alfresco.solr.client.Transaction	getMaxTransactionIdAndCommitTimeInIndex()
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getModelErrors()
org.alfresco.repo.dictionary.NamespaceDAO	getNamespaceDAO()
org.alfresco.solr.adapters.IOpenBitSet	getOpenBitSetInstance()
int	getPort()
java.util.Properties	getProps()
int	getRegisteredSearcherCount()
<T> org.alfresco.solr.adapters.ISimpleOrderedMap<T>	getSimpleOrderedMapInstance()
org.alfresco.solr.TrackerState	getTrackerInitialState()
org.alfresco.solr.tracker.TrackerStats	getTrackerStats()
int	getTxDocsSize(java.lang.String targetTxId, java.lang.String targetTxCommitTime)
void	hardCommit()
long	indexAcl(java.util.List<org.alfresco.solr.client.AclReaders> aclReaderList, boolean overwrite)
void	indexAclTransaction(org.alfresco.solr.client.AclChangeSet changeSet, boolean overwrite)
void	indexNode(org.alfresco.solr.client.Node node, boolean overwrite)
void	indexNodes(java.util.List<org.alfresco.solr.client.Node> nodes, boolean overwrite)
void	indexTransaction(org.alfresco.solr.client.Transaction info, boolean overwrite)
void	initSkippingDescendantDocs()
boolean	isInIndex(java.lang.String id)
void	maintainCap(long dbid)
long	maxNodeId()
long	minNodeId()
long	nodeCount()
boolean	putModel(org.alfresco.repo.dictionary.M2Model model)
void	registerTrackerThread()
void	reindexNodeByQuery(java.lang.String query)
org.alfresco.solr.tracker.IndexHealthReport	reportAclTransactionsInIndex(java.lang.Long minAclTxId, org.alfresco.solr.adapters.IOpenBitSet aclTxIdsInDb, long maxAclTxId)
org.alfresco.solr.tracker.IndexHealthReport	reportIndexTransactions(java.lang.Long minTxId, org.alfresco.solr.adapters.IOpenBitSet txIdsInDb, long maxTxId)
void	rollback()
void	setCleanCascadeTxnFloor(long cleanCascadeTxnFloor)
void	setCleanContentTxnFloor(long cleanContentTxnFloor)
boolean	txnInIndex(long txnId, boolean populateCache)
void	unregisterTrackerThread()
void	updateContent(AlfrescoSolrDataModel.TenantDbId docRef)
protected void	updatePathRelatedFields(org.alfresco.solr.client.NodeMetaData nodeMetaData, org.apache.solr.common.SolrInputDocument doc)
void	updateTransaction(org.alfresco.solr.client.Transaction txn)

Methods inherited from class java.lang.Object

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

Field Detail

AND

public static final java.lang.String AND

See Also:

Constant Field Values

OR

public static final java.lang.String OR

See Also:

Constant Field Values

DOC_TYPE_NODE

public static final java.lang.String DOC_TYPE_NODE

See Also:

Constant Field Values

DOC_TYPE_ACL

public static final java.lang.String DOC_TYPE_ACL

See Also:

Constant Field Values

DOC_TYPE_TX

public static final java.lang.String DOC_TYPE_TX

See Also:

Constant Field Values

DOC_TYPE_ACL_TX

public static final java.lang.String DOC_TYPE_ACL_TX

See Also:

Constant Field Values

SOLR_HOST

public static final java.lang.String SOLR_HOST

See Also:

Constant Field Values

SOLR_PORT

public static final java.lang.String SOLR_PORT

See Also:

Constant Field Values

SOLR_BASEURL

public static final java.lang.String SOLR_BASEURL

See Also:

Constant Field Values

CASCADE_TRACKER_ENABLED

public static final java.lang.String CASCADE_TRACKER_ENABLED

Shared property to determine if the cascade tracking is enabled.

See Also:

Constant Field Values

UNIT_OF_TIME_YEAR_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_YEAR_FIELD_SUFFIX

See Also:

Constant Field Values

UNIT_OF_TIME_QUARTER_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_QUARTER_FIELD_SUFFIX

See Also:

Constant Field Values

UNIT_OF_TIME_MONTH_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_MONTH_FIELD_SUFFIX

See Also:

Constant Field Values

UNIT_OF_TIME_DAY_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_DAY_FIELD_SUFFIX

See Also:

Constant Field Values

UNIT_OF_TIME_DAY_OF_WEEK_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_DAY_OF_WEEK_FIELD_SUFFIX

See Also:

Constant Field Values

UNIT_OF_TIME_DAY_OF_YEAR_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_DAY_OF_YEAR_FIELD_SUFFIX

See Also:

Constant Field Values

UNIT_OF_TIME_HOUR_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_HOUR_FIELD_SUFFIX

See Also:

Constant Field Values

UNIT_OF_TIME_MINUTE_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_MINUTE_FIELD_SUFFIX

See Also:

Constant Field Values

UNIT_OF_TIME_SECOND_FIELD_SUFFIX

public static final java.lang.String UNIT_OF_TIME_SECOND_FIELD_SUFFIX

See Also:

Constant Field Values

Constructor Detail

SolrInformationServer

public SolrInformationServer(AlfrescoCoreAdminHandler adminHandler,
                             org.apache.solr.core.SolrCore core,
                             org.alfresco.solr.client.SOLRAPIClient repositoryClient)

Method Detail

getAdminHandler

public AlfrescoCoreAdminHandler getAdminHandler()

Specified by:

getAdminHandler in interface InformationServer

cascadeTrackingEnabled

public boolean cascadeTrackingEnabled()

Description copied from interface: InformationServer

Check if cascade tracking is enabled.

Specified by:

cascadeTrackingEnabled in interface InformationServer

Returns:

true if cascade tracking is enabled (note that this is the default behaviour if not specified in the properties file).

initSkippingDescendantDocs

public void initSkippingDescendantDocs()

Specified by:

initSkippingDescendantDocs in interface InformationServer

addContentOutdatedAndUpdatedCounts

public void addContentOutdatedAndUpdatedCounts(org.apache.solr.common.util.NamedList<java.lang.Object> report)

The outdated node are computed counting all nodes that have

• LATEST_APPLIED_CONTENT_VERSION_ID =
• DOC_TYPE = {@link #DOC_TYPE_NODE}

The updated nodes are computed by simply subtracting the count above from the total number of documents that represent nodes. However, keep in mind that using the two fields LATEST_APPLIED_CONTENT_VERSION_ID and LAST_INCOMING_CONTENT_VERSION_ID there's another (more expensive) way to compute the same information: the following query should return the same result (i.e. number of updated nodes):

   facet.query={!frange key='UPDATED' l=0}sub(LAST_INCOMING_CONTENT_VERSION_ID,LATEST_APPLIED_CONTENT_VERSION_ID)
 

Specified by:

addContentOutdatedAndUpdatedCounts in interface InformationServer

afterInitModels

public void afterInitModels()

Specified by:

afterInitModels in interface InformationServer

checkAclInIndex

public org.alfresco.solr.AclReport checkAclInIndex(java.lang.Long aclid,
                                                   org.alfresco.solr.AclReport aclReport)

Specified by:

checkAclInIndex in interface InformationServer

reportIndexTransactions

public org.alfresco.solr.tracker.IndexHealthReport reportIndexTransactions(java.lang.Long minTxId,
                                                                           org.alfresco.solr.adapters.IOpenBitSet txIdsInDb,
                                                                           long maxTxId)

Specified by:

reportIndexTransactions in interface InformationServer

reportAclTransactionsInIndex

public org.alfresco.solr.tracker.IndexHealthReport reportAclTransactionsInIndex(java.lang.Long minAclTxId,
                                                                                org.alfresco.solr.adapters.IOpenBitSet aclTxIdsInDb,
                                                                                long maxAclTxId)

Specified by:

reportAclTransactionsInIndex in interface InformationServer

getDocsWithUncleanContent

public java.util.List<AlfrescoSolrDataModel.TenantDbId> getDocsWithUncleanContent()
                                                                           throws java.io.IOException

Specified by:

getDocsWithUncleanContent in interface InformationServer

Throws:

java.io.IOException

addCommonNodeReportInfo

public void addCommonNodeReportInfo(org.alfresco.solr.NodeReport nodeReport)

Specified by:

addCommonNodeReportInfo in interface InformationServer

commit

public void commit()
            throws java.io.IOException

Specified by:

commit in interface InformationServer

Throws:

java.io.IOException

hardCommit

public void hardCommit()
                throws java.io.IOException

Specified by:

hardCommit in interface InformationServer

Throws:

java.io.IOException

commit

public boolean commit(boolean openSearcher)
               throws java.io.IOException

Specified by:

commit in interface InformationServer

Throws:

java.io.IOException

deleteByAclChangeSetId

public void deleteByAclChangeSetId(java.lang.Long aclChangeSetId)
                            throws java.io.IOException

Specified by:

deleteByAclChangeSetId in interface InformationServer

Throws:

java.io.IOException

deleteByAclId

public void deleteByAclId(java.lang.Long aclId)
                   throws java.io.IOException

Specified by:

deleteByAclId in interface InformationServer

Throws:

java.io.IOException

deleteByNodeId

public void deleteByNodeId(java.lang.Long nodeId)
                    throws java.io.IOException

Specified by:

deleteByNodeId in interface InformationServer

Throws:

java.io.IOException

deleteByTransactionId

public void deleteByTransactionId(java.lang.Long transactionId)
                           throws java.io.IOException

Specified by:

deleteByTransactionId in interface InformationServer

Throws:

java.io.IOException

getAlfrescoModels

public java.util.List<org.alfresco.solr.client.AlfrescoModel> getAlfrescoModels()

Specified by:

getAlfrescoModels in interface InformationServer

getCoreStats

public java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>> getCoreStats()
                                                                                              throws java.io.IOException

Specified by:

getCoreStats in interface InformationServer

Throws:

java.io.IOException

getDictionaryService

public org.alfresco.repo.dictionary.DictionaryComponent getDictionaryService(java.lang.String alternativeDictionary)

Specified by:

getDictionaryService in interface InformationServer

getTxDocsSize

public int getTxDocsSize(java.lang.String targetTxId,
                         java.lang.String targetTxCommitTime)

Specified by:

getTxDocsSize in interface InformationServer

getAclTxDocsSize

public int getAclTxDocsSize(java.lang.String aclTxId,
                            java.lang.String aclTxCommitTime)

Specified by:

getAclTxDocsSize in interface InformationServer

getErrorDocIds

public java.util.Set<java.lang.Long> getErrorDocIds()
                                             throws java.io.IOException

Specified by:

getErrorDocIds in interface InformationServer

Throws:

java.io.IOException

getHoleRetention

public long getHoleRetention()

Specified by:

getHoleRetention in interface InformationServer

getM2Model

public org.alfresco.repo.dictionary.M2Model getM2Model(org.alfresco.service.namespace.QName modelQName)

Specified by:

getM2Model in interface InformationServer

getModelErrors

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getModelErrors()

Specified by:

getModelErrors in interface InformationServer

getNamespaceDAO

public org.alfresco.repo.dictionary.NamespaceDAO getNamespaceDAO()

Specified by:

getNamespaceDAO in interface InformationServer

getOpenBitSetInstance

public org.alfresco.solr.adapters.IOpenBitSet getOpenBitSetInstance()

Specified by:

getOpenBitSetInstance in interface org.alfresco.solr.InformationServerCollectionProvider

getRegisteredSearcherCount

public int getRegisteredSearcherCount()

Specified by:

getRegisteredSearcherCount in interface InformationServer

getSimpleOrderedMapInstance

public <T> org.alfresco.solr.adapters.ISimpleOrderedMap<T> getSimpleOrderedMapInstance()

Specified by:

getSimpleOrderedMapInstance in interface org.alfresco.solr.InformationServerCollectionProvider

getTrackerStats

public org.alfresco.solr.tracker.TrackerStats getTrackerStats()

Specified by:

getTrackerStats in interface InformationServer

getTrackerInitialState

public org.alfresco.solr.TrackerState getTrackerInitialState()

Specified by:

getTrackerInitialState in interface InformationServer

continueState

public void continueState(org.alfresco.solr.TrackerState state)

Specified by:

continueState in interface InformationServer

indexAcl

public long indexAcl(java.util.List<org.alfresco.solr.client.AclReaders> aclReaderList,
                     boolean overwrite)
              throws java.io.IOException

Specified by:

indexAcl in interface InformationServer

Throws:

java.io.IOException

indexAclTransaction

public void indexAclTransaction(org.alfresco.solr.client.AclChangeSet changeSet,
                                boolean overwrite)
                         throws java.io.IOException

Specified by:

indexAclTransaction in interface InformationServer

Throws:

java.io.IOException

getMaxAclChangeSetIdAndCommitTimeInIndex

public org.alfresco.solr.client.AclChangeSet getMaxAclChangeSetIdAndCommitTimeInIndex()

Specified by:

getMaxAclChangeSetIdAndCommitTimeInIndex in interface InformationServer

dirtyTransaction

public void dirtyTransaction(long txnId)

Specified by:

dirtyTransaction in interface InformationServer

capIndex

public void capIndex(long dbid)
              throws java.io.IOException

Specified by:

capIndex in interface InformationServer

Throws:

java.io.IOException

maintainCap

public void maintainCap(long dbid)
                 throws java.io.IOException

Specified by:

maintainCap in interface InformationServer

Throws:

java.io.IOException

nodeCount

public long nodeCount()

Specified by:

nodeCount in interface InformationServer

maxNodeId

public long maxNodeId()

Specified by:

maxNodeId in interface InformationServer

minNodeId

public long minNodeId()

Specified by:

minNodeId in interface InformationServer

getIndexCap

public long getIndexCap()

Specified by:

getIndexCap in interface InformationServer

indexNode

public void indexNode(org.alfresco.solr.client.Node node,
                      boolean overwrite)
               throws java.io.IOException,
                      org.json.JSONException

Specified by:

indexNode in interface InformationServer

Throws:

java.io.IOException

org.json.JSONException

getCascadeNodes

public java.util.List<org.alfresco.solr.client.NodeMetaData> getCascadeNodes(java.util.List<java.lang.Long> txnIds)
                                                                      throws java.io.IOException,
                                                                             org.json.JSONException

Specified by:

getCascadeNodes in interface InformationServer

Throws:

java.io.IOException

org.json.JSONException

cascadeNodes

public void cascadeNodes(java.util.List<org.alfresco.solr.client.NodeMetaData> nodeMetaDatas,
                         boolean overwrite)
                  throws java.io.IOException,
                         org.json.JSONException

Specified by:

cascadeNodes in interface InformationServer

Throws:

java.io.IOException

org.json.JSONException

updateContent

public void updateContent(AlfrescoSolrDataModel.TenantDbId docRef)
                   throws java.lang.Exception

Specified by:

updateContent in interface InformationServer

Throws:

java.lang.Exception

indexNodes

public void indexNodes(java.util.List<org.alfresco.solr.client.Node> nodes,
                       boolean overwrite)
                throws java.io.IOException,
                       org.json.JSONException

Specified by:

indexNodes in interface InformationServer

Throws:

java.io.IOException

org.json.JSONException

updateTransaction

public void updateTransaction(org.alfresco.solr.client.Transaction txn)
                       throws java.io.IOException

Specified by:

updateTransaction in interface InformationServer

Throws:

java.io.IOException

indexTransaction

public void indexTransaction(org.alfresco.solr.client.Transaction info,
                             boolean overwrite)
                      throws java.io.IOException

Specified by:

indexTransaction in interface InformationServer

Throws:

java.io.IOException

getMaxTransactionIdAndCommitTimeInIndex

public org.alfresco.solr.client.Transaction getMaxTransactionIdAndCommitTimeInIndex()

Specified by:

getMaxTransactionIdAndCommitTimeInIndex in interface InformationServer

isInIndex

public boolean isInIndex(java.lang.String id)

Specified by:

isInIndex in interface InformationServer

getCascades

public java.util.List<org.alfresco.solr.client.Transaction> getCascades(int num)
                                                                 throws java.io.IOException

Specified by:

getCascades in interface InformationServer

Throws:

java.io.IOException

txnInIndex

public boolean txnInIndex(long txnId,
                          boolean populateCache)
                   throws java.io.IOException

Specified by:

txnInIndex in interface InformationServer

Throws:

java.io.IOException

aclChangeSetInIndex

public boolean aclChangeSetInIndex(long changeSetId,
                                   boolean populateCache)
                            throws java.io.IOException

Specified by:

aclChangeSetInIndex in interface InformationServer

Throws:

java.io.IOException

clearProcessedTransactions

public void clearProcessedTransactions()

Specified by:

clearProcessedTransactions in interface InformationServer

clearProcessedAclChangeSets

public void clearProcessedAclChangeSets()

Specified by:

clearProcessedAclChangeSets in interface InformationServer

putModel

public boolean putModel(org.alfresco.repo.dictionary.M2Model model)

Specified by:

putModel in interface InformationServer

rollback

public void rollback()
              throws java.io.IOException

Specified by:

rollback in interface InformationServer

Throws:

java.io.IOException

registerTrackerThread

public void registerTrackerThread()

Specified by:

registerTrackerThread in interface InformationServer

unregisterTrackerThread

public void unregisterTrackerThread()

Specified by:

unregisterTrackerThread in interface InformationServer

reindexNodeByQuery

public void reindexNodeByQuery(java.lang.String query)
                        throws java.io.IOException,
                               org.json.JSONException

Specified by:

reindexNodeByQuery in interface InformationServer

Throws:

java.io.IOException

org.json.JSONException

getBaseUrl

public java.lang.String getBaseUrl()

Specified by:

getBaseUrl in interface InformationServer

getPort

public int getPort()

Specified by:

getPort in interface InformationServer

getHostName

public java.lang.String getHostName()

Specified by:

getHostName in interface InformationServer

setCleanContentTxnFloor

public void setCleanContentTxnFloor(long cleanContentTxnFloor)

Specified by:

setCleanContentTxnFloor in interface InformationServer

setCleanCascadeTxnFloor

public void setCleanCascadeTxnFloor(long cleanCascadeTxnFloor)

Specified by:

setCleanCascadeTxnFloor in interface InformationServer

getProps

public java.util.Properties getProps()

updatePathRelatedFields

protected void updatePathRelatedFields(org.alfresco.solr.client.NodeMetaData nodeMetaData,
                                       org.apache.solr.common.SolrInputDocument doc)

getDocListSize

public int getDocListSize(java.lang.String query)