Nuxeo Enterprise Platform 5.4

org.nuxeo.ecm.core.search.api.client.indexing.resources.document.impl
Class AbstractNXCoreIndexableResource

java.lang.Object
  extended by org.nuxeo.ecm.core.search.api.client.indexing.resources.AbstractIndexableResource
      extended by org.nuxeo.ecm.core.search.api.client.indexing.resources.document.impl.AbstractNXCoreIndexableResource
All Implemented Interfaces:
java.io.Serializable, NXCoreIndexableResource, IndexableResource
Direct Known Subclasses:
DocumentIndexableResourceImpl

public abstract class AbstractNXCoreIndexableResource
extends AbstractIndexableResource
implements NXCoreIndexableResource

Abstract Nuxeo Core indexable resource implementation.

Indexable resource that wish to communicate with Nuxeo Core can extend this class.

Author:
Julien Anguenot
See Also:
Serialized Form

Method Summary
 void closeCoreSession()
          Close the core session only if it was not managed externally, i.e.
 CoreSession getCoreSession()
          Returns a Nuxeo core session.
 java.lang.String getDocRepositoryName()
          Returns the repository identifier where the document is stored.
 
Methods inherited from class org.nuxeo.ecm.core.search.api.client.indexing.resources.AbstractIndexableResource
computeAcp, getConfiguration, getName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.nuxeo.ecm.core.search.api.client.indexing.resources.IndexableResource
computeAcp, computeId, getConfiguration, getName, getValueFor
 

Method Detail

getCoreSession

public CoreSession getCoreSession()
                           throws IndexingException
Description copied from interface: NXCoreIndexableResource
Returns a Nuxeo core session.

This is the implementation job to either authenticate or reuse a new existing session. Check implementation for details.

Specified by:
getCoreSession in interface NXCoreIndexableResource
Returns:
a initialized CoreSession instance.
Throws:
IndexingException

closeCoreSession

public void closeCoreSession()
                      throws IndexingException
Close the core session only if it was not managed externally, i.e. managedSessionId was not explicitly provided to the resource constructor

Specified by:
closeCoreSession in interface NXCoreIndexableResource
Throws:
IndexingException

getDocRepositoryName

public java.lang.String getDocRepositoryName()
Description copied from interface: NXCoreIndexableResource
Returns the repository identifier where the document is stored.

Specified by:
getDocRepositoryName in interface NXCoreIndexableResource
Returns:
the repository identifier

Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.