org.nuxeo.ecm.core.search.api.client.indexing.resources.document
Interface NXCoreIndexableResource

All Superinterfaces:

IndexableResource, java.io.Serializable

All Known Subinterfaces:

DocumentBuiltinsIndexableResource, DocumentIndexableResource

All Known Implementing Classes:

AbstractNXCoreIndexableResource, DocumentBuiltinsIndexableResourceImpl, DocumentIndexableResourceImpl

public interface NXCoreIndexableResource
extends IndexableResource

Nuxeo core indexable resource interface.

Extends base indexable resource interface to add Nuxeo Core speficic API that might ease the definition of new indexable resources that needs to interract with a Nuxeo Core instance.

Author:

Julien Anguenot

Method Summary

void	closeCoreSession() Explicitly closes the inner core session.
CoreSession	getCoreSession() Returns a Nuxeo core session.
java.lang.String	getDocRepositoryName() Returns the repository identifier where the document is stored.

Methods inherited from interface org.nuxeo.ecm.core.search.api.client.indexing.resources.IndexableResource

computeAcp, computeId, getConfiguration, getName, getValueFor

Method Detail

getCoreSession

CoreSession getCoreSession()
                           throws IndexingException

Returns a Nuxeo core session.

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

Returns:

a initialized CoreSession instance.

Throws:

IndexingException

closeCoreSession

void closeCoreSession()
                      throws IndexingException

Explicitly closes the inner core session.

It is the caller's responsibility to close the connection for optimization sake.

Throws:

IndexingException

getDocRepositoryName

java.lang.String getDocRepositoryName()

Returns the repository identifier where the document is stored.

Returns:

the repository identifier