Interface InformationServer

  • All Superinterfaces:
    org.alfresco.solr.InformationServerCollectionProvider
    All Known Implementing Classes:
    SolrInformationServer

    public interface InformationServer
    extends org.alfresco.solr.InformationServerCollectionProvider
    This is the interface to the information server, whether it be Solr or some other search server.
    Author:
    Ahmed Owian
    • Field Detail

      • PROP_PREFIX_PARENT_TYPE

        static final java.lang.String PROP_PREFIX_PARENT_TYPE
        See Also:
        Constant Field Values
      • PROP_PREFIX_PARENT_ASPECT

        static final java.lang.String PROP_PREFIX_PARENT_ASPECT
        See Also:
        Constant Field Values
    • Method Detail

      • rollback

        void rollback()
               throws java.io.IOException
        Throws:
        java.io.IOException
      • dirtyTransaction

        void dirtyTransaction​(long txnId)
      • commit

        void commit()
             throws java.io.IOException
        Throws:
        java.io.IOException
      • hardCommit

        void hardCommit()
                 throws java.io.IOException
        Throws:
        java.io.IOException
      • commit

        boolean commit​(boolean openSearcher)
                throws java.io.IOException
        Throws:
        java.io.IOException
      • indexAclTransaction

        void indexAclTransaction​(org.alfresco.solr.client.AclChangeSet changeSet,
                                 boolean overwrite)
                          throws java.io.IOException
        Throws:
        java.io.IOException
      • indexTransaction

        void indexTransaction​(org.alfresco.solr.client.Transaction info,
                              boolean overwrite)
                       throws java.io.IOException
        Throws:
        java.io.IOException
      • deleteByTransactionId

        void deleteByTransactionId​(java.lang.Long transactionId)
                            throws java.io.IOException
        Throws:
        java.io.IOException
      • deleteByAclChangeSetId

        void deleteByAclChangeSetId​(java.lang.Long aclChangeSetId)
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • deleteByAclId

        void deleteByAclId​(java.lang.Long aclId)
                    throws java.io.IOException
        Throws:
        java.io.IOException
      • deleteByNodeId

        void deleteByNodeId​(java.lang.Long nodeId)
                     throws java.io.IOException
        Throws:
        java.io.IOException
      • capIndex

        void capIndex​(long nodeId)
               throws java.io.IOException
        Throws:
        java.io.IOException
      • getIndexCap

        long getIndexCap()
                  throws java.io.IOException
        Throws:
        java.io.IOException
      • nodeCount

        long nodeCount()
                throws java.io.IOException
        Throws:
        java.io.IOException
      • maxNodeId

        long maxNodeId()
                throws java.io.IOException
        Throws:
        java.io.IOException
      • minNodeId

        long minNodeId()
                throws java.io.IOException
        Throws:
        java.io.IOException
      • maintainCap

        void maintainCap​(long nodeId)
                  throws java.lang.Exception
        Throws:
        java.lang.Exception
      • indexNode

        void indexNode​(org.alfresco.solr.client.Node node,
                       boolean overwrite)
                throws java.io.IOException,
                       org.alfresco.httpclient.AuthenticationException,
                       org.json.JSONException
        Throws:
        java.io.IOException
        org.alfresco.httpclient.AuthenticationException
        org.json.JSONException
      • indexNodes

        void indexNodes​(java.util.List<org.alfresco.solr.client.Node> nodes,
                        boolean overwrite)
                 throws java.io.IOException,
                        org.alfresco.httpclient.AuthenticationException,
                        org.json.JSONException
        Throws:
        java.io.IOException
        org.alfresco.httpclient.AuthenticationException
        org.json.JSONException
      • cascadeNodes

        void cascadeNodes​(java.util.List<org.alfresco.solr.client.NodeMetaData> nodes,
                          boolean overwrite)
                   throws java.io.IOException,
                          org.alfresco.httpclient.AuthenticationException,
                          org.json.JSONException
        Throws:
        java.io.IOException
        org.alfresco.httpclient.AuthenticationException
        org.json.JSONException
      • getCascadeNodes

        java.util.List<org.alfresco.solr.client.NodeMetaData> getCascadeNodes​(java.util.List<java.lang.Long> txnIds)
                                                                       throws org.alfresco.httpclient.AuthenticationException,
                                                                              java.io.IOException,
                                                                              org.json.JSONException
        Throws:
        org.alfresco.httpclient.AuthenticationException
        java.io.IOException
        org.json.JSONException
      • indexAcl

        long indexAcl​(java.util.List<org.alfresco.solr.client.AclReaders> aclReaderList,
                      boolean overwrite)
               throws java.io.IOException
        Throws:
        java.io.IOException
      • getTrackerInitialState

        org.alfresco.solr.TrackerState getTrackerInitialState()
      • continueState

        void continueState​(org.alfresco.solr.TrackerState state)
      • getTxDocsSize

        int getTxDocsSize​(java.lang.String targetTxId,
                          java.lang.String targetTxCommitTime)
                   throws java.io.IOException
        Throws:
        java.io.IOException
      • getRegisteredSearcherCount

        int getRegisteredSearcherCount()
      • txnInIndex

        boolean txnInIndex​(long txnId,
                           boolean populateCache)
                    throws java.io.IOException
        Throws:
        java.io.IOException
      • aclChangeSetInIndex

        boolean aclChangeSetInIndex​(long changeSetId,
                                    boolean populateCache)
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • getCascades

        java.util.List<org.alfresco.solr.client.Transaction> getCascades​(int num)
                                                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • updateTransaction

        void updateTransaction​(org.alfresco.solr.client.Transaction txn)
                        throws java.io.IOException
        Throws:
        java.io.IOException
      • clearProcessedTransactions

        void clearProcessedTransactions()
      • clearProcessedAclChangeSets

        void clearProcessedAclChangeSets()
      • isInIndex

        boolean isInIndex​(java.lang.String id)
                   throws java.io.IOException
        Throws:
        java.io.IOException
      • setCleanContentTxnFloor

        void setCleanContentTxnFloor​(long cleanContentTxnFloor)
      • setCleanCascadeTxnFloor

        void setCleanCascadeTxnFloor​(long cleanCascadeTxnFloor)
      • getErrorDocIds

        java.util.Set<java.lang.Long> getErrorDocIds()
                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • getCoreStats

        java.lang.Iterable<java.util.Map.Entry<java.lang.String,​java.lang.Object>> getCoreStats()
                                                                                               throws java.io.IOException
        Throws:
        java.io.IOException
      • getTrackerStats

        org.alfresco.solr.tracker.TrackerStats getTrackerStats()
      • getModelErrors

        java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> getModelErrors()
      • getDictionaryService

        org.alfresco.repo.dictionary.DictionaryComponent getDictionaryService​(java.lang.String alternativeDictionary)
      • getNamespaceDAO

        org.alfresco.repo.dictionary.NamespaceDAO getNamespaceDAO()
      • getAlfrescoModels

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

        void afterInitModels()
      • putModel

        boolean putModel​(org.alfresco.repo.dictionary.M2Model model)
      • getM2Model

        org.alfresco.repo.dictionary.M2Model getM2Model​(org.alfresco.service.namespace.QName modelQName)
      • getHoleRetention

        long getHoleRetention()
      • checkAclInIndex

        org.alfresco.solr.AclReport checkAclInIndex​(java.lang.Long aclid,
                                                    org.alfresco.solr.AclReport aclReport)
      • reportIndexTransactions

        org.alfresco.solr.tracker.IndexHealthReport reportIndexTransactions​(java.lang.Long minTxId,
                                                                            org.alfresco.solr.adapters.IOpenBitSet txIdsInDb,
                                                                            long maxTxId)
                                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • getDocsWithUncleanContent

        java.util.List<AlfrescoSolrDataModel.TenantDbId> getDocsWithUncleanContent()
                                                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • addCommonNodeReportInfo

        void addCommonNodeReportInfo​(org.alfresco.solr.NodeReport nodeReport)
      • addContentOutdatedAndUpdatedCounts

        void addContentOutdatedAndUpdatedCounts​(org.apache.solr.common.util.NamedList<java.lang.Object> ihr)
        Adds to the input report container (a NamedList) the counts of nodes/documents whose content is outdated and updated (i.e. in synch with the CMS).
      • reportAclTransactionsInIndex

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

        int getAclTxDocsSize​(java.lang.String aclTxId,
                             java.lang.String aclTxCommitTime)
                      throws java.io.IOException
        Throws:
        java.io.IOException
      • getMaxAclChangeSetIdAndCommitTimeInIndex

        org.alfresco.solr.client.AclChangeSet getMaxAclChangeSetIdAndCommitTimeInIndex()
      • getMaxTransactionIdAndCommitTimeInIndex

        org.alfresco.solr.client.Transaction getMaxTransactionIdAndCommitTimeInIndex()
      • initSkippingDescendantDocs

        void initSkippingDescendantDocs()
      • registerTrackerThread

        void registerTrackerThread()
      • unregisterTrackerThread

        void unregisterTrackerThread()
      • reindexNodeByQuery

        void reindexNodeByQuery​(java.lang.String query)
                         throws java.io.IOException,
                                org.alfresco.httpclient.AuthenticationException,
                                org.json.JSONException
        Throws:
        java.io.IOException
        org.alfresco.httpclient.AuthenticationException
        org.json.JSONException
      • getPort

        int getPort()
      • getHostName

        java.lang.String getHostName()
      • getBaseUrl

        java.lang.String getBaseUrl()
      • cascadeTrackingEnabled

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