Platform Explorer / CMF 1.8

Component org.nuxeo.ecm.core.search.service.SearchServiceImpl

Documentation

Core service that deals with searching.

@version 1.0

Implementation

Class: org.nuxeo.ecm.core.search.service.SearchServiceImpl

Services

Extension Points

XML Source

<?xml version="1.0"?>

<component name="org.nuxeo.ecm.core.search.service.SearchServiceImpl"
  version="1.0">

  <service>
    <provide interface="org.nuxeo.ecm.core.search.api.client.SearchService" />
  </service>

  <documentation>
    Core service that deals with searching.

    @version 1.0
    @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
  </documentation>

  <implementation class="org.nuxeo.ecm.core.search.service.SearchServiceImpl" />

  <extension-point name="searchEngineBackend">

    <documentation>
      Extension point allowing the contributions of search engine plugin
      implementation.
    </documentation>

    <object
      class="org.nuxeo.ecm.core.search.backend.SearchEngineBackendDescriptor" />

  </extension-point>

  <extension-point name="resource">

    <documentation>
      Extension point allowing the contributions of indexing configuration per
      schema.
    </documentation>

    <object
      class="org.nuxeo.ecm.core.search.api.indexing.resources.configuration.IndexableResourceDescriptor" />

  </extension-point>

  <extension-point name="indexableDocType">

    <documentation>
      Extension point allowing the contributions of mappings from docType to
      indexable resources names.
    </documentation>

    <object
      class="org.nuxeo.ecm.core.search.api.indexing.resources.configuration.document.IndexableDocTypeDescriptor" />

  </extension-point>

  <extension-point name="fullTextField">

    <documentation>
      Extension point allowing the contributions full text index definition.
    </documentation>

    <object
      class="org.nuxeo.ecm.core.search.api.indexing.resources.configuration.document.FulltextFieldDescriptor" />

  </extension-point>

  <extension-point name="indexingEvent">

    <documentation>
      Extension point allowing the contributions of indexing event definitions.
    </documentation>

    <object
      class="org.nuxeo.ecm.core.search.api.events.IndexingEventDescriptor" />

  </extension-point>

  <extension-point name="blobExtractor">

    <documentation>
      Extension point allowing the contributions of full text blob extractors.
    </documentation>

    <object
      class="org.nuxeo.ecm.core.search.api.indexing.resources.configuration.blobs.BlobExtractorDescriptor" />

  </extension-point>

  <extension-point name="resourceType">

    <documentation>
      Extension point allowing the contributions of indexing resource type.
    </documentation>

    <object
      class="org.nuxeo.ecm.core.search.api.indexing.resources.configuration.ResourceTypeDescriptor" />

  </extension-point>

  <extension-point name="indexingThreadPool">
    <documentation>
      Extension point allowing the contributions of parameters for the indexing
      thread pool.
    </documentation>

    <object
      class="org.nuxeo.ecm.core.search.api.internals.IndexingThreadPoolDescriptor" />
  </extension-point>

  <extension-point name="policies">

    <documentation>
      Extension point to register custom search policies or override existing
      policies.
      <p />

      Policies are applied checked in the order they are defined. They can add
      constraints to queries performed on the search service.

      <p />

      Example to define a custom policy :
      <code>
        <policy name="access"
          class="org.nuxeo.ecm.core.search.security.AccessLevelSearchPolicy"
          order="10" />
      </code>

      The class used has to implement the
      org.nuxeo.ecm.core.search.api.security.SearchPolicy interface.

      <p />

      It is later possible to override that definition in another contribution
      to that extension-point to disable or override a policy:
      <code>
        <policy name="access" enabled="false" />

        <policy name="access"
          class="org.nuxeo.ecm.core.search.security.AccessLevelSearchPolicy"
          order="20" />
      </code>

      <p />

      @author <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>

    </documentation>

    <object class="org.nuxeo.ecm.core.search.api.internals.SearchPolicyDescriptor" />
  </extension-point>

</component>