Package org.nuxeo.ecm.core.api

The core API of the Nuxeo platform, including: CoreSession, DocumentModel, Blob.

Interface Summary

Interface	Description
AsyncService<K extends Serializable,S extends AsyncStatus<K>,V>	Interface to be implemented by asynchronous services.
AsyncStatus<K extends Serializable>	Interface to be implemented by asynchronous services' statuses.
Blob	A blob contains large binary data, and is associated with a MIME type, encoding, and filename.
CloseableCoreSession	Deprecated. since 11.1, use just CoreSession instead
CoreSession	A session to the Nuxeo Core.
CoreSessionService	Service managing the creation of CoreSession instances.
DataModel	Deprecated. since 8.4 for public use, this is an internal implementation class subject to change
DataModelMap	Deprecated. since 8.4, use Map<String, DataModel> instead
DetachedAdapter	Marker interface to define Adapters that won't keep a reference to a DocumentModel instance.
DocumentLocation	Document server name with its unique identifier within this server.
DocumentModel	The document model is a serializable representation of a core document.
DocumentModelIterator	A serializable iterator of document models.
DocumentModelList	A serializable list of document models.
DocumentRef	A reference to a core document.
DocumentRefList	A serializable list of document references.
Filter	A filtering function for data models.
IterableQueryResult	An iterable query result based on a cursor.
LifeCycleConstants	Holds life cycle related constants that are generic enough to be available at a core level.
NuxeoGroup	Holds the list of member users and subgroups for a group.
NuxeoPrincipal	Class to represent a principal in Nuxeo.
ScrollResult<T>	The result of a CoreSession.scroll(java.lang.String, int, int) call, giving access to result and the scroll id.
Sorter	A sorting function for data models.
VersionModel

Class Summary

Class	Description
AbstractSession	Abstract implementation of the client interface.
Blobs	This class consists exclusively of static methods that operate on Blobs.
CloseableFile	A wrapper for a File, which must be closed when done with it in order to release resources.
CoreInstance	The CoreInstance is the main access point to a CoreSession.
CoreSessionServiceImpl	Implementation for the service managing the acquisition/release of CoreSession instances.
CursorResult<C,O>	A cursor result which holds a DB cursor and additional information to scroll this DB cursor.
CursorService<C,O,R>	A low level holder of DB cursors that manages cleaning on timeout.
DocumentModel.DocumentModelRefresh	Info fetched internally during a refresh.
DocumentModelComparator	DocumentModel comparator.
DocumentModelFactory	Bridge between a DocumentModel and a Document for creation / update.
DocumentTreeIterator	An iterator over a tree of documents
IdRef	An ID reference to a document.
InstanceRef	Document repository reference including the principal owner of the session.
ListDiff	A list that is detached from its data source so all modifications on the list are recorded so that the data source will be updated later when the list will be reconnected to it.
ListDiff.Entry
Lock	Information about a lock set on a document.
LockHelper	Utilities to work with locks
PartialList<E>	The bundling of a list and a total size.
PathRef	A PATH reference to a document.
ScrollResultImpl<T>
SortInfo	This class holds the details for sorting.
SystemPrincipal
UnrestrictedSessionRunner	Helper class to run code with an unrestricted session.
VersioningChangeNotifier	Helper class to send versions change event notifications in the core.

Enum Summary

Enum	Description
CoreSession.CopyOption
RecoverableClientException.Severity
VersioningOption	The versioning options that can be requested when saving a document, or when doing a check in.

Exception Summary

Exception	Description
ConcurrentUpdateException	An exception thrown if a concurrent update was detected.
DocumentException	Deprecated. since 7.4
DocumentExistsException	Exception thrown when a method tries to create a document that already exists through copy or move, or when trying to delete the target of a proxy.
DocumentNotFoundException	Exception thrown when a document is not found.
DocumentSecurityException	Exception thrown when access to a document is denied.
LifeCycleException	Exception thrown when an attempt is made to follow an incorrect lifecycle transition or to create a document with an incorrect initial lifecycle state
LockException	Exception thrown when failing to lock or unlock a document.
NuxeoException	The most generic exception thrown by the Nuxeo.
PropertyException	Base exception thrown when there is a problem accessing a property.
RecoverableClientException	Exception that can be handled at UI level to display a dedicated user message
ServerException	The base exception thrown by the CoreSession API.