All Classes and Interfaces
Class
Description
An absolute reference to a
DocumentModel, composed of:Base class for
GroupComputer implementation that uses User attribute to compute groups.Abstract class to share code between
AuditBackend implementationsBulk Action that runs an automation operation
An abstract
Computation that processes records by batch.Abstract batch handler: common code.
Deprecated.
Deprecated.
since 2023.9, prefer
BlobStoreBlobProvider implementation insteadAbstract implementation of a
Blob storing the information other than the byte stream.Basic implementation for a garbage collector recording marked or to-delete blobs in memory.
Base class for
BlobHolder implementersAbstract implementation for
BlobProvider providing common logic.Abstract class to scroll blobs from a blob provider, the scroll query is the provider id.
Basic helper implementations for a
BlobStore.Basic configuration for a blob store.
Base class for bulk action computation.
Abstract class to be extended to provide new cache implementation
Execute a pool of callables.
Deprecated.
since 2023.9, use
BlobStoreBlobProvider insteadAll commands have 2 attributes: fail and ignore which are EL expressions.
An abstract
Computation that manages the metadata init.
This constraint ensures some date representation is in an enumeration.
The parent provider is read only.
Helper class to contribute CreationContainerListProvider implementation to the FileManagerService.
Base class for CSV
Writer.Consumer to load data from CSV according to the dataLoadingPolicy.
Abstract class handling storage of properties.
Base class for operations on directories.
DocumentModel backed implementation of a FileSystemItem.Base class for classes implementing
ImporterDocumentModelFactory.Abstract implementation for codecs.
Base class to be used to create new context events.
Abstract class for external blob adapters.
File importer abstract class.
Base class for
FileSystemItem implementations.Base class for
FileSystemItemFactory implementers.Extends this class to implement a flavor-based processor.
Abstract implementation of
ESHintQueryBuilder that manages the geo queries.Base class for
GroupComputer implementation.Abstract Page provider listing groups.
Abstract base class for PreviewAdapters
base class for importers
Abstract class for sharing code between ElasticSearch related workers
Abstract implementation for
IOResourceAdapter.Base class to write
ExtensibleEntityJsonWriter's enricher.Base class for Json
Reader.Base class for Json
Writer.Key/Value Store common methods.
Abstract implementation to ease up upgrade if interface changes.
Default implementation of an asynchronous
RenditionProviderConsumes
EventBundle EventBundles by running asynchronous EventListenerBasic implementation of
BlobProvider for live connect.Basic implementation of
LiveConnectFile.Basic implementation of
OAuth2ServiceProvider for live connect.Base class for
LocalConfiguration implementers.Abstract class that helps building an Asynchronous listeners that will handle a long running process.
Base class used for mappers
Abstract class for nodes.
OAuth2ServiceProvider that relies on the user's email as key.Basic implementation of
ObjectResolver which provides AbstractObjectResolver.parameters and AbstractObjectResolver.validation support.Abstract Class that exposes some useful method to manage list of values
Basic implementation for a
PageProvider.Provides partial default implementation for a
PipeConsumerEncapsulates message sending and receiving through the
PubSubService.Encapsulates invalidations management through the
PubSubService.Abstract implementation of
PubSubProvider.Abstract class implementing
QuotaStatsUpdater to handle common cases.Implementation of common Reference logic.
Base implementation of the
Rendition interface that mainly wrapps the RenditionDefinitionBase class for all resources (existing or not).
Abstract implementation of the Runtime Service.
Rewrite an Elsaticsearch search request to add security filter.
Abstract security policy
Abstract implementation of the client interface.
Base
FileSystemItemFactory for a synchronization root FolderItem.Base class for shared code bewteen the
TemplateBasedDocument and the TemplateSourceDocument.Common code between the implementations of
TemplateProcessorBase class for a
TransientStore implementation.Basic implementation of
TrashService.Path-based comparator used to put folders before their children.
Abstract (common) implementation for a Type.
The abstract class adds some useful methods.
Abstract WebObject class that handle retrieve, deletion and update of
NuxeoPrincipal or NuxeoGroup.Provide default implementation for interaction with the
UserManager.Abstract class holding most of the logic for using
UnrestrictedSessionRunner while creating UserWorkspaces
and associated resourcesBase implementation of a virtual
FolderItem.Base
FileSystemItemFactory for a virtual FolderItem.Abstract implementation to ease up upgrade if interface changes.
A base implementation for a
Work instance, dealing with most of the details around state change.Access control entry, assigning a permission to a user.
ACE Descriptor.
Listener listening for
ACEStatusUpdated event to send a notification for ACEs becoming effective.An ACL (Access Control List) is a list of ACEs (Access Control Entry).
Collection IO for arrays of ACLs.
An ACL implementation.
Enrich
DocumentModel Json.A simple value holding one row of the ACLs table.
Comparator of
ACLRows according to their pos field.Intercepts ACL changes and restrict Grant to Tenant bound groups for a configured list of global groups
Access control policy (ACP) control the permissions access on a resource.
The ACP implementation uses a cache used when calling getAccess().
Convert
ACP to Json.Descriptor for action.
Interface for action context evaluation
Action property descriptor
Action property list descriptor
This bundle activator ensures that the init sequence happens in the right order.
Needed to lookup local bundle resources - which should use Bundle API.
XMap descriptor for the
activeFileSystemItemFactories contributions to the
activeFileSystemItemFactories extension point of the FileSystemItemAdapterService.XMap descriptor for the
factory elements of the activeFileSystemItemFactories contributions.Registry for the
activeFileSystemItemFactories contributions.Simple probes that returns the number of active session
XMap descriptor for the
activeTopLevelFolderItemFactory contributions to the
activeFileSystemItemFactories extension point of the FileSystemItemAdapterService.Registry for the
activeTopLevelFolderItemFactory contributions.An interface for an adaptable object.
Descriptor for contributed Preview Adapter factories.
See operation documentation
Operation that adds a facet to the document.
Simple object used to store the additional parameters that are used to fetch the history for a DocumentModel
Operation that adds a permission to a given ACL for a given user.
Class for the operation to add a list of documents in a Collection.
Class for the operation to add a list of documents in the Favorites.
Watermark a Video with the given Picture, at the given position (from top-left).
Representation of the Administrative Status of a service or server
Listen for
AdministrativeStatus changes and set the necessary flag in AdminStatusHelper so that web
infrastructure can directly use the Helper.Service interface used to manage AdministrativeStatus of Nuxeo's services on a given Nuxeo Instance (node)
Implementation class for the
AdministrativeStatusManager service.Retrieves the administrative status of the server.
Provider for configured administrators groups
Simple Helper class to hold
AdministrativeStatus flags used by the Web Layer.Replace default XML Parser used into the Scan Importer service by the advanced one implemented into
nuxeo-importer-xml-parser
Deprecated.
since 2023.9, use
AESBlobProvider insteadA
CipherOutputStream that also does a digest of the original stream at
the same time.A blob provider that encrypts binaries on the filesystem using AES.
A blob store that encrypts binaries on the filesystem using AES.
Input stream that decrypts while reading.
Output stream that encrypts while writing.
Configuration for the AES-encrypted storage of files.
Alias type specifies what type of object (certificate, private key, etc) is being persisted in the keystore.
Represents a keystore alias.
Annotation interface
Annotation API to perform CRUD operations on annotations.
Anonymous authenticator that redirect logout to CAS server authentication to connect to nuxeo.
Base converter choosing the correct convert to generate a thumbnail according to the Blob's mime type.
Type representing any type (for lists).
The root entry for the WebEngine module.
This servlet is bound to /api and dispatch calls to /site/api in oder to have better looking URLs.
Append content of a file into a destination file.
Appends records from a dump file into an a Log partition.
Registers the application (root resource classes and providers) in a standard / container-neutral way.
A wrapper for a JAX-RS application fragment declared in manifest.
A composite JAX-RS application that can receive fragments from outside.
A hot re-loadable JAX-RS servlet.
Make it possible to directly JSON tree nodes parsed by the REST API (e.g. parameters or input) directly to java
datastructures.
Array utils.
Extension to
AssertA map used to track duplicates.
The base of all query nodes.
Deprecated.
since 10.3, use the @async operation adapter instead.
Schedules the async digest work.
Executor of async listeners passing them to the WorkManager.
Adapter that allows asynchronous execution of operations.
Interface to be implemented by asynchronous services.
Interface to be implemented by asynchronous services' statuses.
Descriptor that can be used to define how Nuxeo DocumentModel properties are filled from the input XML
This class will create a Document of type "Audio" from the uploaded file, if the uploaded file matches any of the
mime types listed in the filemanager-plugins.xml file.
Adapter that returns the log entries of the pointed resource.
Interface for Administration of Audit service.
Audit Backend SPI
Descriptor to configure / contribute a Backend for Audit service
Deprecated.
since 10.10, audit bulker is now handled with nuxeo-stream, no replacement
Deprecated.
since 10.10, audit bulker is now handled with nuxeo-stream, no replacement
Deprecated.
since 10.10, audit bulker is now handled with nuxeo-stream, no replacement
Implementation of
FileSystemChangeFinder using the AuditReader.The audit domain event.
Audit domain event producer.
Fire events for Route audit logs (used by previous route content view)
Deprecated.
since 10.10, audit event is now handled with
StreamAuditEventListenerNXAudit event types.
Enricher that add the latest log entries related to the document.
Interface for adding audit logs.
PageProvider implementation that returns LogEntry from Audit ServiceOperation to execute a query or a named provider against Audit with support for Pagination
Query builder for querying audit.
NXAudit-Query related exception.
Interface for reading data from the Audit service.
Define a elasticsearch passthrough filter for audit index.
Audit Service - manage document versions TODO not yet implemented
Audit storage interface to append and scroll
LogEntry represented as JSON.Token Object
Convert
AuthenticationToken to Json.Authenticate the given username against the given password.
Tag for indicating authorized proxies for the cas:auth tag.
Authentication tag for use with the Yale Central Authentication Service.
Object representing a registered automatic level of detail conversion on the
ThreeDService.ContributionFragmentRegistry to register AutomaticLOD.Object representing an automatic render view on the
ThreeDService.ContributionFragmentRegistry to register AutomaticRenderView.Object representing a registered automatic video conversion on the
VideoService.ContributionFragmentRegistry to register AutomaticVideoConversion.Bulk Action that runs an automation operation
Bulk Action that runs an automation operation dedicated for UI
Nuxeo component that provide an implementation of the
AutomationService and handle extensions registrations.Class injected/published in Nashorn engine to execute automation service.
Class introduced to share code between sync and lazy automation based renditions
A registry of REST bindings.
Service providing an operation registry and operation execution methods.
Avro Binary format, there is no header, the schema must be the same for encoder and decoder.
Factory to generate Avro codec with different flavors
Avro component.
Use the Confluent Avro encoding which differs from Avro message, the schema store is a REST Confluent Schema
Registry.
Constants used in this package.
JSON Avro format for debugging purpose.
The base class for any AvroMapper.
The Avro mapper descriptor.
Avro Single object encoding: magic 2 bytes + schema fingerprint 8 bytes + avro binary.
Instead of having an Avro Record envelop that contains a data encoded in Avro, this structure is a flat Avro message
joining schemas of the Record and data.
Factory to generate Record compliant with Confluent Avro, ready to be used by ksqlDB.
The Avro forbidden character replacement descriptor.
Avro allows alphanumeric characters and underscores in names.
Nuxeo Studio allows alphanumeric characters, underscores and dashes that have to be replaced by another symbol.
The default contributions provide replacement for :
- "-" as "__dash__"
- ":" as "__colon__
- ";" as "__semicolon__"
- and with higher priority "__" as "____" to ensure no user string is wrongly replaced.
Avro allows alphanumeric characters and underscores in names.
Nuxeo Studio allows alphanumeric characters, underscores and dashes that have to be replaced by another symbol.
The default contributions provide replacement for :
- "-" as "__dash__"
- ":" as "__colon__
- ";" as "__semicolon__"
- and with higher priority "__" as "____" to ensure no user string is wrongly replaced.
The Avro schema descriptor.
The base class for any AvroSchemaFactory.
An AvroSchemaFactoryContext represents a context in which Avro schemas are cached and reused depending on their
qualified name.
Avro does not permit to declare twice a schema with the same qualified name.
Avro does not permit to declare twice a schema with the same qualified name.
The Avro schema factory descriptor.
An extended SchemaStore that know how to add schema.
This service allows to create a
AvroSchemaFactoryContext.The service providing AWS configuration.
Implementation of the service providing AWS configuration.
Deprecated.
since 2023.9, use
AzureBlobProvider insteadBlob provider that stores files in Azure Storage.
Scroll blobs of the Azure blob store of a
AzureBlobProvider, the scroll query is the provider id.Blob storage configuration in Azure Storage.
Deprecated.
since 2023.9, use
AzureBlobProvider configured with direct download and a CDN host insteadDeprecated.
since 2023.9
Deprecated.
since 2023.9, use
AzureBlobProvider insteadA backing checker checks for the availability of a backing service.
Base converter for blender pipeline.
Basic directory descriptor, containing the basic fields used by all directories.
How directory semi-"fulltext" searches are matched with a query string.
Base implementation for a Document.
Abstract class for sharing the worker state
Minimal interface extracted to be able to share some code inside the
AbstractAuditBackendBase class that contains SAX based text extractor fallback
Base for filter that saves long record's value in an alternate storage.
Base class for page provider descriptors.
Enrich
DocumentModel Json.A
Property gives access to a scalar or array value stored in an underlying table.Common code for VCS and DBS
Session implementations.Base session class with helper methods common to all kinds of directory sessions.
Visitor for a query to check if it contains a reference to a given field.
INTERNAL.
Deprecated, for removal: This API element is subject to removal in a future version.
since 2023.13, use
HttpClientTestRule insteadBase class used for all WebObject associated to SCIM Domain model
Base class for converters doing video conversions.
Simple logger that wraps a bufferized string logger (for remote retrieval) and a log4J logger
Batch Object to encapsulate all data related to a batch, especially the temporary files used for Blobs.
Batch conversion for 3D document types Generate thumbnail render, Collada version and LOD versions
Helper class to take out renders and list of
TransmissionThreeD form batch conversionRepresents a batch file backed by the
TransientStore.Structure that holds metadata about an uploaded file through a batch.
Abstract Work to find the ids of documents for which some process must be executed in batch, based on a NXQL query.
Batch Handler encapsulates functionality to handle Batch Upload behaviours.
BatchHandler Descriptor
Service interface to collect inputs (Blobs) for an operation or operation chain.
Runtime Component implementing the
BatchManager service with the TransientStore.Describe when a batch must be flushed.
Abstract Work to process a list of documents.
Keep state of a batch according to a batch policy.
Interface to batch update documents provided by implementing provider.
Batch upload endpoint.
Batching utilities.
Interface for
TemplateProcessor that allow reverse mapping. i.e. update the DocumentModel from data
inside the template file.Deprecated.
since 2023, this FullGC implementation does not scale on large repositories, use
BlobsObject
insteadDeprecated.
since 2023.9
Deprecated.
since 2023.9, see
ManagedBlob insteadDeprecated.
since 2023.9, prefer
BlobStoreBlobProvider implementation insteadA Garbage Collector for a
BinaryManager.Deprecated.
since 2023.9, use
BlobProvider insteadDescriptor for the configuration of an on-disk binaries storage.
Status of a BinaryManager, including files that may have just been deleted by GC
since 11.3
Binary metadata component which registers all binary metadata contributions.
Class to extends to contribute processor runner.
Read/Write binary metadata services.
Handle document and blob updates according to following rules in an event context:
Define if rule should be executed in async or sync mode.
Deprecated.
since 2021.13, use
BinaryMetadataUpdateWork insteadDeprecated.
since 2021.13,
BinaryMetadataSyncListener now handles the async updatesThe binary type handles values of type InputStream.
Blank node.
Blank node.
A blob contains large binary data, and is associated with a MIME type, encoding, and filename.
REST API Blob Manager
Context of blob (what document it's part of, its xpath, etc.).
Deprecated.
since 2023.4 Use
BlobDataSource insteadWraps a
Blob into a DataSource.Called periodically by a scheduler to delete the blobs marked for deletion, if enough time has elapsed.
Interface for a dispatcher of blobs to different blob providers according to metadata.
Descriptor for a
BlobDispatcher and its configuration.Interface for an object that holds a
Blob.Runtime component to manage the pluggable factory for
DocumentAdapterFactory.DocumentModel adapter factory.Service interface for creating the right
BlobHolder adapter depending on the DocumentModel type.Interface for the contributed factory classes.
XMap descriptor for contributed factories.
Preview adapter factory for all documents that have a blob holder adapter.
Class helper used to expose Document as a
BlobHolder in FreeMarker contextXDocReport wrapper for a Picture stored in a Nuxeo Blob
Class describing information from a
Blob, suitable for serialization and storage.Context of blob being read (what document it's part of, its xpath, etc.).
Fetch blob information of an imported blob for a document.
A message holding BlobInfo.
Save blob information for a document.
Resolves a blob passed by key as input of an operation.
Migrator to populate the
ecm:blobKeys field in DBS repositories.Deprecated.
since 10.3, not used anymore since bulk download operation is synchronous.
Service managing the storage and retrieval of
Blobs, through internally-registered BlobProviders.Hints for returning
URIs appropriate for the expected usage.Implementation of the service managing the storage and retrieval of
Blobs, through internally-registered
BlobProviders.A message holding info to build a StringBlob.
Import BlobMessage into a Nuxeo BlobProvider, persist BlobInformation.
Indicates a blob is missing.
Enriches
Blob json with embed preview link when available.Blob property, reading and writing from a
Blob object.Interface for a provider of
Blobs, which knows how to read and write them.Descriptor for a
BlobProvider.This class consists exclusively of static methods that operate on
Blobs.Extractor for all the blobs of a document.
Resolves a list of blobs passed by key as input of an operation.
Endpoint to manage the blobs.
Status associated to a blob in storage.
Interface for basic access to storage of a Blob (read/write/copy/delete).
A class representing an unknown value, a missing value, or a present (non-null) value.
A
BlobProvider implemented on top of an underlying BlobStore.A
FileInputStream that deletes its underlying file when it is closed.Save the input document
Context available when a blob is updated in a blob provider.
Blob utility methods.
Consume blobMessages and generate new blob by adding a unique watermark.
Wraps an existing
Blob to allow setting a different filename.Context available when a blob is written.
Operation blocking permission inheritance on a given ACL.
Basic CRUD with a BusinessAdapter
Boolean literal.
The Boolean type.
Provider for blobs getting information from Box.
Enrich
DocumentModel Json.Trash service delegating to two different backends, for use during migration.
œ Worker to index a bucket of documents
Immutable bucket for range.
Immutable bucket for date range.
Immutable Bucket for terms.
Buffers the response until
BufferingHttpServletResponse.stopBuffering() is called.A
ServletOutputStream that buffers everything until BufferingServletOutputStream.stopBuffering() is called.Log entry builtin constants.
List of built-in modes.
List of built in widget modes.
Bulk endpoint to expose
BulkService.Bulk endpoint to perform bulk actions on a set of documents.
Interface for action validation.
The Bulk admin service, it's an internal service in order to access configuration from Bulk Action Framework.
A message to pass a command id and a bucket of document ids
Helper class for codecs.
A message representing a bulk command
The bulk component.
Bulk constants for serialization.
Deprecated.
since 10.3, use
BAF insteadBulk Download Operation.
A computation that submits elasticsearch requests using the bulk API.
Listener for life cycle change events.
Bulk operation to cancel and restart all the workflow instances of the workflow model with the id
workflowId.Automation operation that can run an http enabled Bulk Action.
Materializes the document set for a command if scroller is not external.
API to manage Bulk Computation.
Basic implementation of
BulkService.A message representing a command status or a change of status (delta).
Possible states of a bulk command:
Saves the status into a key value store.
Wait for Bulk computation.
A HttpContext that delegates resource lookup to contributed
ResourcesDescriptor in the inverse order of the
contribution (preserving the ordering imposed by extension mechanism)Nuxeo document model abstract adapter to extend for mapping
JAX-RS Message body reeader to decode BusinessAdapter
This operation map pojo client side to document adapter server side and create NX document assuming that pojo and
adapter have both properties in common.
This operation map pojo client side to document adapter server side and fetch the related NX document.
This operation map pojo client side to document adapter server side and update the related NX document.
Blob based on a byte array.
A byte range.
Extended interface for
BlobHolder that can be cached.The nuxeo cache interface that define generic methods to use cache technologies
Class to implement mandatory check attributes before calling implementation of cache This enable to have the same
behavior for any use of cache for all implementation of cache
Descriptor of cache contrib
Wrapper managing cache invalidations.
Simple helper to handle cache key generation.
Management-related APIs for a
Cache.Nuxeo cache interface
Cache service implementation to manage nuxeo cache
Deprecated.
since 2023.9, use
CachingBlobStore insteadBlob store wrapper that caches blobs locally because fetching them may be expensive.
Configuration for a cache.
A
Mapper that cache rows.Simple class to store the result of a JAAS callback
Deprecated.
since 11.4: superseded by dropwizard metrics
Cancels the workflow with the given id, where the id is the id of the document representing the workflow instance.
Simple POJO holding the capabilities registered during Nuxeo startup.
Service holding the server capabilities.
A dummy QueryMaker usable to capture the low level sqlInfo, model and session from a high-level session, in order to
further test QueryMakers.
Protects web-accessible resources with CAS.
Wraps the
HttpServletRequest object, replacing getRemoteUser() with a version that returns
the current CAS logged-in user.Output records to stdout.
An exception indicating certificate or key generation related problems
This service provides certificate generation and certificate related keystore operations.
Base implementation of the certification service.
Specific
Converter implementation that acts as a converters chain.XMap descriptor for contributions to the
changeFinder extension point of the NuxeoDriveManager.Registry for the
changeFinder contributions.Changes the permission on a document to only allow validators.
This service filters disallowed characters in strings and document properties.
Descriptor for the character filtering service
Thumbnail listener handling document blob update, checking for changes, for documents holding default the schema
named "file".
Listener that updates
comment:parentId and comment:ancestorIds on version's comments after the
check-in event.Allows to update the default populated CheckFileInfo properties with custom logic.
Check in the input document.
Security policy that denies write access on a live document when it is in the checked-in state.
This class checks whether a mail is a duplicate of a previously stored mail document.
Check out the input document.
Action that check the mail address against the user directory.
Adapter that returns the children of the pointed resource
Worker to index children recursively
Enrich
DocumentModel Json.Descriptor for classes that may be allowed or denied for use by the scripting engine.
Deprecated.
since 11.1, use
LoginComponent insteadDeprecated, for removal: This API element is subject to removal in a future version.
since 2023.13, use
HttpClientTestRule insteadDeprecated.
since 11.1, use just
CoreSession insteadA wrapper for a
File, which must be closed when done with it in order to release resources.Abstract blob store configuration for cloud providers.
Deprecated.
since 2023.9, use
S3BlobProvider configured with direct download and
CloudFrontConfiguration insteadCloudFront configuration.
Deprecated.
since 2023.0, use
ClusterActionService insteadAn action that needs to be propagated to all nodes in the cluster.
Deprecated.
since 2023.0, use
ClusterActionService insteadEncapsulates cluster node invalidations management.
Descriptor of a cluster node.
Cluster Service, defining cluster node state and identity.
Implementation for the Cluster Service.
Wraps command parameters (String or File path, or a list of values that will be expanded as separate parameters).
A parameter value holding either a single String or a list of Strings.
Transformer of CMISQL queries into real SQL queries for the actual database.
Map maker that can deal with aliased column names and computed values.
Column corresponding to a returned value computed from an actual SQL expression.
Transformer of CMISQL queries into NXQL queries.
IterableQueryResult wrapping the one from the NXQL query to turn values into CMIS ones.
Automatic versioning filter to filter out document from CMIS (automatic versioning is currently not supported by
CMIS).
List of required X500 Principal fields required for certificate generation
Convert an object to/from byte array.
Factory to init and provide codec object.
Gives access to coder/decoder for a class .
Conversion from Collada to glTF format
Conversion from any supported 3D type to Collada
A type of fragment corresponding to several rows with the same id.
Interface for a class that knows how to get a collection's value from a result set, and set a collection's values to
a prepared statement (and execute it).
A
CollectionProperty gives access to a collection value stored in an underlying Fragment.Enricher that add the collections the document belongs to.
Default implementation of a collection synchronization root
FolderItem.FileSystemItemFactory for a collection synchronization root FolderItem.An SQL
column.Abstract representation of the database-level column types.
The database-level column types, including per-type parameters like length.
Wraps a string that needs to be mapped to an id column in prepared statements.
Represents the availability status of a command.
Exception indicating that the target command execution failed:
because it threw an exception,
because it exited with a non zero return code.
Base class to implement
Converter based on CommandLineExecutorService.Generic converter executing a contributed command line.
XMap descriptor for a CommandLine.
POJO implementation of the
CommandLineExecutorService interface.Interface for the service that manages commandline execution.
Exception indicating that the target command is not available:
because it was never registered,
because it was disabled,
because the target command is not installed on the server *.
A command based task.
Interface for class that provides a way to test if a command is installed on the target server OS.
XMap descriptor for a new contributed
CommandTester.Wraps result for a CommandTest execution.
Comment interface.
Deprecated, for removal: This API element is subject to removal in a future version.
since 11.1.
Service to deal with
Comment.Features of the implementation of the service.
Deprecated.
since 10.3, use
PropertyCommentManager instead.Sets the top level document being commented as the source document of the event as some implementations fail on
retrieving it and this avoids useless recursive calls.
Veto that prevents sending notifications whose type is
CommentNotificationVeto.EXCLUDED_EVENT_TYPES on the document comment model.Helper to manage
LogEntry comment processing (code was moved from the Seam bean)Deprecated.
since 11.1, use
Comment.getDocument() or DocumentModel.getAdapter(Class) insteadUtility class used for registering constants.
Deprecated.
since 10.3, use
org.nuxeo.ecm.restapi.server.jaxrs.comment.CommentAdapter instead.Migrator of comments.
The implementation of
ESHintQueryBuilder for the "common" Elasticsearch hint operator.Sample
GroupComputer implementation that uses company field.A compiled operation chain.
Completes a task.
A scalar property that is linked to a schema field
Helper to handle marshalling of complex types into a JSON-encoded string.
A complex type is tree-like structure of named elements which can be of any type.
A Complex Type holds several fields.
Helper to handle Complex types decoding from a JSON encoded String entries of a property file
A stateful session component.
A Nuxeo Runtime component.
A component event.
Exception thrown when a runtime component related to the SuggestionService fails to initialize due to invalid
configuration parameters or missing requirements on the platform.
A component instance is a proxy to the component implementation object.
Listener to be notified about components life cycle events.
Listener interface for component manager events
TODO we use for now the same sorter as OSGIRuntimeService - should be improved later.
A component name.
Manage persistent components.
This class is synchronized to safely update and access the different maps managed by the registry
Some default application start orders.
Deprecated.
since 2023.4 The
MailService takes MailMessage which can be
easily composed via its MailMessage.Builder.Command embedding multiple commands.
A composite type is an aggregation of several schemas.
A Composite Type resolves fields for several schemas.
A filter based on a list of others filters.
Computation receives records from input streams one at a time, it can produce record on its output streams.
The metadata defining a computation.
Extend the metadata to add a mapping for the input and output stream.
Defines how a computation should handle the retries, fallback and batching if any.
Builder to create a ComputationPolicy.
Pool of ComputationRunner
Thread driving a Computation
Marker interface for computed group (avoids changing
NuxeoGroup interface).Interface for computed group service.
ComputedGroupsService implementationHelper class to compute and replace a blob digest.
Work to compute a blob digest asynchronously.
Given a File document holding a pdf on the file:content property and 2 pdfs on the files:files property, the
following operation will provide a pdf that is the result of the merge of all the pdfs, with the content of the one
in file:content property first.
Operation for merging 2-n videos in one.
An exception thrown if a concurrent update was detected.
Deprecated.
since 11.1,
IsolatedClassloader doesn't exist anymoreCommand for managing the configuration.
Mapper implementation that uses the
UserMapperServiceConfiguration of the
VideoService.This interface is experimental.
Builder for server configuration and datasource files from templates and properties.
Class used to hold the configuration for Nuxeo.
Class used to load the configuration for Nuxeo.
Class used to read/write the
nuxeo.conf file.Dumps the configuration properties and runtime properties.
Descriptor for JSF configuration contributions.
Service holding runtime configuration properties.
Nuxeo Runtime Component used to wrap nuxeo-connect-client services as Nuxeo Services.
Root object: mainly acts as a router.
Helper to acquire a JDBC
Connection from a datasource name.Store information about registration and possible updates
This helper writes in the log as browsers object console.log(), console.error(), console.warn() in Automation
Scripting.
Annotation to define a console log level threshold on the root logger, which allows us to hide console log messages
when launching tests.
Constants used by the
RenditionService.3D conversion constants
Constants used for converters.
Constants for documents count statistics.
A constraint object defines a constraint on a custom type.
Represent the description of a constraint.
Convert
Constraint to Json.Some usefull utils for Constraint API.
A constraint violation description.
Allows to locates some constraint violation in a document.
A consumer consumes
Message by batch.The consumer policy drive the consumer pool and runner.
Run a pool of ConsumerRunner.
Read messages from a tailer and drive a consumer according to its policy.
The return status of a
ConsumerRunnerDeprecated.
since 10.2, use
TransactionalFeature insteadContent factory descriptor.
Enum for types on Content associated to a
TemplateInputLocal configuration class to handle configuration of DocumentContentView.
Default implementation of
ContentViewConfiguration.Factory creating the
ContentViewConfigurationAdapter adapter if the document has the
ContentViewLocalConfiguration facet.To inject contextual data into an operation field.
Factory used to register new Context Extensions The resturned Object will be directly accessible inside the Rendering
context
Registry for
ContextHelperDescriptor descriptors.This class is just a wrapper to hold the initialization of Nuxeo CMIS until we have received the "go ahead" from the
Runtime and that everything is fully initialized.
Grab security token and source context for setting write access onto naming context during container startup.
Simple String wrapper to allow manipulating a "standalone" string in the context == changing value without changing
reference.
Enrich
DocumentModel Json.Deprecated.
since 10.3 use DefaultComponent descriptors management methods instead
Represents an Entry in the
ConversionService cache system.Manages GC processing to clean up disk cache.
Manager for the cache system of the
ConversionService.Base exception raised by the
ConversionService.Interface for the Conversion Service.
Runtime Component that also provides the POJO implementation of the
ConversionService.Work executing a given conversion.
Adapter allowing to convert a Blob using a named converter or a destination mime type.
Convert the given blob to a file with given mimetype.
Interface that must be implemented by any contributer Converter class.
Base class for preview based on "on the fly" HTML transformers
Result object for an availability check on a Converter.
XMap descriptor for the contribution of a new
Converter.Exception thrown when selected converter is not registered.
Helper class to manage mime-types chains.
Helpers for Cookies.
Copy a file to the given target directory or file.
Copy a Log to another
Response wrapper that can capture response result, using a
DeferredFileOutputStream.Captures content written to the target stream.
Implementation of a
Directory on top of a core repository.Descriptor for a
CoreDirectory.Factory implementation for directory on repository
Session class for directory on repository
Nuxeo core event.
Core event constants.
Nuxeo core event implementation.
Implementation of the
PublicationNode for Simple Core Folders.The functions exposed by the core library.
Relation graph implementation delegating to the core.
Only one of those is filled.
Fake Node type used to pass down multiple nodes into whereBuilder.
Factory for CoreGraph.
The CoreInstance is the main access point to a CoreSession.
Services that wants to register with the core management for being call-backed should implement that interface.
Implementation of the
PublishedDocumentFactory for simple core implementation using native proxy system.Implementation of the
PublishedDocumentFactory for core implementation using native proxy system with
validation workflow.Page provider performing a queryAndFetch on a core session.
Unrestricted session runner providing API for retrieving the result list.
Page provider performing a query on a core session.
Core Query page provider descriptor.
Unrestricted session runner providing API for retrieving the result documents list.
Service used to register version removal policies.
Descriptor for Core Service orphanVersionRemovalFilter extension point configuration.
Descriptor for Core Service versionRemovalPolicy extension point configuration.
A session to the Nuxeo Core.
Service managing the creation of
CoreSession instances.Implementation for the service managing the acquisition/release of
CoreSession instances.Deprecated.
since 11.4: use dropwizard metrics counter instead
Deprecated.
since 11.4: use dropwizard metrics instead
Deprecated.
since 11.4: use dropwizard metrics instead
Deprecated.
since 11.4: use dropwizard metrics counter instead
Deprecated.
since 11.4: use dropwizard metrics counter instead
Deprecated.
since 11.4: use dropwizard metrics instead
Deprecated.
since 11.4: use dropwizard metrics instead
TODO: detect mine?
Class for the operation to create a Collection.
Creates entries for a given
Directory.Create a document into the input document
Creates a MailMessage document for every new email found in the INBOX.
Creates a MailMessage document for every new email found in the INBOX.
Operation to create or update a group.
Operation to create or update a user.
Create a Picture document into the input document
Creates a task
TODO: detect mine?
Interface to implement for contributions to the FileManagerService creationContainerListProvider extension point.
Credential factory.
Simple username + password.
Supported algorithms (name, keysize):
AES/ECB/PKCS5Padding (128)
DES/ECB/PKCS5Padding (64)
Properties with crypto capabilities.The cryptographic algorithms depend on: Environment.SERVER_STATUS_KEY Environment.CRYPT_KEYALIAS && Environment.CRYPT_KEYSTORE_PATH || getProperty(Environment.JAVA_DEFAULT_KEYSTORE) Environment.CRYPT_KEY Changing one of those parameters will affect the ability to read encrypted values.
CSS URL rewriting processor, handling basePath variable replacement, and avoiding crash when one given URL cannot be
rewritten.
Work task to import form a CSV file.
Helper class to compute a unique id for an import task.
Inputs:
i1: Reads
BulkBucket
Outputs
o1: Writes Record containing csv lines
A cursor result which holds a DB cursor and additional information to scroll this DB cursor.
A low level holder of DB cursors that manages cleaning on timeout.
Provides default values for new user certificates.
High-level user certificate and keystore operations.
Base implementation of the user certificate service.
Item holding information about a Document with a task attached to it.
Dashboard item implementation.
A collection of
Tables.Used when detecting an issue with database driver
A generic message that contains a commandId and a number of processed docs
Monitors consumer latencies to Datadog.
Reports metrics to Datadog.
Reports traces to Datadog agent.
Deprecated.
since 8.4 for public use, this is an internal implementation class subject to change
Data model implementation.
Initialize a
Properties object from one or more DataModels.Nuxeo component allowing the JNDI registration of datasources by extension point contributions.
The descriptor for a Nuxeo-defined datasource.
This class is used for tests, where datasources are set up from a jdbc: url and user/password instead of a JNDI name.
Helper class to look up
DataSources without having to deal with vendor-specific JNDI prefixes.Helper to add duration to a date with the same format as ES Date histogram interval
This constraint ensures a date is in an interval.
Deprecated.
since 11.1 not used
Parse / format ISO 8601 dates.
Date range parser.
Date range query constants.
Enum describing the format to use when marshaling a date into JSON.
The date (actually timestamp) type.
Java 8 time utilities.
The DBS Cache layer used to cache some method call of real repository
The DBS Cache layer used to cache some method call of real repository
Factory used to initialize the DBS Cache layer in front of the real repository.
Encapsulates cluster node DBS invalidations management.
Interface for a connection to a
DBSRepository.Abstracts queries with operators.
Interface for a connection to a
DBSRepository.Implementation of a
Document for Document-Based Storage.Implementation of a
Document state for Document-Based Storage.Expression evaluator for a
DBSDocument state.Info about an iterator and how to compute it from a state.
Info about a value and how to compute it from the toplevel state or an iterator's state.
A set of invalidations for a given repository.
Propagator of invalidations to a set of
DBSInvalidationsQueues.Queue of invalidations.
PubSub implementation of
DBSClusterInvalidator.DBS-specific query optimizer.
Interface for a
Repository for Document-Based Storage.Provides sharing behavior for repository sessions and other basic functions.
Finds the paths for all blobs in all document types.
Type of id to used for documents.
DBS Repository Descriptor.
Base DBS implementation of a
RepositoryFactory, creating a subclass of DBSRepository.Service holding the configuration for DBS repositories.
Implementation of a
Session for Document-Based Storage.Transactional state for a session.
Iterates on a
State to find the blob keys.Logic to get the conditions to use to match and update a change token.
Iterates on a state diff to find the paths corresponding to dirty values.
Deprecated.
since 2021.11 use
UpdateReadAclsAction insteadDeprecated.
since 2021.11 use
UpdateReadAclsAction insteadAction that decodes an inbound request from the
HttpServletRequestResponseContext to MessageContext.Contains the Hibernate based (legacy) implementation
Deprecated.
since 10.10, audit bulker is now handled with nuxeo-stream, no replacement
Default batch handler,
Deprecated.
since 2023.9, use
LocalBlobProvider insteadDefault blob dispatcher, that uses the repository name as the blob provider.
Default implementation of the
CommandTester interface.Empty implementation for a component.
Default contribution to the CreationContainerListProvider extension point that find the list of Workspaces the user
has the right to create new document into.
Default implementation for a directory factory component, that simply delegates registration of descriptors to the
DirectoryService.Default implementation for DocumentModel factory The default empty constructor create Folder for folderish file and
File for other.
Default filter for tree elements.
Default implementation for document tree sorter.
Base class to build views for Document oriented contexts (contexts that are bound to a document).
Default implementation for an ELContext factory.
Helper to deal with HTTP errors.
Default file importer, creating a regular file.
Default implementation of a
FileSystemItemFactory.Default importer
Allows basic configuration of the default importer :
Default implementation of the
LdapExceptionProcessor based on Errors returned by OpenDSBase class to convert json as
List.Base class to convert
List as json.Provides the default locale and timezone from the server.
Component used to install/uninstall the monitors (transaction and connections).
Default multi-threading policy (creates a new thread on each branch until the max nb thread is reached)
A Computation policy that can be use for Nuxeo.
A default implementation of a visitor that visits depth-first in standard expression order.
Abstract RenderingContext subclass that adds capabilities of storing a DocumentModel and retrieve RenderingConfig
associated with the current set DocumentModel.
Descriptor for the default rendition of a document.
Helper class to manage:
unrestricted fetch of Sections
filtering according to user rights
New behavior @since 9.2 As the runtime lifecycle changed there make no sense to unregister components by their own.
Rewrite an Elsaticsearch search request to add security filter.
A service provider.
The default @{link StoredRenditionManager} to Manage
StoredRenditions on behalf of the
RenditionService.Default implementation of a synchronization root
FolderItem.Default
FileSystemItemFactory for a synchronization root FolderItem.Default implementation of the top level
FolderItem.Default implementation of a
TopLevelFolderItemFactory.A type loader which is loading types from META-INF/web-types file.
Changes group equality or difference matches to take into account a suffix.
Default implementation of the
UserWorkspaceService.Default NXP validator.
Removes the version history if no proxies exist, otherwise do nothing.
The delete command.
A
DELETE statement.Delete entries for a given
Directory.Core Event listener that cleans relation on deleted documents; it should be executed after PublishRelationsListener
so as to be able to copy relations from the deleted proxies.
Listener that deletes deletes related tasks of the document.
Bulk Action to delete documents directly at storage level.
Value holding a base value and a delta.
Value holding a base
Long value and a delta.Deploy a runtime bundle, or a directory containing runtime bundles.
A list of artifacts to be deployed.
Deploys runtime configuration files to the framework.
Install bundle, flush any application cache and perform Nuxeo preprocessing on the bundle.
Initializer for the deployment skeleton, taking care of creating templates, aggregating default components before
runtime is started.
Install bundle, flush any application cache and perform Nuxeo preprocessing on the bundle.
Allow the usage of multiple @Deploy
Logger for deprecation that can hold the version from which this deprecation starts.
Possible depth values for "marshaller-to-marshaller" calls (to avoid the infinite loops).
Descriptors implementing this interface will automatically be registered within the default registry in
DefaultComponent.Default generic descriptor registry.
Marker interface to define Adapters that won't keep a reference to a
DocumentModel instance.Operation to detach an bound documents from a template.
Bundle descriptor for hot deployment.
Expose dev bundles reloading feature to management interface
A
MutableClassLoader for dev hot reload purpose.This class is used from DevFrameworkBootstrap class by reflection.
Enable remote hot deploy and getting configuration from remote Nuxeo SDK servers
A Dialect encapsulates knowledge about database-specific behavior.
Structured Array Subquery Abstract Class.
Type of id when stored in the database.
Information needed to express fulltext search with scoring.
DB2-specific dialect.
H2-specific dialect.
MySQL-specific dialect.
Oracle-specific dialect.
PostgreSQL-specific dialect.
Microsoft SQL Server-specific dialect.
Nuxeo Authenticator for HTTP Digest Access Authentication (RFC 2617).
Configuration for the digest.
The directory interface.
Audit storage implementation for an Audit directory.
A
BundleFile that is backed by a filesystem directory, for use in test settings from Eclipse or maven.Very simple cache system to cache directory entry lookups (not search queries) on top of nuxeo cache
Event listener that flushes the
DirectoryService caches.Description of the specific capabilities of a directory for tests, and helper methods.
Local configuration class to handle local configuration for directories.
Default implementation of
DirectoryConfiguration.Factory creating the
ContentViewConfigurationAdapter adapter if the document has the
ContentViewLocalConfiguration facet.Helper to load data from a CSV file.
Interface for delete constraint on a directory, dependent to another directory.
Directory ui descriptor
Exception thrown when attempting to delete a directory entry which has constraints preventing the deletion.
Convert Json as
DirectoryEntry.Convert
DirectoryEntry to Json.Specific exception thrown when a directory entry is not found
Simple page provider giving the possibility to paginate a
Directory.This
ObjectResolver allows to manage integrity for fields containing references to directory's entry.Exception thrown when dealing with a Directory.
Generic
BaseDirectoryDescriptor registry holding registered descriptors and instantiated Directory
objects.Exception thrown when access to a directory is denied.
Updater in charge of override directory changes.
since 2021.9
Encapsulates a hostname and port.
Utility to fetch SRV records from a DNS server to get the list of available ldap servers from the DN representation
of the domain.
Utility class to perform DNS lookups for services.
Descriptor that is used to define how DocumenModel should be created from XML input
Helper class to get java runtime owner user id
Rewrite a Document get request to add security.
Migrate a DocumentType to a facet
A low-level document from a
Session.An accessor that can read or write a blob and know its xpath.
Context passed to write operations to optionally record things to do at
Document.WriteContext.flush(org.nuxeo.ecm.core.model.Document) time.Create filters that are able to filter documents on their attribute (Regular Doc, Published Doc, Version, Link,
Proxy, Immutable, Mutable)
Audit log stores event related to the "live" DocumentModel.
DocumentModel backed implementation of a FileItem.DocumentModel backed implementation of a FolderItem.BlobHolder implementation based on a DocumentModel and a XPath.Writer for a
DocumentBlobHolder, keeping the context of the current document, which allows for later
filtering by the DownloadService.Consumer Pool that block Nuxeo listeners during import.
Content view descriptor put on document types.
Domain Event for Document.
Event Context used for Document Domain Event.
Propagate internal document events to a document DomainEvent stream.
Document event categories.
Specialized implementation to be used with an abstract session
TODO: write description.
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.
Page provider that is dedicated to fetching history of a Document.
Dedicated interface to browse history of a document
Implementation of the
DocumentHistoryReader interface.Codec handling a document repository, id, view and additional request parameters.
Document server name with its unique identifier within this server.
Allows to import Document Locks
Perform a NXQL full-text query (on the title by default) on the repository and suggest to navigate to the top
documents matching that query.
Message that represent an immutable Nuxeo document.
Consumes DocumentMessage and produce Nuxeo document.
Configurable Group Computer based on Metadata of Documents.
The document model is a serializable representation of a core document.
Info fetched internally during a refresh.
Iterator over the children of a folder.
This implementation collect
DocumentModel objects and return them as a DocumentModelList object.DocumentModel comparator.
Utility class to have helper methods for exporting a document model in a CSV file.
Bridge between a
DocumentModel and a Document for creation / update.Standard implementation of a
DocumentModel.A serializable iterator of document models.
Convert Json as
DocumentModel.Convert
DocumentModel to Json.A serializable list of document models.
This implementation collect
DocumentModel objects and return them as a DocumentModelList object.Wraps a
DocumentModelList inside a PageProvider.Adapter that returns a list of {
DocumentModels.This
ObjectResolver allows to manage integrity for fields containing DocumentModel references (id or
path).Resolves expressions for the
DocumentModel framework.Resource adapter using the document model id.
Used to control the server administrative status: the status of the server can be passive or active.
A writer that only updates existing documents.
Utility methods to deal with property names retrieval.
A writer which is creating new docs or updating existing docs.
Exception thrown when a document is not found.
Operation to execute a query or a named provider with support for Pagination.
Deprecated.
since 8.4, use direct
Property getters on DocumentModel insteadCodec handling a document repository, path, view and additional request parameters.
Convert
Property to Json.A document reader.
Interface for a factory that will provide a custom DocumentReader implementation.
A reference to a core document.
This implementation collect
DocumentRef objects and return them as a DocumentRefList object.A serializable list of document references.
Create relations between documents
Abstract RenderingContext subclass that adds capabilities of storing a DocumentModel and retrieve RenderingConfig
associated with the current set DocumentModel.
Resolves a document URL given its ID
A DocumentRoute model or instance.
Provides
DocumentRoute for a DocumentModel.Lock a newly created route.
Deprecated.
An element of a
DocumentRouteThe lifecycle state of an element
The transition of the lifecycle state.
Basic document routing exception.
Listener that deletes orphan DocumentRoutes.
A Step.
A container of steps.
The DocumentRoutingEngineService is responsible for managing the lifecycle of the DocumentRoute.
Computes the escalation rules to execute on given documents and then execute them.
Triggers the execution of all escalation rules on all running workflows.
Deprecated.
since 2023.0, it was replaced by
DocumentRoutingEscalationActionThis feature provides the basic deployments needed to run a test that uses Document Routing.
The DocumentRoutingPersister is responsible creating a folder structure to persist
DocumentRoute instance,
persisting new DocumentRoute instances and creating DocumentRoute model from DocumentRoute
instance.Updates the security of the
DocumentRoute so the user responsible for starting the route on a document can
see the route.The DocumentRoutingService allows manipulation of
DocumentRoutes.The implementation of the routing service.
Cancel the workflow instance if all its attached document don't exist anymore.
The default persister.
Updates the number of comments stored on the
DocumentRouteStep.Cancels any remaining open tasks created by this workflow when this workflow is done
QuotaStatsUpdater counting the non folderish documents.Wrap a
DocumentModel to expose in a pretty way more information to automation scripts.Request to scroll documents.
Exception thrown when access to a document is denied.
Simple interface useful to wrap a sequence of calls for performing an export.
Simple interface useful to wrap a sequence of calls for performing an import.
Reader for a simple list of DocumentModel objects.
QuotaStatsUpdater counting space used by Blobs in document.Configure the repository to be used
Handle document store initialization
For registering a document store handler
Initialize document store by invoking registered handlers
Runner dedicated to mgmt doc operations
BlobHolder implemention based on a DocumentModel and a Xpath pointing to a String fields.Suggest to navigate to a specific document.
TODO document template should not be aware of rendering context ?
A document transformer.
Translation map for exported/imported documents.
Interface for document tree filter.
An iterator over a tree of documents
Interface for document tree sorter.
Document types are composite types made of several schemas.
Document Type Descriptor.
Implementation of a document type.
Convert
DocumentType to Json.This interface may be used to have a custom logic for type mapping.
Computes the URL of a document.
Enrich
DocumentModel Json.Handler for the
DocumentValidationService "activations" extension point.Exception thrown when some process failed due to
ValidationViolation.A managed set of
ValidationViolation.Convert
DocumentValidationReport to Json.Provides a way to validate
DocumentModel according to their Schema's constraints.Document information describing a document context.
Service used generate meaningful and permanent urls.
Local interface for DocumentViewCodecManager
Remote interface for DocumentViewCodecManager.
TODO: document me.
Wrap a
DocumentModel to expose in a pretty way more information to mvel scripts.Wrapper interface used to wrap the Object that will be put inside the rendering context.
A document writer.
Interface for a factory that will provide a custom DocumentWriter implementation.
Handles the XML export of a document.
Default implementation of a
DocumentXMLExporter.Docx to text converter: parses the Open XML text document to read its content.
Collects Core Events and produces Domain Event Records.
Defines a Domain Event Producer
Dispatches core events to domain event producers.
Handle Domain creation, deletion and lifecycle changes.
Finds the domains for a session.
A ContainerRequestFilter implementation to convert a search request using HTTP POST combine with the
"
.search" path extension to a regular search using HTTP GET.The double type.
A Guard to avoid the current thread within a transaction to download the main blob in the following cases:
- when loading a document with a content/length property that is unset
- when saving a document the previous version is loaded with the blob if content/length is unset
- when performing a fulltext extractor job because content/length has been updated
The Guard is removed on transaction commit or rollback.
Blob holder able to return the blob of a document default rendition.
This class exposes information of a blob given its download path.
Writer for a
DownloadContextBlobHolder, keeping the original document context, which allows for later
filtering on document permissions by the DownloadService.Provides REST binding for
Package download management.Helper class related to the download service.
Descriptor for the permissions associated to a blob download.
This service allows the download of blobs to a HTTP response.
Download context.
Builder for a
DownloadService.DownloadContext.This service allows the download of blobs to a HTTP response.
Simple download servlet used for big files that can not be downloaded from within the JSF context (because of
buffered ResponseWrapper).
Plugin for FS Exporter that exports documents like they should appear in Nuxeo Drive.
Utility Class that stores DublinCore schema constants.
Core Event Listener for updating DublinCore.
Former implementation for DublinCore schema storage.
DublinCore Storage Service Implementation.
A dummy
ServletOutputStream for tests.Dump records from a Log into an Avro file.
Authentication filter handles two factors authentication via Duo
Event handler to duplicate the collection members of a duplicated collection.
An 32 bit integer that can handle bit operations.
The root entry for the WebEngine module.
Default EL action context
Administration interface for Elasticsearch service
Run Elasticsearch indexing operation using the Bulk Service
Component used to configure and manage ElasticSearch integration
Configuration of an embedded (same JVM as Nuxeo) Elasticsearch server.
XMap descriptor for configuring an index
Interface to process indexing of documents
Run Elasticsearch indexing operation
Synchronous Event listener used to record indexing command, submitted after commit completion.
Elasticsearch Page provider that converts the NXQL query build by CoreQueryDocumentPageProvider.
Endpoint to manage Elasticsearch.
Interface to search on documents
Probe to check the status of the ES cluster.
Wait for Elasticsearch indexing background job
Variables for EL expression
Interface for an ELContext factory.
Descriptor for the factory class for an ELContext.
Runner responsible to run or undo an element of a route.
Helper to provide an easy way to execute the expression language defined in a Shibb Group doc
Service providing access to EL-related functions.
Implementation for the service providing access to EL-related functions.
Deprecated.
since 11.1, use
MailAuthenticator insteadHelper class to manage mapping between identification info comming from the OpenID provider and Nuxeo UserManager.
Functions used as stored procedures for H2.
Blob store that stores nothing, useful only when there's a cache in front of it; mostly for unit tests.
Deprecated.
Executes the scroll on an empty result set, useful for external scrollers.
Action that encodes an outbound response from the outbound
MessageContext.Technical wrapper that embed an enriched entity for a broadcast to related enrichers. see
ExtensibleEntityJsonWriter and AbstractJsonEnricher to understand how it works.Base class to read Nuxeo entity Json and convert it in Objects.
Abstract class that knows how to serialize List of nuxeo entities.
Base class to write json entities
Versions are stored in the same order they are registered (in historical package install order).
Interface to be used by Directory implementations to perform arbitrary "fetch-time" adaptations on the entry fields
and the readonly flag.
Interface to make Session behave as a source for a DirectoryCache instance
This constraint ensures some object's String representation is in an enumeration.
Utility class for definitions comparison.
An empty
LiveConnectFile returned when there is an underlying IOException.Implementation of the
AuditBackend interface using Elasticsearch persistenceOverride the JPA audit based change finder to execute query in ES.
Work for the SQL to Elasticsearch audit migration.
An interface for special character escaping in queries for easy configuration of this matter.
Escaping-related utilities.
Factory to create an Elasticsearch client
Extended info for the
ESAuditBackend.Deprecated.
since 2023.5 use default VcsFetcher instead.
Consumes both a SearchHit and DocumentModel.
A field specified using a hint, with optional boost value
Converts an NXQL Elasticsearch Hint into
QueryBuilder.This descriptor allows to add a Elasticsearch Hint.
Iterable query result of results of an ElasticSearch scroll query and next ones.
Exception when Elastic is overloaded by indexing requests.
Iterable query result of the results of an Elasticsearch query.
Wrapper for the results of a scrollable search request.
Elasticsearch implementation of a
DefaultSyncRootFolderItem.Elasticsearch implementation of the
DefaultSyncRootFolderItemFactory.Elasticsearch implementation of
UIDSequencer.A lightweight object used by core components to notify interested components about events in core.
An ordered set of events raised during an user operation.
Interface for dispatching
EventBundle between different EventBundlePipeInterface for a pipe of events.
Used to pass execution status for asynchronous events.
An event context is describing the context in which a core event was raised.
Default implementation
Deprecated.
since 11.4: superseded by dropwizard metrics
Really simple auditable event descriptor.
XMap Descriptor for contributing a new
EventBundleDispatcherSimple stacking descriptor registry
TODO: This service should be moved in another project, and renamed since it's a service, not a simple registry...
Event implementation.
A Quartz job whose execution sends a configured event.
Factory instantiating the
Job and the Trigger of a scheduled event.An event listener receives notifications from core components.
XObject descriptor to declare event listeners
Utility class used to manage event listeners descriptors.
Deprecated.
since 11.4: superseded by dropwizard metrics
Deprecated.
since 11.4: superseded by dropwizard metrics
Deprecated.
since 11.4: superseded by dropwizard metrics
XMap Descriptor for contributing a new
EventBundlePipeContribution registry for EventPipeDescriptor
The event service manages listener registries and notifies listeners about core events.
Interface for EventService administration
Event Service Component, allowing registration of contributions and doing the event service shutdown upon
deactivation.
Implementation of the event service.
Event stats service.
Deprecated.
since 11.4: superseded by dropwizard metrics
Deprecated.
since 11.4: superseded by dropwizard metrics
Simple error handler to give back a user-readable status, and log it to the console.
Listener performing operations when dealing with an error.
Provides utility methods for manipulating and examining exceptions in a generic way.
Wraps result of the command-line execution:
executed command line,
output buffer,
return code,
java Exception.
The execution context of an actions pipe.
Interface for class that provide a way to execute a
CommandLineDescriptor.Helper to handle the UNDEFINED Exif data type.
An existing resource corresponds to an existing object (folder or file) in the repository.
Throw it from an operation to interrupt a chain execution.
Signifies that annotated API is still in early stage and subject to incompatible changes, or even removal, in a
future release.
Constants that provide the types for which the reader are for.
Operation that export a document.
A representation for an exported document.
A representation for an exported document.
Simple Plugin that imports IO Zip archive into Nuxeo using the IO core service.
Interface for extension used to enrich the export
An infix expression.
Evaluator for an
Expression.Interface for a class that knows how to resolve a path into an id.
Extended audit info entities, used to persist contributed extended information.
Extended info descriptor
Deserializer class for extended info from a JSON object
Extended audit info entities, used to persist contributed extended information.
Serializer class for extended info to a JSON object
Defines an extensible object.
Compared to the default
DocumentReader implementation this one does handle versions and allows to plug
ExportExtensionCompared to the default
DocumentModelWriter implementation this one does handle versions and allows to plug
ExportExtensionBase class to write Nuxeo Json entity.
A component extension.
Filename extension definition.
A component extension point.
Interface to implement when defining a way to get a
Blob that is not stored at the usual place handled by the
repository.Descriptor for registration of an external blob adapter.
Property handling an external blob: create/edit is done from a map, and the value returned is a blob.
Interface that must be implemented by Converter that depend on an external service.
External entity interface.
Filter that checks if the current request was called from an external tool (MS Office for instance)
Bulk Action to extract fulltext from blobs.
Endpoint to run binary fulltext extraction
Extracts Closed Captions from a Video.
Puts on the pipe execution context the values retrieved from the new messages found in the INBOX.
Facet Descriptor.
Implementation of the tag service based on facet
A filter based on facets.
Convert
CompositeType to Json.Defines base facet names used in the core.
Removes a facet
Factory binding descriptor.
Utility class for working with
Result.getFailures()Simulates a compiled script for scripts that don't support compilation.
Enricher that add a boolean flag whether a document belongs to the current user's favorites.
A feature is Nuxeo Runner extension that is able to configure the runner from additional annotations and using a
specific logic.
A Test Case runner that can be extended through features and provide injection though Guice.
Deprecated.
since 2023 because it is handling String property only, use
Repository.Query instead.Generic fetch document operation that can be used on any context that has a document as the input.
Fetch the favorites document root collection.
A field is a member of a complex type.
The FieldAdapterManager fills the gap between the storage and the display structures.
Interface for field definition.
Field definition descriptor.
Field descriptor accepting a separate schema and field or a complete xpath.
The implementation for a field, which is the association of a type, a name, and default values.
Rename / translate a field
Very simple SchemaStore that uses a file storage to persists its schemas.
Preview adapter factory for all documents that have the file schema.
Use a listing file to generate BlobMessage.
Create blob messages using a list of files.
A cache of
Files.Runtime events about transient files which should be deleted once the runtime leave the thread (
FileEventTracker).FileEvent handler that should be implemented by consumers.Wrap a
FileEventHandler for being enlisted in the EventService.Files event tracker which delete files once the runtime leave the threads or at least once the associated marker
object is garbaged.
FileManagerServiceCommon plugin default interface.
Class containing everything needed to create or update a document from a
Blob with the FileManager.Given a WOPI file id, this class extracts information about a blob: a repository name, a doc id and the blob xpath.
Representation of a file, ie. a downloadable
FileSystemItem.File Manager.
Use
FileManager to create a folder and set multiple properties on it.DocumentModel factory based on the
FileManager.Use
FileManager to create documents from blobsUse
FileManager to create documents from blobs and set multiple properties on them.FileManager registry service.
A file reference that can handle file name patterns.
Resource representing a file-like object in the repository.
Script that comes from a file.
Implementation of the Files endpoint.
File Service - manages attachments to a document.
Simple Filesystem based
SourceNodeDeprecated.
since 2023.9, prefer
BlobStoreBlobProvider implementation insteadBlob provider that can reference files on the filesystem.
Allows to find document changes.
Summary of file system changes, including:
A list of file system item changes
A global status code
A document change is implemented by
FileSystemItemChange.Default implementation of a
FileSystemChangeSummary.File system external adapter that takes the "container" property to set the absolute path of the container folder on
the file system.
Representation of a file system item, typically a file or a folder.
Factory for
FileSystemItem adapters.Service for creating the right
FileSystemItem adapter depending on the DocumentModel type or facet.Default implementation of the
FileSystemItemAdapterService.Representation of a file system item change.
Default implementation of a
FileSystemItemChange.JsonDeserializer for a FileSystemItem.Interface for the classes contributed to the
fileSystemItemFactory extension point of the
FileSystemItemAdapterService.XMap descriptor for factories contributed to the
fileSystemItemFactory extension point of the
FileSystemItemAdapterService.Registry for
fileSystemItemFactory contributions.Wrapper for a
FileSystemItemFactory instance.Helper for
FileSystemItem manipulation.Provides an API to manage usual file system operations on a
FileSystemItem given its id.Default implementation of the
FileSystemItemManager.Compare versions of files as they are usually set.
SourceNode implementation that manages Meta-data from properties files per documentSourceNode implementation that manages Meta-data from properties filestext/plain is needed otherwise resteasy will use its default text plain (@see DefaultTextPlain) writer to write
text/plain objects and the file is not written correctly.
A filtering function for data models.
Descriptor for
RequestFilterConfigDescriptor for a servlet filter.
This class is used to apply corrections to a filter expression.
Enumeration of the available jobs
Descriptor for a servlet filter mapping.
A filter set is a collections of filters that should be run for a given request in a servlet context.
Save the session - TODO remove this?
Bulk Action processor that fires group updated events for Nuxeo Drive.
Gets the closest document's ancestor.
A flavor represents the set of information that can be used to switch the theme styling on a given page.
Registry for theme flavors, handling merge of registered
FlavorDescriptor elements.Wro processor to replace flavor variables inside linked CSS file.
Flush all Nuxeo caches by calling
ReloadService.flush()Flushes the JAAS cache.
Flush any cache held by the core.
Flush all nuxeo caches.
Representation of a folder.
A resource for folder-like objects in the repository.
Format a date with the specified locale.
A rich value corresponding to one row or a collection of rows in a table.
The possible states of a fragment.
This class is the main entry point to a Nuxeo runtime application.
Invokes the Framework by reflection as this module does not have access to the runtime context.
Base class for RenderingEngine implementation that will work with freemarker.
Helper class used to extract variable names from a FreeMarker template.
Here, key is holding the alias and value the document type.
Info about the fulltext configuration.
Factory building a
FulltextConfiguration from a FulltextDescriptor.Accumulates paths for string and binary properties in schemas passed to
FulltextConfigurationFactory.PathsFinder.walkSchema(org.nuxeo.ecm.core.schema.types.Schema).Converter that tries to find a way to extract full text content according to input mime-type.
Structure holding fulltext descriptor info for generic fulltext indexing.
Work task that does fulltext extraction from the string properties and the blobs of the given document, saving them
into the fulltext table.
Structured fulltext query analyzer.
Structured fulltext query.
Structured fulltext query operator.
Functions related to simple fulltext parsing.
Helper functions injected in the
ExpressionContext instance.Helper class to handle
java.util.function classes.The implementation of
ESHintQueryBuilder for the "fuzzy" Elasticsearch hint operator.Removes the orphan document blobs.
Removes the orphan versions.
Task for GC dedicated Thread.
Generic importer
Page provider descriptor accepting a custom class name.
Generic Scroll Request.
Generic importer task
The implementation of
ESHintQueryBuilder for the "geo_bounding_box" Elasticsearch hint
operator.The implementation of
ESHintQueryBuilder for the "geo_distance" Elasticsearch hint operator.The implementation of
ESHintQueryBuilder for the "geo_shape" Elasticsearch hint operator.Queries
ActionManager for available actions in the given contextGet all document blobs
Class for the operation to get the collections matching the searching terms.
Returns a Folderish Document or Collection default rendition.
Deprecated.
since 11.4, superseded by dropwizard metrics
Return the content of a
Directory as a JSON StringBlobGet document blob inside the file:content property
Get document blobs inside the files:files property
Retrieve the emails from users/groups who have the given permission on given document.
Class for the operation to get the list of documents from a Collection.
Class for the operation getting the elements present in the Favorites collection.
Retrieve the users/groups who have the given permission on given document.
Gets the versions of the input document.
Returns a json representation of the graph route
Fetch a user from
UserManager and return it as a DocumentModel.Returns all open tasks on the input document(s).
Simple Operation to extract an image view from a Picture Document.
Returns a json representation of the quota info to be displayed in a pie chart
Returns a document rendition given its name.
Deprecated.
since 10.3
Returns a list of current user open tasks where their translated name matches (partially or fully) the 'searchTerm'
parameter.
Returns tasks assigned to current user or one of its groups.
Github user info
XMap Descriptor for the
ConversionService configuration.Global validation violation simply handling a message key.
Converter that relies on
BlobProvider conversions.Provider for blobs getting information from Google Drive.
GooglePlus user info
Deprecated.
since 2023.9, use
GoogleStorageBlobProvider insteadDeprecated.
Blob provider that stores files in Google Cloud Storage.
Scroll files of the Google Storage blob store of a
GoogleStorageBlobProvider, the scroll query is the
provider id.Blob storage configuration in Google Storage.
Interface for graphs.
Interface for a graph description.
Graph descriptor.
A factory for a
Graph.Reports metrics to Graphite.
A node for a route graph.
The internal state of a node.
Graph Node implementation as an adapter over a DocumentModel.
A route graph, defining a workflow with arbitrarily complex transitions between nodes.
Runs the proper nodes depending on the graph state.
Graph type extension defined by its name and implementation class.
Helper to set/get variables on a document that are stored in a facet.
Deprecated.
since 2023.9, use
GridFSBlobProvider insteadA binary backed by GridFS.
Blob provider that stores files in MongoDB GridFS.
Scroll files of the GridFS blob store of a
GridFSBlobProvider, the scroll query is the provider id.Blob provider that stores files in MongoDB GridFS.
For Groovy we are not using the javax.script API because we need more control over debug mode and script class
loader.
Load web types extracted from Groovy source files.
Implement the
UserMapper using Groovy Scripting for the mapping partInterface that must be implemented by all contributed
GroupComputers.Group Computer implementing this interface will expose Group with specific label.
Handles marshaling for SCIM
GroupResourceHandles marshaling for SCIM
GroupResourceHelper for handling SCIM
GroupResourceDefault Groups Provider
Suggest to navigate to a specific group profile.
Should be used to contribute custom guards via extension points
Wrapper used to wrap the Guava cache's statistics into Gauges in order to report them via Codahale Metrics.
Functions used as stored procedures for H2.
Allows to ignore all the tests from a class running this feature if the database configured for tests is not H2.
Enricher that tells whether a "Folderish" or a "Collection" has children or members.
This filter is used to fix the http headers sent to Nuxeo.
Probes to be evaluated at a health check
Returns the status of the application
Helper to dump the heap in a temporary file.
Various static methods used in several test cases.
Hibernate
JtaPlatform that uses our framework.Delete constraint preventing from removing an entry from a parent directory if it is referenced in a child directory.
A dynamic component deployer which enable tests to deploy new contributions after the test was started (i.e. from
inside the test method) The deployer is reloading all the components and reinject the test members.
Deploy actions are usually used by features to customize the deployment of the runtime feature (which is using
the DeaultDeployAction)
Operation to trigger a Hot reload of the Studio Snapshot package.
Extract the text content of HTML documents while trying to respect the paragraph structure.
Interface for the Preview DocumentModel adapter.
Previewer for HTML content.
Listener that sanitizes some HTML fields to remove potential cross-site scripting attacks in them.
Service that sanitizes some HTML fields to remove potential cross-site scripting attacks in them.
Service that sanitizes some HMTL fields to remove potential cross-site scripting attacks in them.
Deprecated, for removal: This API element is subject to removal in a future version.
since 11.5 in favor of elastic rest client
This is an HttpClient wrapped as a JUnit
TestRule to perform needed cleanup on teardown.Deprecated, for removal: This API element is subject to removal in a future version.
since 2023.13, use
HttpClientTestRule insteadThe http client test rule builder.
The http client test rule builder.
Simple abstract filter that provides filter activation logic.
HTTP standard and custom constants usable in any nuxeo stack layer.
Simple interpolation for i18n messages with parameters independently of the UI layer.
Utility methods for translations.
Descriptor for icon elements.
Transforms a query into the same query, doing a copy in the process.
An ID reference to a document.
Utils for identifier generation.
A query / form parameter was expected but not found or has invalid value.
Unit command to crop a picture using ImageMagick.
Unit command to crop and resize an picture.
Unit command to extract information from a picture file.
Wrapper class for the information returned by the Identify ImageMagick command.
Unit command to extract a simplified view of a JPEG file using ImageMagick = extract the needed picture information
to reach the target definition level
Unit command to rotate a picture.
Descriptor for configuration information contribution that will be used by the ImagingService.
Imaging constants.
Deprecated.
since 11.1 use
RecomputeViewsAction insteadThis factory will import a file using a path defined in the option of the factoryBinding extension point.
XMap Descriptor for importer config
Interface for DocumentModel factory
Hold the configuration of an ImporterRunner.
Defines multi-threading policy for the importer
Interface for extension used to enrich the import
Interface for filters used to chose if a
SourceNode should be imported or not.Deprecated.
not used
A Nuxeo Bulk Action to index documents. it decouples the document extraction to build the elasticsearch request and
the indexing.
On indexing completion, do extra tasks like refresh or update index alias.
Holds information about what type of indexing operation must be processed.
Contains logic to stack ElasticSearch commands depending on Document events This class is mainly here to make testing
easier
Simple Indexing Worker
Build elasticsearch requests to index documents.
The properties are mapped by the collector using as key the path of the file/folder to import.
Listen to Scheduler events to check if new scanned files are availables Trigger the importer if not already busy.
Utility class used for testing JNDI space provider.
Descriptor to contribute the initial version state of a document.
Descriptor for an init param.
Minimal eventContext implementation that can be used for events that are not bound to a CoreSession.
InlineRef allows to create stream ref on the fly, using only a String.
Blob storage in memory, mostly for unit tests.
Scroll blobs of the In-Memory blob store of a #
InMemoryBlobProvider, the scroll query is the provider id.Blob storage in memory, mostly for unit tests.
Default in memory implementation for cache management based on guava
This
InputStream is a technical wrapper for JsonNode.Enum for types of
TemplateInputAn
INSERT statement.Helper class used to manage packages installation issue under windows systems.
Provides REST bindings for
Package install management.Deploy an OSGi bundle into the running platform.
Document repository reference including the principal owner of the session.
This
CustomEncoding encodes/decodes Instant to a long (time in milliseconds) before encoding it in
Avro format.Define the instantiation mode for this a marshaller.
The integer type.
Listener to invalidate
UserWorkspaceService when a domain is removed.Propagator of invalidations to a set of
InvalidationsQueues.Queue of invalidations.
The chain could not be validated.
A valid literal cannot have both type and language set.
Dedicated to bad requests: operation unsupported, invalid, not implemented...
Exception thrown when a password did not validate the
UserManager.validatePassword(java.lang.String) method.A predicate has to be a resource.
Exception thrown when setting an illegal property value.
Invalid statement exception.
A subject cannot be a literal.
Reference that uses the matching reference of the target directory to actually do the job.
A method proxy which accept as input only iterable inputs.
Adapter for import/export of audit logs.
IO Resources for logs
Defines functional interface that deals directly with documents import using provided DocumentReader or InputStream
as a source and DocumentWriter that knows how the documents will be saved into the repository.
IODocumentManager basic implementation.
Audit log entry importer/exporter.
Service handling complex import/export of documents and associated resources.
Component registering
IOResourceAdapter instances to an IOManager.IOManager implementation
Adapter for import/export of relations
Map of property names used by the relation adapter.
Relation graph importer/exporter.
IO Resources for relations
Resource adapter holding the import/export for document associated resources.
Resource adapter descriptor
A group of documents associated resources.
Microsoft Exchange Server 2003 item. http://msdn.microsoft.com/en-us/library/aa487549(v=EXCHG.65).aspx
Microsoft Folder Item property. http://msdn.microsoft.com/en-us/library/bb787821(VS.85).aspx
Microsoft Exchange Server 2003 item. http://msdn.microsoft.com/en-us/library/aa487551(v=EXCHG.65).aspx
An iterable query result based on a cursor.
iWork2PDF converter.
Helper class to get container related properties.
Reports traces to Jaeger.
Script that comes from a JAR.
Maps ECM types to Java classes.
Ensures the installation of the Nuxeo JTA/JCA
NamingContext by NuxeoContainer.Helper that can redirect all
java.util.logging messages to the Apache Commons Logging implementation.Holds a connection to a JDBC database.
Logger used for debugging.
A
JDBCMapper maps objects to and from a JDBC database.A
JDBCRowMapper maps Rows to and from a JDBC database.Helper for common JDBC-related operations.
Jena plugin for NXRelations.
Class holding graph and connection so that we can close the connection after having used the graph.
A factory that detects if a Jena graph or a core graph should be used, and remembers it for future invocations.
Experimental - Can be used to inject WebContext through
@Context annotation.Deprecated, for removal: This API element is subject to removal in a future version.
since 2023.13, use
HttpClientTestRule insteadReports metrics to JMX.
helper for common jndi operations copied from jboss Util class
Deprecated.
since 2023.4 Compatibility implementation of MailSender relying on a MailSession available through JNDI.
Simple helper class to trace job execution using the Audit Service.
TemplateProcessor for ODT based templates.A SQL JOIN.
This implementation uses a static persistence provider to be able to instantiate this class without passing by
Framework.getService -> this is to avoid potential problems do to sequencer factories.
Adds a watermark to JPEG image by adding an exif metadata.
Should be implemented by objects that needs to be returned in response to clients as JSOn objects
Uses a JSON definition to retrieve a Blob uploaded in a batch.
Blob holding a JSON string.
Factory interface to create a
Blob from a JSON ObjectDeprecated, for removal: This API element is subject to removal in a future version.
since 11.1.
Read a DocumentModel from an ES Json export.
This object basically overrides the default DocumentObject that doesn't know how to produce/consume JSON
JSon writer that outputs a format ready to eat by elasticsearch.
JSON exporter for target platforms, packages and related info.
Provides a
JsonFactory with ObjectMapper.Writer producing html for Json Operation export.
Deprecated.
since 10.2.
Blob decoder resolving a blob from a given blob provider and a blob key.
Blob decoder resolving a Blob from a given download URL.
Helper to marshaling properties into JSON.
Manage JSON Marshalling for
RecordSet objectsVery basic implementation of a Blob decoder Only usable for StringBlobs
Json writer for operations export.
If this bundle is present in the running platform it should automatically install the NuxeoContainer.
JSON Web Token (JWT) Authentication Plugin.
JSON Web Token (JWT) standard claims.
The JSON Web Token (JWT) Service.
A builder for a JSON Web Token (JWT).
Descriptor for the
JWTService.The JSON Web Token Service implementation.
JXLS
TemplateProcessorParse an xml file describing Kafka configurations, the format is the one used by KafkaConfigDescriptor.
Service to collect kafka configurations.
Apache Kafka implementation of Log.
Misc Kafka Utils
Authentication plugin for handling auth flow with Keyloack
This class is developed to overcome a Jackson version problem between Nuxeo and Keycloak.
Nuxeo uses Jackson version 1.8.x where Keycloak uses 1.9.x
Sadly the
Then
Nuxeo uses Jackson version 1.8.x where Keycloak uses 1.9.x
Sadly the
ObjectMapper.setSerializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include) method is not in 1.8.xThen
KeycloakNuxeoDeployment is the same class as KeycloakDeploymentBuilder, rewriting static method
KeycloakDeploymentBuilder.loadAdapterConfig(java.io.InputStream) to avoid the use of
ObjectMapper.setSerializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include)Plugin for the UserMapper to manage mapping between Ketcloack user and Nuxeo counterpart
A manager for
Credentials.An implementation of
KeyManager that uses a JKS key store.Decides how a key is computed from a blob.
Observer of the writes to an
OutputStream.Represents computation of blob keys based on a message digest.
Write observer computing a digest.
Represents computation of blob keys based on the document id suffixed by the xpath if not the main blob.
Represents trusted managed blob key computation with a fallback
KeyStrategyTransient Store storing properties in a Key/Value store, and storing blobs using a Blob Provider.
Simple key value message.
Key/Value Service.
Implementation for the Key/Value Service.
Key/Value Store.
Descriptor of Key/Value store contribution.
Filter that use a KeyValueStore to pass big record value
Key/Value Store SPI.
UID Sequencer based on a key/value store.
Kerberos v5 in SPNEGO authentication.
Display the current lags of consumers.
Extends LogLag with lower and upper timestamps to express lag as a latency.
Display the current latencies of consumers.
A computation that sends periodically latencies to Datadog.
A computation that sends periodically latencies to graphite.
A computation that sends periodically latencies information into a Log.
Launcher is required to restart.
Layout interface.
Layout column descriptor, acts as an alias of
LayoutRowDescriptor.Context propagated to all layout and widget converters.
Layout definition interface.
Converter for a layout definition.
Default implementation for a layout definition.
Registry holding layout definitions for a given category
Helper class representing a list of layout definitions
Layout definition descriptor.
Descriptor for a list of layout definitions
Layout exception
Provides helper methods, declared as static, to be used by the rendering framework.
Sorter that re-arranges rows according to the row names order.
Implementation for layouts.
Layout manager interface.
Exports and presents documentation about layouts definitions
Layout row interface.
Compares selected row instances to order them in the same order that given by the input list of row names.
Layout row definition interface.
Default implementation for a layout row definition.
Layout row descriptor.
Implementation for layout rows.
Layout list descriptor
Layout store interface.
Regiustry for layoyut type definitions.
Helper class representing a list of layout type definitions.
Deprecated.
since 2023.9
Implementation of the
Rendition interface that allows lazy computation of the rendition BlobsImplementation of the Directory interface for servers implementing the Lightweight Directory Access Protocol.
SSLSocketFactory implementation that verifies all certificates.
Dynamic Reference descriptor for Ldap References.
Interface used to provide a pluggable LDAP Exception processor
Creates an LDAP query filter from a Nuxeo Expression.
Helper class to parse and evaluate if a LDAP filter expression matches a fetched LDAP entry.
Implementation of the directory Reference interface that leverage two common ways of storing relationships in LDAP
directories:
the static attribute strategy where a multi-valued attribute store the exhaustive list of distinguished names of
the refereed entries (eg. the uniqueMember attribute of the groupOfUniqueNames objectclass)
the dynamic attribute strategy where a potentially multi-valued attribute stores a ldap urls intensively
describing the refereed LDAP entries (eg. the memberURLs attribute of the groupOfURLs objectclass)
Wrapper to encapsulate the calls to LDAP and retry the requests in case of ServiceUnavailableException errors
Helper for translating ldap search scope from string to integer
Common internal interface for Ldap entries
Registry for LDAP servers
This class represents a session against an LDAPDirectory.
Implementation of the directory Reference interface that makes it possible to retrieve children of a node in the LDAP
tree structure.
This constraints checks whether an object's String representation size is in some interval.
LibreOffice converter to be used when using the
soffice command line.Document life cycle.
Holds life cycle related constants that are generic enough to be available at a core level.
Descriptor for a life cycle extension.
Exception thrown when an attempt is made to follow an incorrect lifecycle transition or to create a document with an
incorrect initial lifecycle state
A filter based on the document's life cycle.
Life cycle implementation.
Registry for life cycles
Life cycle service.
Life cycle service implementation.
Life cycle state.
Configuration helper class for state configuration.
Life cycle state implementation.
Life cycle transition.
Configuration helper class for transition.
Life cycle transition implementation.
Deprecated.
since 10.1, use
PropertyTrashService instead.Registry for lifecycle <-> types association
Life cycle types mapping descriptor.
Utility class storing information about a link in the PDF.
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.
Internal class to maintain a list of listeners.
Store filter settings for a package listing.
A list of typed objects.
The implementation for a List type.
Utilities around lists.
A holder for a sublist of a list, a flag indicating if there were more elements after the included sublist, and
the total number of items if there had been no batching.
Literal node.
Literal nodes.
Helper class for
Literal and LiteralList.Interface for common cases in live connect modules.
A live connect file exposing some information from an external API file.
Implementation of the
Rendition interface that is applicable for rendition created on the flyLoad entries into a
Directory from a CSV File.Install bundle, flush any application cache and perform Nuxeo preprocessing on the bundle.
Deprecated.
since 2023.9, use
LocalBlobProvider insteadA simple blob provider storing blobs on the local filesystem.
Scroll blobs of the Local blob store of a #
LocalBlobProvider, the scroll query is the provider id.Blob storage as files on a local filesystem.
Configuration for the local storage of files.
Interface that must be implemented by other interface representing a local configuration.
Service handling
LocalConfiguration classes.Default implementation of
LocalConfigurationService.Deprecated.
since 10.1, use
DeployAllow external components to provide locale and timezone to be used in the application.
Message method that differs from the standard one as its second argument is the locale.
Provides locale and timezone.
Local In memory implementation: directly relays to WorkManager
In memory implementation that does not handle any marshaling and directly feeds the
WorkManager.Local Session: implementation of
CoreSession beyond AbstractSession, dealing with low-level stuff.Local configuration class to handle configuration of theme.
Default implementation of
LocalThemeConfig.Factory creating the
LocalThemeConfigAdapter adapter if the document has the ThemeLocalConfiguration
facet.Information about a lock set on a document.
Provides
LockableDocumentRoute for a DocumentModel.Exception thrown when failing to lock or unlock a document.
Handles expired WOPI locks by unlocking the related document and removing the stored lock.
Allows to export Lock information as part of the XML strem
Utilities to work with locks
Manager of locks for a repository.
Descriptor of a
LockManager for the LockManagerService.Service holding the registered lock managers.
Security policy that blocks WRITE permission on a document if it is locked by someone else.
Lock Service - manages locks on documents.
Helper class to run jobs in lock step in several threads.
Level of details converter for 3D document type
Add tracing identifier to the log4j contextMap
Provides helper methods for working with log4j
An appender is used to append message into a Log.
Write blob information to a Log, use only one partition.
Test feature to capture from a log4j appender to check that some log4j calls have been correctly called.
Default Nuxeo filter which takes a logger name and a log level to accept only events matching both.
Log result class.
Log entry.
Convert
LogEntry to CSV only keeping default and fetched properties if any.Log entry implementation.
Convert
LogEntry to Json.Annotation that will help you managing the logging when dealing with tests.
This service is performing a login under another identity without checking the password.
LoginAs component.
Component holding the stack of logged in principals.
Interface for services that knows how to handle login responses.
XMap object to manage configuration of the login screen (login.jsp)Registry handling hot-reload and merge of
LoginScreenConfig contributions.Simple helper class for easy access form the login.jsp page
Deprecated.
since 11.1
Deprecated.
since 11.1
Tag for indicating CAS's "login URL" for the cas:auth tag.
Represent the number of messages between 2 offsets
Manage Log and give access to Appenders and Tailers.
A message position in a partition.
An operation to log in log4j.
Logout tag for use with the Yale Central Authentication Service.
A tuple to store a Log name and the partition index.
A LogRecord contains the message and its offset.
Logs interface.
Remote interface for Logs.
StreamManager based on a LogManager
Sequential reader for a partition or multiple partitions.
The long type.
A LRU cache of
Files with maximum filesystem size.Filter keeping regular files that aren't temporary.
A very minimal escaper: does double quotes (putting just one is incorrect), +, - and !
Checks for unread emails in the inbox of an Email Folder.
Constants specific to Mail Core.
Helper for Mail Core.
Deprecated.
since 2023.4 Use a
MailSender insteadListener that listens for MailReceivedEvent.
Identifies NuxeoExceptions related to
MailMessage sending.OutputStream used within a Session to print debug logs.A class representing a mail message.
BlobHolder for MailMessage documents.
Return appropriate BlobHolder for MailMessage documents.
Security policy that denies Write access on MailMessage documents.
Interface for sending
MailMessages.Describes a
MailSender which can be parameterized with properties.Service used to send mails.
Builds your
Session.The web entry point of WebEngine.
Exposes a limited set of Read Only Elasticsearch REST API.
Interface for
Blobs created and managed by the BlobManager.Can be implemented by managed servlets that belong to a bundle to have the servlet descriptor injected by the
container just before the init() method is called.
This
CustomEncoding encodes/decodes Map<String, Serializable> to a JSON
String using Jackson before encoding it in Avro format.Evaluates an expression on a map.
Identifiers assigned by a server to identify a client mapper and its repository.
Applies the mapping passed as parameter on the input task document.
Phantom properties are not stored as children objects.
Interface of Java type converter.
Quick use of
MarshallerRegistry.Utility class used to instanciate marshallers.
Service to get specialize marshaller.
POJO used to handle "register"
MarshallerRegistry extension point.Implementation of
MarshallerRegistry.This class gather all marshalling related constants.
Exception thrown by the
MarshallerRegistry and all Marshallers.The implementation of
ESHintQueryBuilder for the "match" Elasticsearch hint operator.The implementation of
ESHintQueryBuilder for the "match_phrase" Elasticsearch hint operator.The implementation of
ESHintQueryBuilder for the "match_phrase_prefix" Elasticsearch hint
operator.Exception thrown when too much level of marshaller where loaded in cascade.
Markdown to HTML converter
Markdown to text converter.
A compound tailer to handle multiple partitions.
In-memory implementation of a
DBSConnection.Memory-based implementation of a Key/Value store.
Memory implementation of Log.
Memory implementation of LogAppender.
Memory implementation of LogManager.
Memory implementation of Log partition.
Tracks the committed offset for a group.
Memory implementation of Logs.
Memory implementation of LogTailer.
Memory-based
BlockingQueue.Evaluates an expression on a memory directory entry.
Trivial in-memory implementation of a Directory to use in unit tests.
Implementation of a
WorkQueuing using in-memory queuing.In-Memory implementation of
PubSubProvider.In-memory implementation of a
DBSRepository.Memory Repository Descriptor.
In-memory implementation of a
RepositoryFactory, creating a MemRepository.Service holding the configuration for Memory repositories.
A message is an
Externalizable with an identifier.Object method for a message action.
A list of actions being executed on a message.
Collects meta-data from a FileSystem and manage inheritence
Handle properties file creation from a
DocumentModel.Registry for
MetadataMappingDescriptor descriptors.Registry for
MetadataProcessorDescriptor descriptors.Registry for
MetadataRuleDescriptor descriptors.Servlet that returns local SP metadata for configuring IdPs.
Utility class that sorts a list of JUnit methods according to their source line number.
Class Visitor that constructs a map of method name to source line number.
Comparator of methods according to their line number.
Method Visitor that records method source line number.
Deprecated.
Deprecated.
Callback that registers MXBeans for metrics after their creation.
Deprecated.
Simple operation to start metrics reporter
Simple operation to stop metrics reporters
Descriptor of a Migration, consisting of States and Steps.
Migration Service.
Interface for a migration context, passed to the
MigrationService.Migrator.The status of a migration.
Interface for the implementation of a migrator.
Implementation for the Migration Service.
A
migrator wrapper to send invalidations to other nodes when calling
MigrationServiceImpl.InvalidatorMigrator.notifyStatusChange().Migration context implementation that reports progress in the key/value store and can be shutdown.
Thread pool executor that records
Runnables to be able to request shutdown on them.Runnable for the migrator, that knows about the migration context.
Progress reporter that reports progress in the key/value store.
Helper to convert
MailMessages to MimeMessage.MimetypeEntry extension definition.
Exception raised when an unexpected exception occur during mimetype sniffing.
MimetypeEntry entry.
MimetypeEntry.
Listener responsible for computing the mimetype of a new or edited blob and the
common:icon field if
necessary.Exception raised when no matching mimetype entry can be found / guessed by the service.
Allows the management of the mime type entry registry.
MimetypeEntry registry service.
Helper class to manage chains of converters.
Counts the missing values for the specified field
Helper for the banner to open a document in the mobile application.
A mock bucket used to present preselected bucket that are no longer returned by es post filtering.
Mockito loads this with reflection, so this class might appear unused.
The
Model is the link between high-level types and SQL-level objects (entity tables, collections).Type of ids as seen by the VCS Java layer.
Model of a property (simple or array) of a
Node.Info driving the model creation.
The default implementation for a web configuration.
Can be used to register links to your module entry points in the main web engine page
Abstract query builder for a MongoDB query from an
Expression.Implementation of the
AuditBackend interface using MongoDB persistence.Reader for MongoDB Audit.
Writer for MongoDB Audit.
Component used to get a database connection to MongoDB.
MongoDB implementation of a
DBSConnection.Descriptor to retrieve connection information to MongoDB.
Helper for connection to the MongoDB server
Service used to get a database connection to MongoDB.
Converts between MongoDB types (bson) and DBS types (diff, state, list, serializable).
MongoDB implementation of the
CursorService.MongoDB implementation of a
DirectoryExtended info for the
MongoDBExtendedInfo.MongoDB implementation of a Key/Value Store Provider.
MongoDB implementation of a
ReferenceDescriptor for mongoDB directory reference.
MongoDB implementation of a
Repository.MongoDB Repository Descriptor.
MongoDB implementation of a
RepositoryFactory, creating a MongoDBRepository.Query builder for a MongoDB query of the repository from an
Expression.Service holding the configuration for MongoDB repositories.
Helper for serialization/deserialization of BSON objects
Helper for serialization/deserialization of BSON objects
MongoDB implementation of a
SessionTransient Store optimized for MongoDB, using a blob provider for binaries.
MongoDB implementation of
UIDSequencer.Monitors consumer latencies to graphite
The implementation of
ESHintQueryBuilder for the "more_like_this" Elasticsearch hint
operator.Adds watermark to mp4 file by modifying its title.
An aggregate that returns multiple buckets.
Evaluator for an
Expression in the context of the various subdirectories of a MultiDirectory's source.Result is a set of entry ids.
Result is an operand associated to at most one subdirectory.
Renames the references according to a map.
The result of an evaluation of an expression.
Directory session aggregating entries from different sources.
An expression for an single operator with an arbitrary number of operands.
The implementation of
ESHintQueryBuilder for the "multi_match" Elasticsearch hint operator.Multi tenant aware implementation of the
UserWorkspaceService.Some helper function that are injected inside MVEL context
MVEL rendering using a simple cache of compiled template.
An identifier composed of a namespace and a specific name with 2 string representations:
- an uniform resource name (urn) represented as a relative path:
- an identifier (id): encode the urn as
When there is no namespace, URN and id are identical.
- an uniform resource name (urn) represented as a relative path:
namespace/name- an identifier (id): encode the urn as
namespace-nameWhen there is no namespace, URN and id are identical.
Naming context for nuxeo container.
Search main context if name not found in nuxeo's context.
Provides access to the nuxeo container naming context
UserMapper implementation using Nashorn to implement logic using JavaScriptThis class is intended for internal/advanced use.
Descriptor for contributed negotiators.
Registry for negotiations.
Interface for negotiator classes.
Descriptor for contributed negotiators.
Special no operation codec, can be used as marker.
Returns a dummy codec used as marker.
A
Node implementation.Interface for base node.
Node factory to create default nodes.
Node type enum.
Dummy security policy denying all access to File objects with a query transformer.
Transformer that adds
AND ecm:primaryType <> 'File' to the query.Dummy security policy denying all access to File objects.
Simple wrapper to avoid infinit recursion in JSON marshaling
Deprecated.
since 10.10, audit bulker is now handled with nuxeo-stream, no replacement
Picture adapter that creates no picture views at all.
Deprecated.
since 11.1, doesn't seem used
Imports the string content of a blob as text for the content of the "note" field of a new Note document.
Preview adapter factory for the Note document type
Preview exception.
Listener used to intercept
DocumentEventTypes.DOCUMENT_CHECKEDIN events in order to clean notification from
version.Notification Descriptor.
A notification that a user can subscribe to.
Registry for
NotificationListenerVetoDescriptor elementsThis class holds data about the notifications.
Enricher that lists the current user's subscribed notifications for a particular document.
This constraint ensure some object is not null.
Policy filter which disables automatic versioning for collection actions.
Policy filter which disables automatic versioning for System document or document which should never be versioned.
Manage NTLM "Protected POST" see : http://jcifs.samba.org/src/docs/ntlmhttpauth.html
http://curl.haxx.se/rfc/ntlm.html
Listener doing nothing.
Request dumper returning nothing.
Version removal policy that does nothing.
This constraint ensures a numeric is in an interval.
Nuxeo Runtime launcher.
Reads nuxeo archives generated using
NuxeoArchiveWriter.Call Context Handler for Nuxeo authentication that extracts the relevant user name.
Servlet filter handling Nuxeo authentication (JAAS + EJB).
SessionManager interface for Authentication Filter.
AWS Credentials Provider that uses Nuxeo configuration, or uses the default AWS chain as a fallback.
AWS Region Provider that uses Nuxeo configuration, or uses the default AWS chain as a fallback.
Local CMIS binding to the services.
An abstract
BlockingQueue suitable for a fixed-sized ThreadPoolExecutor, that can be implemented in terms of a few methods.Provide access to Nuxeo Framework from Nuxeo Connect Client
Subclass CmisAtomPubServlet to inject a virtual-hosted base URL if needed.
Subclass NuxeoCmisBrowserBindingServlet to inject a virtual-hosted base URL if needed.
Servlet context listener that sets up the CMIS service factory in the servlet context as expected by
CmisAtomPubServlet or
CmisBrowserBindingServlet.Helper to deal with HTTP errors.
Interface for a helper able to extract the error from an exception.
Info about an error to return to client code.
Nuxeo implementation of the CMIS Services, on top of a
CoreSession.Factory for a wrapped
NuxeoCmisService.Nuxeo CmisServiceFactory Descriptor.
Service holding the definition
CMIS Conformance Service Wrapper that has better exception handling than the default.
Computed group implementation class.
Nuxeo contributor to wro processors and locators, registered as a service.
This
ConfigurationFactory provides a common log configuration for tests.ConnectionProvider for Hibernate that looks up the datasource from the Nuxeo container.
Internal helper for the Nuxeo-defined transaction manager and connection manager.
Wraps a transaction manager for providing a dummy recoverable interface.
User transaction that uses this container's transaction manager.
Nuxeo implementation of a CMIS
ContentStream, backed by a Blob.An
InputStream that fetches the actual stream from a Supplier on first use.A
NuxeoContentStream that will generate a redirect.Nuxeo CORS and CSRF filter, returning CORS configuration and preventing CSRF attacks by rejecting dubious requests.
Wrapper for the request to hide the Origin header.
Nuxeo Cors filter description registry model.
Helper class to call NuxeoCtl restart.
A copy of Coursera DatadogReporter with minor adaptation to handle metric with tags.
Live local CMIS Document, which is backed by a Nuxeo document.
Deprecated.
since 10.3
Updates the given
DocumentModel with the input blob.Notify the NuxeoDriveManager service in case of document deletions so as to make it possible to invalidate any cache.
Deprecated.
since 10.3
Information needed for the Nuxeo Drive client update:
Server version
Nuxeo Drive update site URL
Nuxeo Drive beta update site URL
Exception raised when no contributions to the
FileSystemItemAdapterService are found or the component is not
ready, ie. application has not started yet.Creates a document from the input blob in the container backing the
FileSystemItem with the given id.Creates a container with the given name as title in the container backing the
FileSystemItem with the given
id.Create batch of test documents in a single automation query
Deletes the document backing the
FileSystemItem with the given id.Core event related constants for Nuxeo Drive.
Synchronous event listener to track events that cannot be directly handled by the
FileSystemChangeFinder
because the document bound to the event is either no more adaptable as a FileSystemItem after the transaction
has been committed (e.g. deletion) or not a descendant of a synchronization root (e.g. security update on any
document).Checks if the document backing the
FileSystemItem with the given id exists.Deprecated.
since 10.3
Gets a summary of the document changes in the synchronization roots of the currently authenticated user for the
interval starting with the given lower bound.
Gets the children of the document backing the
FolderItem with the given id.Deprecated.
since 10.3
Gets the
FileSystemItem with the given id.Gets the list of synchronization roots for the currently authenticated user.
Gets the top level
FolderItem.Post-commit asynchronous listener that handles group change events fired by the
UserManager.Helper for the Nuxeo Drive integration tests.
Manage list of NuxeoDrive synchronization roots and devices for a given nuxeo user.
Manage list of NuxeoDrive synchronization roots and devices for a given nuxeo user.
Moves the document backing the
FileSystemItem with the given source id to the document backing the
FileSystemItem with the given destination id.Helper for Nuxeo Drive operations.
Renames the document backing the
FileSystemItem with the given id to the given name.Activates / deactivates the
FileSystemItem factories of the given profile.If the
enable parameter is true, registers the input document as a synchronization root for the
currently authenticated user.Sets up the Nuxeo Drive integration tests environment for the given user names by:
Cleaning it up
Creating test users belonging to the members group
Creating a test workspace
Granting the given permission to the test users on the test workspace
Returns the test users' passwords as a JSON comma separated string.
Event listener to reset the synchronization root registrations on a copied document and its children.
Event listener to reset the synchronization root registrations on a versioned document.
Tears down the Nuxeo Drive integration tests environment by:
Deleting the test users and their personal workspace
Deleting the test workspace
Updates the document backing the
FileSystemItem with the given id with the input blob.Post-commit asynchronous listener that pushes the virtual events generated by
NuxeoDriveFileSystemDeletionListener to the Audit log.Deprecated.
since 10.3
Waits for Elasticsearch audit completion.
Help ehcache to find the Nuxeo transaction manager
Filter that sets encoding to UTF-8, before any other filter tries to parse the request.
The most generic exception thrown by the Nuxeo.
Base abstract fileable live local CMIS Object.
Live local CMIS Folder, which is backed by a Nuxeo folderish document.
A Graphite Reporter that handles metric name with tagging.
Holds the list of member users and subgroups for a group.
Convert Json as
NuxeoGroup.Convert
NuxeoGroup to Json.Page provider listing
NuxeoGroups.Header description registry model.
Singleton used to keep track of all HttpSessions.
Filter handling an idempotency key in POST requests.
POJO representing response to be serialized and served by
NuxeoIdempotentFilter.Instance identifier (mainly imported from connect client : TechnicalInstanceIdentifier)
An object representing a log4j event that can be Avro serialized.
An implementation of
LoginContext just holding a principal.Just a helper to easily declare metrics inside a
MetricSet with th ease of Java 8 Lambda expression.OAuth 1 Authentication Plugin.
Servlet for the /oauth endpoint.
OAuth2 Authentication Plugin.
OAuth2 token type can be:
Provided by Nuxeo:
NuxeoOAuth2TokenType.AS_PROVIDER
Consumed by Nuxeo: NuxeoOAuth2TokenType.AS_CLIENT
Represents a application that uses OAuth to consume a Web Service from Nuxeo.
Implementation of the
OAuthToken interface.Base abstract live local CMIS Object, wrapping a
NuxeoSession and a NuxeoObjectData which is backed
by a Nuxeo document.Nuxeo implementation of a CMIS
ObjectData, backed by a DocumentModel.Factory for
NuxeoObject and its related classes.Class to represent a principal in Nuxeo.
Provides another implementation which marshall the user id instead of transferring the whole content and resolve
it when unmarshalled.
Convert Json as
NuxeoPrincipal.Convert
NuxeoPrincipal to Json.* Page provider listing
NuxeoPrincipals.Live Nuxeo document property, wrapping a
NuxeoPropertyData.Nuxeo implementation of an object's property, backed by a property of a
DocumentModel.Property for cmis:checkinComment.
Property for nuxeo:contentStreamDigest.
Property for cmis:contentStreamFileName.
Property for cmis:contentStreamHash.
Property for cmis:contentStreamLength.
Property for cmis:contentMimeTypeLength.
Property for cmis:isLatestMajorVersion.
Property for cmis:isLatestVersion.
Property for cmis:isMajorVersion.
Property for cmis:isVersionSeriesCheckedOut.
Property for cmis:name.
Property for cmis:parentId and nuxeo:parentId.
Property for cmis:path.
Property for cmis:versionLabel.
Property for cmis:versionSeriesCheckedOutBy.
Property for cmis:versionSeriesCheckedOutId.
Base abstract class for a live property of an object.
A fixed Boolean property.
A fixed property (whose value cannot be changed).
A fixed ID property.
A fixed multi-ID property.
A fixed Integer property.
A fixed multi-valued property (whose value cannot be changed).
A fixed String property.
Quartz Connection Provider delegating to the Nuxeo datasource framework.
Live local CMIS Relationship, which is backed by a Nuxeo document.
Information about all Nuxeo repositories.
Information about a Nuxeo repository.
Filter to handle transactions, response buffering, and request synchronization.
Copied from org.jboss.system.JBossRMIClassLoader and modified getClassAnnotation to avoid delegating to default
loader since it has a bug.
Nuxeo Persistent Session, having a direct connection to a Nuxeo
CoreSession.Listen to HttpSession events to update the
NuxeoHttpSessionMonitor.Blocks incoming requests when runtime is in standby mode.
This is called at WAR startup and starts the Nuxeo OSGi runtime and registers the Nuxeo bundles with it.
A Log4j appender that writes to a Nuxeo Stream using Avro encoded event.
Factory for the TransactionManager.
Nuxeo Type Utilities.
Nuxeo URI locator, made available to all wro resources thanks to
NuxeoConfigurableProvider.Factory for the UserTransaction.
Shared attribute is experimental.
Cache key extractor generating a key depending on all request parameters.
Manager generating processors configuration from contributions to
WebResourceManager, and hooking up other
specific factories.Generates a
WroModel using contributions to the WebResourceManager service.Cache key extractor generating a key depending on all request parameters, and accepting slash character for page
names.
Manager generating processors configuration from contributions to
WebResourceManager, and hooking up other
specific factories.Generates a
WroModel using contributions to the ThemeStylingService service.Servlet context listener initiating wro debug mode on runtime dev mode, and hooking up the specific
NuxeoWroPageManagerFactory.Servlet context listener initiating wro debug mode on runtime dev mode, and hooking up the specific
NuxeoWroManagerFactory.Event service configuration.
Deprecated.
DublinCore service facade.
Hack to make a method public !
Copy of the original scimsdk class just to change some org.json constructors scimsdk uses a custom version of
org.json with a different artifactId and some code differences but with the same namespace
This defines the constants for NXQL queries.
Helper to generate NXQL queries from XMap descriptors
Helper class that holds the conversion logic.
Class to hold both a query and a filter
Transformer of NXQL queries into underlying SQL queries to the actual database.
Info about a column and its property type.
Elasticsearch query builder for the Nuxeo ES api.
Deprecated.
since 10.2 this class must not be subclassed anymore, for RuntimeHarness implementation use
RuntimeHarnessImplWebEngine module to handle the OAuth2 callback
OAuth2 Client service
OAuth2 credential factory.
Endpoint to retrieve OAuth2 authentication data
This service is used to manage OAuth2 Service Providers
Implementation of the
OAuth2ServiceProviderRegistry.Directory backed storage for mapping between users and services The current implementation reuses the existing token
directory as storage.
Manages oAuth2 tokens.
The implementation that manages the oauth2 tokens in Nuxeo.
DataStore backed by a Nuxeo DirectoryService interface for managing OAuth Service Consumers
Implementation of the
OAuthConsumerRegistry Service.Service to manage the key and shared secret used by Nuxeo server :
private/public key pair used by Nuxeo to use Signed request with RSA
shared key between Nuxeo and Shindig to manage Signed Fetch
Implements the
OAuthServerKeyManager interface.This service is used to manage OAuth Service Providers: ie REST Services that can be used by Nuxeo via OAuth.
Implementation of the
OAuthServiceProviderRegistry.Represents Token data as manipulated in OAuth during the 3 legged authentication.
Service interface for managing
OAuthToken used both : - in the OAuth the Filter (Server side Tokens) : where
Nuxeo is the provider - in Shindig (Client side Tokens) ; where Nuxeo is the consumer This service provides a center
access point for all Token related actions.Service implementation for
OAuthTokenStore.Make it possible to directly JSON tree nodes parsed by the REST API (e.g. parameters or input) directly to java
datastructures.
Connection pool monitor for an Apache Commons Pool.
External references are document field with a simple type whose value refers to an external business entity.
Manage translation for resolver :
ObjectResolver.Helper.getConstraintErrorMessage(ObjectResolver, Object, Locale, String...)External references are document field with a simple type whose value refers to an external business entity.
Handler for the
ObjectResolverService "resolvers" extension point.Provides a way to instanciate
ObjectResolver.Simple Map base implementation.
Based on Apache JackRabbit OOo converter.
Helper used to modify a ODT/Zip archive for addition Pictures (and potentially fragments)
Authenticator using OpenID to retrieve user identity.
Class that holds info about an OpenID provider, this includes an OAuth Provider as well as urls and icons
Deprecated.
since 11.1
UserInfo Claims.
An operand may be a variable, a function, a literal, or an expression.
Marks a class as being an operation.
WOPI operations used in the
X-WOPI-Override header.Describes an operation chain execution.
An operation context.
The base exception of the operation service.
To be used to mark methods provided by an operation.
Exception thrown when an operation is not allowed on a given directory entry.
An object holding the runtime parameters that should be used by an operation when run.
The operation registry is thread safe and optimized for modifications at startup and lookups at runtime.
Describe an operation class.
Helper to instantiate
OrderByExprs compatible with the search service inside Audit.Deprecated.
since 2021.44 there is now an orphan versions Full GC bulk action (garbageCollectOrphanVersions)
Interface to be implemented by contributions to the orphanVersionRemovalFilter extension point.
Deprecated.
since 2021.44 there is now an orphan versions incremental GC (StreamDocumentGC)
The default BundleActivator for NXRuntime over an OSGi comp. platform.
The default implementation of NXRuntime over an OSGi compatible environment.
This interface is used to implement result collectors when an operation method is invoked over an iterable input.
Wrapper for
CSVPrinter.This
OutputStream is a technical wrapper for JsonGenerator.Dummy implementation of
PackageAdmin service.Build an XML representation of a package.
Provides REST binding for
Package listings.The file
nxserver/data/packages/.packages stores the state of all local features.Helper to access the package update service from JEXL.
Descriptor to associate resources and flavors to a page.
Basic interface for a page provider, independent of type of items in the list
Adapter that expose a page provider that needs only one parameter that is the document Id
Listener to set on a
PageProvider to be notified when the PageProvider changes.Class replacer descriptor interface enable to supersede a class of an existing Page provider.
Registry for page provider class replacements.
Page provider descriptor interface handling all attributes common to a
PageProvider generation.Elasticsearch query builder for Native Page provider.
Registry for page provider contributions.
Endpoint to list PageProviders.
Available types for a
PageProvider.Registry for theme page resources, handling merge of registered
PageDescriptor elements.Entry wrapping selection information for given data entry
List of
PageSelection elements.Abstract adapter to be used when one want to contribute an adapter base on PageProviders.
Wraps a
PageProvider as a DocumentModelListPaginable WebObject.
Wraps a
PageProvider.Adds page support on
RecordSetPaginable object that uses a delegate to handle pagination.
To be used on an operation field to inject operation parameters from the current context.
Copy a file to the given target directory or file.
JUnit4 ParentRunner that knows how to run a test class on multiple backend types.
The
ParameterizedFeature annotation specifies the class to be parameterized.CUP v0.10k TUM Edition 20050516 generated parser.
Deploy a bundle with only a subset of contributions
The bundling of a list and a total size.
Helper to check passwords and generated hashed salted ones.
Contains code from Eclipse org.eclipse.core.runtime.Path class
Deprecated.
since 10.2, unused
Compares documents by paths.
Obsolete since 8.4, transactions are always active.
A path filter.
A PATH reference to a document.
Central service for the generation of a path segment for a document.
Service with a method generating a path segment (name) given a
DocumentModel about to be created.Service generating a path segment from the title by simplifying it to lowercase and dash-separated words.
Service generating a path segment from the title by just removing slashes and limiting size.
Descriptor to contribute a
PathSegmentService.Decides at what path a given key is stored.
Stores a file in a directory based on its key.
Extends the default
PathStrategy.safePath(String) method to ensure resulting path and file name is not too
long.Stores a file in a nested subdirectory based on the initial characters of the key, in groups of 2.
This constraint ensures some object's String representation match a pattern.
Pdf2Html converter based on the pdftohtml command-line executable.
Pdf2Image converter based on imageMagick's convert command-line executable.
Add page numbers to the PDF.
Rendition provider for Pdf conversion which checks that we have a suitable converter given a source mime-type.
Converts each page of a PDF into a picture.
Encrypt/Decrypt a PDF.
Encrypts the PDF with the given permissions.
Encrypts the PDF to "readonly" for users.
Extracts PDF info to specific fields.
Returns a JSON string of an array of objects with page, subType, text and link fields.
Extract pages from
startPage to endPage (inclusive) from the input object.Extracts raw text from a PDF.
The class will parse the info embedded in a PDF, and return them either globally (
toHashMap() or
toString()) or via individual getters.Extract links as list of
LinkInfo from a PDF.Merge several PDFs in one.
Merges Blobs into a single PDF.
The input document(s) always is(are) the first PDF(s), and each pdf is read in the
xpath field.Extract pages from a PDF.
Add page numbers to a PDF, with misc parameters (font, size, color, position).
Removes the encryption, returns a copy of the blob.
Extracts raw text from a PDF.
Grouping miscellaneous utilities in this class.
Return a new blob combining the input PDF and the watermark image blob given as a parameter.
Returns a new blob combining the input PDF and an overlaid PDF on every page.
Return a new blob combining the input PDF and the watermark text given as a parameter.
Enricher that add a pending tasks on a document for the current user.
Common permission descriptor for all directory that use security check
A filter based on permissions.
Listener cleaning the 'aceinfo' directory when a document is removed.
Listener sending an email notification for a granted ACE.
Check access against a built-in permission
Listener filling the 'aceinfo' directory when an ACP is updated.
Provider for existing permission and permission groups.
Version Service - manage document versions TODO not yet implemented
Schedule a
PermissionsPurgeWork to archive ACEs based on permissions_purge page provider from the input
document.Work archiving ACEs based on a query.
Permission based implementation of
FileSystemItemFactory for a synchronization root FolderItem.User workspace and permission based implementation of the
TopLevelFolderItemFactory.User workspace and permission based implementation of the top level
FolderItem.This class holds persistence context information.
Listener updating pre-filling the views of a Picture if the main Blob has changed.
Object to store the definition of a picture conversion, to be used when computing views for a given image.
Registry for the
PictureConversion class (merge supported)Preview adapter factory for the Picture document type
Provides rendition definitions based on the existing picture views.
Provides a rendition based on a picture view (referenced through the rendition definition name).
Simple Operation to convert the size of a picture blob
Factory instantiating
PictureResourceAdapter adapter.since 11.3
Listener updating pre-filling the views of a Picture if the main Blob has changed.
Deprecated.
since 11.1 use
RecomputeViewsAction insteadHelper to compute the picture views of a document.
SPI for a consumer of messages inside the
EventBundlePipeDeprecated.
since 10.3
This class can be used to check if the current platform match a given platform.
Descriptor of the pool of low-level Nuxeo Sessions.
A
BasicManagedDataSource that can configure its internal XADataSource.Transaction Manager that is never in a transaction and doesn't allow starting one.
Pop a document from the context stack and restore the input from the poped document.
Pop a document from the context stack and restore the input from the popped document.
Manipulates the consumer position to the beginning, end or a specific timestamp
Executor that passes an event bundle to post-commit asynchronous listeners (in a separated thread in order to manage
transactions).
Lets the listeners process the event bundle in bulk mode.
Lets the listeners process the event bundle.
A specialized event listener that is notified after the user operation is committed.
Post-commit listener that can decide synchronously whether it's worth calling.
Handler called after the content creation done by the
ContentTemplateService.Descriptor of a registered
PostContentCreationHandler.Registry of
PostContentCreationHandlers.Base class for flush like commands.
Pptx to text converter: parses the Open XML presentation document to read its content.
Predicates are boolean expressions.
Predicate descriptor accepting a schema and field, an operator, and a parameter.
Predicate builders.
Information about what's to be prefetched: individual properties and whole schemas.
Base class for preview adapters that will use preprocessed HTML preview that is stored inside the document.
Representation of a presentation document slide with its string content and its order.
Interface that should be implemented by contributed code to manage custom preview adapters.
Interface of the service that is responsible for managing PreviewAdapters.
Runtime component that handles the extension points and the service interface for Preview Adapter management.
Factory for the DocumentModelAdapter service.
Preview exception.
Enrich
DocumentModel Json.Generates a document preview on worker node and cache the result in a transient store.
Primitive type (basic types like long, string, boolean, etc.).
Provides helper methods to find extract permissions/principals info from documents.
This class implements the principal interface.
Some priorities constants used for annotation's property
Setup.priority().Resource processor.
Registry for processors registry.
A ProducerIterator returns
Message.A Pool of ProducerRunner
A callable pulling a producer iterator in loop.
The return status of a
ProducerRunnerNo yet used A progress monitor is notified by a running process about the execution progress
Reports metrics to Prometheus.
Proof key helper class.
Inline properties file content.
Property descriptor
Service that allows to copy a set of metadata from a source to a target document
Service that allows to copy a set of metadata from a source to a target document
Document properties are instances of document schema fields.
Basic configuration based on properties.
Handler used to provide property's characteristics.
Sets a property that is valid along the current preprocessing context.
Deprecated.
since 11.1, use
TreeCommentManager insteadException thrown when trying to convert a property value to an incompatible type during read or write.
Deprecated.
since 11.1, use
PropertyDescriptor insteadDeprecated.
since 11.1, use
PropertyCharacteristicHandler service insteadThis is a
DocumentTransformer which removes property marked as removed in deprecation system.Descriptor representing a Nuxeo Property.
Base exception thrown when there is a problem accessing a property.
The default property factory singleton.
Property list descriptor
IOResource property list descriptor
Property list descriptor APG-240 All attributes are defined public because the user manager service do not get access
to the fields.
Exception indicating a property not found.
Object to resolve entities referenced by a property.
A
TrashService implementation relying on ecm:isTrashed.Copy-pasted then modified from jaxrs-webdav.
Repository proxies configuration descriptor.
Propagate previously set notifications when a proxy is replaced by a new version.
Receives and keeps track fo PGTs and serial PGT identifiers (IOUs) sent by CAS in response to a ServiceValidate
request.
Validates PTs and optionally retrieves PGT IOUs.
Interface for a Node inside the publication tree.
Interface for the publication tree.
Descriptor for a PublicationTree configuration.
Descriptor of a PublicationTree.
Interface of a Document that was published into a PublicationNode.
Interface of the pluggable factory used to create a PublishedDocument in a give PublicationTree.
Descriptor used to register PublishedDocument factories.
Main publication Service.
POJO implementation of the publisher service.
Core Event listener to copy relations affecting the source document to the proxy upon publication events and the
relations that were present on the replaced proxies if any.
Publish the rendition of a document.
The SPI of a Publish/Subscribe implementation of the
PubSubService.Descriptor for a
PubSubProvider implementation.Publish/Subscribe Service.
Implementation for the Publish/Subscribe Service.
Status of a
PermissionsPurgeWork.Operation to put a parameter on the Simple Configuration of the input Document.
Operation to put parameters on the Simple Configuration of the input Document.
Resource with a qualified name.
Prefixed resource.
Deprecated.
Since 6.0, document query operation logic has been moved.
Query builder for a query, including ordering, limit and offset.
Filtering parameters that can be passed when executing a query.
A Query Maker, that can transform a query string into a SQL statement.
A SQL query that can be executed by the backend.
Descriptor for the registration of a QueryMaker.
Service for the registration of QueryMaker classes.
Service for the registration of QueryMaker classes.
Generic optimizer for a NXQL query.
Info about a prefix: the prefix, and how many times it was encountered.
Renames references if they are in the projection part.
Query result interface.
Query results.
The implementation of
ESHintQueryBuilder for the "query_string Elasticsearch hint operator.transformor pattern to transform a query into another.
Descriptor for the quick filter used by page providers
Interface to manage DocumentModel that supports Quotas
Adapter to manage a DocumentModel that supports Quotas
Simple factory for
QuotaAwareDocument document model adapterHelper class mainly used for UI display
Exception throws by the
DocumentsSizeUpdater to enforce Quotas in case a transaction tries to add too
much BlobsHelper class to have easy to display numbers and stats
Work to set the maxSize on a list of documents
Adapter giving statistics about a given
DocumentModel.Factory creating
QuotaStatsNonFolderishCountAdapter for Folderish
documents.Work doing an initial statistics computation for a defined
QuotaStatsUpdater.Listener handling default events to update statistics through the
QuotaStatsService.Specialization of
QuotaStats to count non-folderish documents.Adapter implementing
QuotaStatsNonFolderishCount to have information about children and descendants count.Service used to compute quota and statistics on documents.
Default implementation of
QuotaStatsService.Specialization of
QuotaStats to return size information.Interface to be implemented by
QuotaStatsUpdaters registered to the
QuotaStatsService.Descriptor object for registering
QuotaStatsUpdaters.Registry for
QuotaStatsUpdaters, handling merge of registered
QuotaStatsUpdaterDescriptor elements.Sets the quota on the user workspace if a global quota was set on all user workspaces
Define execution rules for an annotated random bug.
BYPASS: the test is ignored.
Repeat condition based on
Returns blob information from a Log, loop on the log.
Build random StringBlob message.
Random text generator to be used for load testing
Random
SourceNode to be used for load testingReads entries for a given
Directory.Interface of mimetype to Java type converter.
Exception thrown when attempting to write to a read-only property.
Exception raised during
LogTailer.read(Duration) if there is a rebalancing.Listener to be notified on partition rebalancing.
Recomputes the picture views of the documents resulting from the provided NXQL query.
Recomputes Quota size statistics.
Recomputes the thumbnail of the documents resulting from the provided NXQL query.
Bulk Action processor that generates thumbnails from documents.
Computation that fills the conversions in the
VideoConstants.TRANSCODED_VIDEOS_PROPERTY videos propertyBAF Computation that fills video renditions for the blob property described by the given xpath.
Computation that fills Video Info.
BAF Computation that fills picture views for the blob property described by the given xpath.
Because
EventBundle can be processed asynchronously, they can be executed:
in a different security context
with a different CoreSession
This interface is used to mark Bundles that supports this kind of processing.Default implementation for an
EventBundle that need to be reconnected to a usable Session.Basic data object that contains: key, watermark, flag and data.
Record filtering enables to modify/skip record while it is append or read from a stream.
A chain of record filters.
Chains multiple record filters.
Interface for Wrapping IterableQueryResult
Exception that can be handled at UI level to display a dedicated user message
Redacts sensitive information from messages based on regex patterns.
Descriptor for Core Service versionRemovalPolicy extension point configuration.
Helper class to determine the redirect URI based on the current OpenID provider and HTTP request
Default RedirectUriResolver that allows overriding the redirect uri by setting a session attribute By default it will
use a fixed redirect uri since some provider do not support wildcards
A named reference to a variable (this can be a field or table).
Base interface for references between directory fields.
The implementation of
ESHintQueryBuilder for the "regex" Elasticsearch hint operator.The component registration info.
Constants for relations management.
Relation date management.
Relation event types.
RelationService common interface.
Relation service.
The reload actions to perform when reloading the Nuxeo server.
Helper to hot reload studio bundles.
JAX-RS servlet based on jersey servlet to provide hot reloading.
Flush all nuxeo caches.
Flush all nuxeo caches.
Result of hot reload operation.
Service tracking reload related events or commands when installing a package.
Invokes the ReloadService by reflection as this module does not have access to the runtime context.
Synchronous event handler to update Collection of a removed CollectiomMember and CollectionMember of a Collection by
scheduling an asynchronous work.
Property used to declare property removed from schema.
Class for the operation to remove a list of documents in a Collection.
Class for the operation to remove a list of documents from the Favorites.
Provides REST bindings for
Package removal.Operation that removes all permissions on a given ACL for a given user.
Removes documents which are proxies and whose id is contained in the given ids list.
Interface on an Object that can be used to produce
RenditionSimple adapter factory
Default implementation for
Renderable interface.Render converter 3D document type to PNG
A context used to deliver parameter to marshallers during a marshalling request.
Base class for rendering contexts.
RenderingContext builder.Session wrapper.
A thread-safe
RenderingContext implementation.Utility class that get or create a
RenderingContext from the current HttpServletRequest.A RenderingEngine will be instantiated by the RenderingService according with the descriptor specified for it.
Rendering Engine Descriptor objects instantiated with configuration from contributions like:
A rendering result is an object that wraps a rendering result and give several methods to retrieve the rendering
outcome.
RenderingService core infrastructure.
Implementation of RenderingService
Object representing a registered render view conversion on the
ThreeDService.ContributionFragmentRegistry to register RenderView.Provides a rendition based on a render view (referenced through the rendition definition name).
Operation to wrapp the rendition process
Interface hiding the actual rendition implementation and allowing for Lazy computation of the rendition blobs.
Definition of a rendition.
Interface for providers returning a list of
RenditionDefinition for a given DocumentModel.Descriptor contribution
RenditionDefinitionProviders.Registry for
RenditionDefinitionProviderDescriptor objects.Registry for
RenditionDefinition objects.Retrieves stored Rendition associated to a DocumentModel.
Fetched the live doc for a given proxy on a Rendition
Interface to hide providers of
Rendition.Implementation of
PublicationTree that retrieve also any published
Rendition documents for the given document.Implementation of
PublishedDocumentFactory that uses the RenditionService to publish a Rendition of
the given document.Service handling Rendition Definitions and actual render based on a Rendition Definition
Default implementation of
RenditionService.Remove proxy to the same stored rendition with a different version.
Generates a document rendition on worker node and cache the result in a transient store.
Replaces a given ACE.
A high-level repository descriptor, from which you get a
CoreSession when calling open.Interface to manage a low-level repository.
Interface for the low-level VCS repository.
Meta Scroll to scroll the blobs of the blob provider(s) of a repository, the scroll query is the repository name.
Low-level VCS Repository Descriptor.
Low-level Repository factory.
Repository implementation, to be extended by backend-specific initialization code.A repository initialization handler is responsible for initializing a repository content.
Represents a repository location.
High-level service to get to a
Repository and from there to
CoreSession objects.High-level service to get to a
Repository and from there to
CoreSession objects.Holds all methods bound to a repository
Scrolls document identifiers using the repository search.
Component and service managing low-level repository instances.
Probe that checks that the repository is available by fetching the root doc
An HTTP request context
Manage the context of the current HTTP request and made it available through a thread local variable to web
components that are invoked inside the request.
Interface for the service used to manage what
HttpServletRequest must be protected by the Filter.Runtime component that implements the
RequestControllerManager interface.Interface for the
NuxeoRequestControllerFilter config for a given HttpServletRequest.Basic implementation of the
RequestFilterConfig interface.Validate request inputs.
A resource that can be retrieved using the class loader.
Resource.
Typed Web resource (js, css, bundle).
Adapter to transform any java
Serializable into a qualified name resource and conversely.Adapter to transform a
DocumentModel into a QNameResource and reverse.Deprecated.
resources are deprecated - you should use a jax-rs application to declare more resources.
Hook on REST API URLs (just forwards to the Wro servlet).
Registry for resource elements, handling merge on referenced resources.
Writer for a resource bundle, used to dispatch jax-rs call internally to the wro servlet.
A resource bundle for Nuxeo Rendering that holds a map of locals, allows developers to change it from its api
(setLocale) and that will delegate its method to the correct resource bundle according to the local chosen.
Contextual elements needed for resources retrieval.
A resource request context.
Resource context, only declaring a current flavor for now.
A pointer to a template located in the contributor bundle.
Helper class to acess a resource by name within the current classloader
Resource.
Resource locators are used to resolve resource names to resource URLs
Registry for resource elements.
To be implemented by backends to allow WebEngine dynamically register/unregister resources
Abstraction for resource lookup.
A simple servlet which is serving resources provided by the servlet context
Servlet for accessing common file resources
When implementing a resource store you should implement equals and hashCode method.
The class loader allows modifying the stores (adding/removing).
Handles marshaling for SCIM
BaseResourceEncapsulates the response object generation from a
HttpResponse.Deprecated.
since 2023.0, use
ClusterActionService insteadDeprecated.
since 2023.0, use
ClusterActionService insteadFeature that restart the component manger between each test.
Codec that resolve the Rest url for a document
A custom operation context to be used in REST calls on server side.
Automation exception to extend to be thrown during REST calls on
Automation operations.
Run a script and return the result blob object of the script the output of the operation.
Run a script and return the result Blobs object of the script the output of the operation
Restore consumer positions using the latency tracker Log.
Event handler to restored the collection members of a restored version of a collection.
Run a script and return the result Document object of the script the output of the operation
Run a script and return the result documents object of the script the output of the operation
Restores a document to the input version document.
Repo init to test Rest API
Result item.
Result set.
Result set implementation.
Operation to execute a query or a named provider with support for Pagination
Iterable query result implemented as a cursor on a SQL
ResultSet.Resumes a workflow on a give node.
Security policy that prevents deletion of a document when it is under retention or has a legal hold.
Bulk action executed for documents whose retention has expired.
Listener triggering the check of expired retentions.
RFC-2231 specifies how a MIME parameter value, like
Content-Disposition's filename, can be encoded to
contain arbitrary character sets.Helper to handle synchronization root definitions.
Provides configuration information for root certificate generation services.
Exception raised when recursive factory calls failed to find the ancestry to a the top level folder.
Descriptor used to register
RootSectionFinder factories.Allows interaction with CA root-related PKI objects: certificates, keys, keystore & certificate files
Imports route models in the root folder defined by the current persister from a contributed zip resource.
Imports a route document from a zip archive using the IO core service .
Registry for route templates
Helper method related to Routing Audit.
Define a elasticsearch passthrough filter for audit_wf index view.
Overrides the MVELExpression to add specific helpers depending on the context
Page provider to retrieve workflow tasks.
Grants the READ/WRITE permissions on the route instance to all task actors.
The data of a single row in a table (keys/values form a map), or of multiple rows with the same id (values is an
array of Serializable).
The identification of a
Row (table name and id) without the row content itself.A document id and its primary type and mixin types.
A document id, parent id and primary type, along with the version and proxy information (the potentially impacted
selections).
The description of a set of rows to create, update or delete.
A
Row and a list of its keys that have to be updated.Run an embedded operation chain that returns a DocumentModel using the current input.
Run an embedded operation chain that returns a Blob using the current input.
Deprecated.
since 6.0.
Run a script given as the input of the operation (as a blob).
Enricher that add the runnable workflow model on a document for the current user.
These are the states the runner goes through when using runtime feature:
Enricher that add the running workflow instances on a document for the current user.
Run an embedded operation chain using the current input.
Run an embedded operation chain using the current input.
Run an embedded operation chain for each page of the pageProvider given as input.
Save the session - TODO remove this?
Runtime component, for later extensibility.
The runtime context.
TODO: Move this to org.nuxeo.runtime package
Default RuntimeHarness implementation.
Extracts information about the Bundles currently deployed in Nuxeo Runtime
Represents a message to be held by the Runtime framework.
The type of source that produced a message.
Handles runtime message.
Handles runtime messages by taking care of component manager lifecycle in order to work correctly with hot reload.
Anotating a field with NXMock in a test, injects a mock in that field and binds it to the the service manager.
The runtime service: a singleton object that provides access to the Nuxeo Runtime.
An event in the Nuxeo Runtime life cycle.
A generic exception thrown by the Nuxeo Runtime.
Listener to be notified about the runtime service's life cycle events.
Simple probe to check if the runtime is started
Deprecated.
since 2023.9, use
S3BlobProvider insteadDeprecated.
Probe to check the status of the S3BinaryManager.
Blob provider that stores files in S3.
Scroll objects of the s3 blob store of a #
S3BlobProvider, the scroll query is the provider id.Blob storage in S3.
Blob storage configuration in S3.
Batch Handler allowing direct S3 upload.
S3 transfers relying on
TransferManager.Bulk Action to set blob length property using the length provided by the s3 binary store.
AWS S3 utilities.
Represents an operation that accepts a slice number and a slice begin and end position.
A SAML2 authentication provider.
Use Sass css processor to replace variables, mixin, etc. according to a given flavor.
Save the session - TODO remove this?
Collection IO for arrays of scalar values.
A scalar property that is linked to a schema field
Custom implementation of the
ImporterDocumentModelFactory.Custom implementation of
SourceNode.Extended implementation of
BlobHolder - stores properties extracted from XML - stores documentType extracted
from XMLXMap descriptor for Blob mapping
XMap descriptor for meta-data mapping
Top level descriptor for mapping
Setup the importer with the rights factories
Component to provide service logic : - meta-data parsing - configuration management - extension points
Service interface
Lexer for NXQL
Schedule entry.
ScheduleImpl extension definition.
Endpoint to manage the scheduler tasks.
Scheduler service.
Schedule service implementation.
A marker interface for schemas.
Descriptor for a reference to a schema from a document type or a facet.
The implementation of a Schema
Convert
Schema to Json.The Schema Manager manages core document types, schemas, facets and field types.
Schema Manager implementation.
The available registries of type-like information.
Removes a Schema
Renames a schema
A template for a document's schema, that can still take advantage of the document's prefetched values.
Simple Resource class used to expose the SCIM API on Users endpoint
Roor module to declare resources exposed for SCIM API
SCIM 2.0
ScimResource JSON reader.SCIM 2.0
ScimResource JSON writer.The root entry for the WebEngine module.
Simple Resource class used to expose the SCIM API on Users endpoint
SCIM 2.0 Group object.
Interface for mapping
ScimResource to Nuxeo DocumentModel and vice versa.This service is used to register the SCIM v2 mapping class.
WebEngine module for SCIM 2.0.
SCIM 2.0 User object.
Extract a JPEG screenshot of the video at a given time offset (position).
Execute the scroll on large result set.
Wrapper for the intermediate results of
FolderItem.scrollDescendants(String, int, long) including a list of
documents and a scroll id.Wrapper for the results of
FolderItem.scrollDescendants(String, int, long).JsonDeserializer for a ScrollFileSystemItemList.Default implementation of a
ScrollFileSystemItemList based on an ArrayList.Worker to reindex a large amount of document
A Scroll request.
The result of a
CoreSession.scroll(java.lang.String, int, int) call, giving access to result and the scroll id.Service to scroll large result set.
Searching related exception.
Simple implementation of a
PublicationTree using the Core Sections.A class housing some utility functions exposing secure URL validation and content retrieval.
Interface for pluggable core security policy.
Query transformer that does nothing.
Interface for a class that can transform a string-based query into another.
Pluggable policy descriptor for core security
Service checking permissions for pluggable policies.
Security policy service implementation.
A
SELECT statement.A
Selection holds information about row ids corresponding to a fixed clause for a given table.A
SelectionContext holds information for a set Selection objects, mostly acting as a cache.The different types of selections available, and information about what they correspond to in the database.
Here, key is holding the alias and value the operand.
Save the session - TODO remove this?
Action to answer the mail.
Operation that sends the notification email for a given
ACE.Deprecated.
since 11.1 use
Tracing instead.Generic interface for serializable invalidations.
Java
Serializable encoding.Generic interface for a serializable message.
This component registers and configures an embedded servlet container.
Configuration interface for an embedded server implementation.
The base exception thrown by the CoreSession API.
Xmap object used to represent the contribution to
OAuthServerKeyManager.Credential factory for Service Accounts.
Deprecated.
This class is deprecated since jersey 1.11 which fixed OSGi class loader problems.
Service configuration descriptor
Registry for service configuration, not handling merge.
A service provider.
Handles marshaling for SCIM
ServiceProviderConfigDummy service reference. servicefactory not supported.
Dummy service registration impl.
Tag for indicating the current service for the cas:auth tag.
Validates STs and optionally retrieves PGT IOUs.
Deprecated.
since 10.10, as it prevents automatic port allocation, use
ServletContainerFeature.getPort()
insteadRuns an embedded servlet container.
Descriptor for a servlet.
Helpers for servlets.
Handle servlet registration from Nuxeo extension points.
Implementation of
MailSender building RawMessages and sending them via Amazon SES.Internal Session accessing the low-level storage.
The session is the main high level access point to data from the underlying database.
A session used to access entries in a directory.
Interface for a class that knows how to resolve a node path into a node id.
The session is the main high level access point to data from the underlying database.
Stores informations about a user's Http Session
Operation to set a context variable with the value of the given parameter name of the SimpleConfiguration retrieve
from the input Document.
Settings defines stream's partitions and computation's concurrency and policy.
Annotation used to setup a class as a marshaller and define its instantiation mode and priority.
Generic fetch document operation that can be used on any context that has a document as the input.
Generic fetch document operation that can be used on any context that has a document as the input.
Set a workflow variable.
Set a list of variable on the workflow instance with the given id
Light weight
DocumentModel implementation Only holds DocumentRef, RepositoryName, name, path and
context data.Light Event implementation.
Used to decorate a classloader with a public
SharedClassLoader.addURL(URL) method.Provide contextual access to the
ListingFilterSetting for each listing.Permission based implementation of
FileSystemItemFactory for the parent FolderItem of the user's
shared synchronization roots.Permission based implementation of the parent
FolderItem of the user's shared synchronization roots.Default implementation of the
Executor interface.Page provider listing Shibboleth groups
Provides default values for signing services.
Provides digital signature services that can be performed on PDF documents, e.g.:
signing a specific PDF,
obtaining a list of certificates already associated with a document.
A PDF document can be signed using a user certificate.
Information about a blob and its signing status.
Base implementation for the signature service (also a Nuxeo component).
A generic exception indicating signature generation problems
BlobHolder implementation that simply wraps a detached Blob.Cachable implementation of the
SimpleBlobHolder.
Filter protects resources such that only specified usernames, as authenticated with CAS, can access.
An object that maps keys to values.
Default implementation of
SimpleConfiguration.Factory creating the
SimpleConfigurationAdapter adapter if the document has the SimpleConfiguration
facet.Deprecated.
since 10.3 use DefaultComponent descriptors management methods instead
Implementations of the
PublishedDocument on top of the Core, using simple proxies.A DocumentModel that can have any schema and is not made persistent by itself.
Basic implementation that simply forwards
EventBundle to all underlying EventBundlePipeDeprecated.
since 10.3, implements directly
RunnerFeatureSimple FileSystemItem just holding data, used for JSON deserialization.
A type of fragment corresponding to a single row in a table and its associated in-memory information (state, dirty
fields, attached context).
Comparator of
SimpleFragments according to a field.A Java class to determine image width, height, length and MIME types for a number of image file formats without
loading the whole image data.
Simple managed blob implementation holding just a key and delegating to its provider for implementation.
A simple properties fetcher that always returns the same properties.
A SimpleProperty gives access to a scalar value stored in an underlying
SimpleFragment.The implementation of
ESHintQueryBuilder for the "simple_query_string" Elasticsearch hint
operator.A runtime service used for JUnit tests.
Specific factory for Root.
Default implementation (i.e., not cluster aware) of the
TransientStore.Simple Type.
Implementation of a simple type that is not primitive (and therefore has constraints).
An object that stores simple key/value user preferences.
Very simplified representation of a Nuxeo Bundle used for displaying in the admin screens.
Holds information about current deployed Nuxeo Platform
An aggregate that returns a single bucket.
An aggregate that returns a single value.
Class containing helpers related to the expression of sizes in bytes, kilobytes, etc.
Simple work that just sleeps, mostly used for tests.
Slices the video to obtain a part of it.
Operation for slicing a video in parts with approximately equal duration.
Default implementation of
MailSender building MimeMessages and sending via SMTP protocol.Listener snapshoting documents with the
Snapshotable.FACET facet if the property
snapshotVersioningOption is set.Sync listener that calls the soft delete cleanup method of the repositories.
A
Mapper that uses a SoftRefCachingRowMapper for row-related operation, and delegates to the
Mapper for others.A
RowMapper that has an internal cache.A sorting function for data models.
This class holds the details for sorting.
Descriptor for sort info declaration.
Simple helper to fetch the target Audited document
Interface for Source Nodes for the importer
Deprecated.
since 10.3, use
SQLSession.query(org.nuxeo.ecm.core.query.sql.model.QueryBuilder, boolean) insteadDeprecated.
since 10.3, use
SQLSession.query(org.nuxeo.ecm.core.query.sql.model.QueryBuilder, boolean) insteadBase interface for SQL documents.
A proxy is a shortcut to a target document (a version or normal document).
Builds the map from a result set given a list of columns and column keys.
Knows how to build a result map for a row given a
ResultSet.SQL implementation of a Key/Value Store Provider.
Deprecated.
since 10.3, use
SQLSession.query(org.nuxeo.ecm.core.query.sql.model.QueryBuilder, boolean) insteadInterface for a class that can transform a
SQLQuery into another.Builds the database-level WHERE query from the AST, and collects parameters associated to free variables along with
the database column to which they correspond.
Compatibility component to register old-style VCS repository extension points.
Service holding the configuration for VCS repositories.
An MBean to manage SQL storage repositories.
This class is the bridge between the Nuxeo SPI Session and the actual low-level implementation of the SQL storage
session.
This class represents a session against an SQLDirectory.
A SQL statement and some optional tags that condition execution.
Collects a list of strings.
Tags that may condition execution of the statement.
Implementation of the versioning service that follows standard checkout / checkin semantics.
Allow administrators to toggle runtime standby mode.
Servlet redirecting to the startup page after form authentication from login.jsp, depending on the
LoginScreenConfig/LoginStartupPage contributions to the loginScreen extension point.Starts the workflow with the given model id on the input documents.
Abstraction for a Map<String, Serializable> that is Serializable.
A diff for an array or
List.A diff for a
State.Basic interface to get/put simple values or arrays from a state object.
Helpers for deep copy and deep diff of
State objects.Statement interface.
Statement with subject, predicate and object.
Returns a static result list of identifiers.
Scroll Request for a static result set.
Static / Hardcoded Mapper implementation (in case
UserMapperService is not available)HTTP Invoker that notes the last status returned.
Servlet for retrieving Nuxeo services running status.
Deprecated.
since 11.4: use dropwizard metrics timer instead
Deprecated.
since 11.4: use dropwizard metrics timer instead
Class representing an entry stored in the
TransientStore.Raised if something goes wrong with the storage
Implementation of the
Rendition interface for rendition that are stored in the RepositoryManages
StoredRenditions on behalf of the RenditionService.Descriptor for a stored rendition manager.
Converter to extract a list of equally spaced JPEG thumbnails to represent the story-line of a movie file using the
ffmpeg commandline tool.
Object representing a Stream of a video.
An events collector that write log entries as json record into a stream.
Computation that consumes a stream of Json log entries and write them to the Directory Audit Storage.
Computation that consumes a stream of log entries and write them to the audit backend.
A Processor that clean repository on document deletion.
Helper class to define different log names used in nuxeo-importer-stream and utility methods to get
codecs.A computation that reads processor and metrics streams to build a representation of stream activities in the cluster.
A processor to introspect Nuxeo Stream activities at the cluster level.
Gives access to StreamProcessor and appender for source provider.
A computation that exposes Nuxeo Stream metrics as Dropwizard metrics.
A Specialized Nuxeo Metrics Reporter that sends only Nuxeo Stream metrics into a Stream.
A processor fetching stream metrics populating Dropwizard metrics.
A Dropwizard Metrics Reporter that sends metrics into a Nuxeo Stream.
A non retry-able exception to bypass the Stream Retry Policy.
Nuxeo Stream Introspection endpoint
A probe to detect when computation has been terminated due to failure.
Run a topology of computations according to some settings.
A Pub/Sub provider based on Nuxeo Stream.
A named stream used to be able to deploy new components without referring to them via URLs.
Stream servlet
WorkManager impl that appends works into a Log.
Blob based on a string.
A string list can be used as an injectable parameter when a list of strings is required.
Finds the strings in a document (string properties).
The string type.
Utils for String manipulations.
Subject interface to identify subject nodes: resources and blank nodes.
Operation to subscribe a user to the notifications of one or more of documents.
Encapsulates all notification storage logic in the Notifiable facet.
Simple Wrapper to add label computation to the
SubscriptionStatusType view to display a given document sub-type.
Deprecated.
Since 11.5, use the SubtypesJsonEnricher in org.nuxeo.ecm.platform.types instead.
Enrich
DocumentModel JSON object with an array of the document types that can be created under the current
document taking account the local configuration.Constants used to generate JSON for suggestion in operations.
SuggestDirectoryEntries Operation
XMap descriptor for registering overridable parameterized Suggester implementation on the SuggesterService.
XMap descriptor for registering suggester names in a suggesterGroup contribution.
Base class for building data transfer objects for results of requests to the SuggestionService.
Base class and default implementation for passing contextual information to the suggestion service.
Exception raised when a suggester cannot perform it's suggestion due to inconsistent configuration or problem when
calling a backend service: in that case the backend service exception should be wrapped as the cause.
XMap descriptor for registering overridable suggestion handlers (individual operations or named chains of
operations).
Exception raised when the SuggestionService is unable to execute the selected suggestion.
Pluggable service to generate user action suggestions based on text input and contextual data.
The Class SuggestionServiceImpl.
Operation used to suggest result by getting and calling all the suggesters defined in contributions.
SuggestUser Operation.
A registry which is inheriting values from super keys.
Annotation used to define mimetypes supported by a marshaller class.
CUP generated interface containing symbol constants.
Data transfer object to fetch the list of references of synchronization roots for a given repo and user.
A SQL table.
An alias for an existing table.
The basic implementation of a SQL table.
Descriptor for SQL directory reference.
Helper to provide SQL migration calls while adding a column.
The tag constants.
Listener that copy tags applied on the live document to a version or proxy of this document or replace the existing
tags on a live document by the ones on the version being restored.
Query Maker specialized for tagging queries that need joins.
The Tag Service interface.
the tag component.
Enricher that add the tags associated to the document.
Output the last records on a Log.
Represents a target (platform or package).
Common descriptor for target packages/platforms.
Target implementation relying on an original implementation, useful for override when adding additional
metadata.A TargetExtensions is part of PartialDeploy annotation that is able to deploy only a subset of extensions in a
bundle.
White list
TargetExtensions.ContentModel and Automation related contributionsWhite list contributions: TypeService schema and doctype definition, LifecycleService lifecycle and associated
types, SQLDirectoryFactory directories and VersioningService versioning rules.
White list
TargetExtensions.ContentModel and ContentTemplateServiceCommon class to describe a target platform or package.
Represents a target info (platform or package).
TargetInfo implementation relying on an original implementation, useful for override when adding additional
metadata.Represents a target package.
Descriptor for target package contributions.
TargetPackage implementation relying on an original implementation, useful for override when adding
additional metadata.Represents a target package info, useful for listing of available target packages.
Describes a target package
Registry for target package contributions, handling merge on "enabled" attribute only.
Main interface for target platform definition of resources that need to be available both on core and client sides.
Descriptor for target platform contributions.
TargetPlatform implementation relying on an original implementation, useful for override when adding
additional metadata.Interface to represent filtering on target platforms.
Filter of target platforms handling enabled, deprecated, restricted and type criteria.
Represents a target platform info, useful for listing of available target platforms.
Describe a target platform: name, version
Main interface for target platform instance, holding resources that need to be available on client sides.
TargetPlatform implementation relying on an original implementation, useful for override when adding
additional metadata.This filter accepts input data that is accepted by at least one of its filters.
Registry for target platform contributions, handling merge on "enabled" attribute only.
Service for target platforms and packages management.
TargetPlatformService implementation relying on runtime extension points.Helper class for dealing with task actors.
Describe an install / uninstall task
Listener that will launch another operation when a task is accepted or rejected
Event identifiers.
Helper for notifying task related events.
The task service handle document based Tasks.
The variable used as process instance variables.
Wraps the list of
GraphNode.TaskInfo on a GraphNode to expose in a pretty way information to MVEL
scripts.Pluggable
DocumentAdapterFactory used to return the right TemplateBasedDocument or
TemplateSourceDocument implementation according to given DocumentModel.Adapter interface for the
DocumentModel that support rendering via a Template.Default implementation of
TemplateBasedDocument adapter.The activator expand the sample documents in the data directory.
Listener to manage initialization :
of the TemplateSourceDocument : init the parameters
of the other DocumentModels if they need to be automatically associated to a template
Represents input parameters of a Template.
Template item descriptor.
Interface used to drive rendition of the
TemplateBasedDocumentRuntime Component used to handle Extension Points and expose the
TemplateProcessorService interfaceThis is the service interface to manage
TemplateProcessor and associated templates.This class contains the Serialization/Deserialization logic.
Service Exposing serializer and deserializer used to manipulate template rendering data to be injected in the
rendition context.
It is mainly the source used by
TemplateBasedDocument to handle the rendering.Default implementation of
TemplateSourceDocument.Template for compatibility with Nuxeo WebEngine
A view to be used by regular JAX-RS resources to be able to use freemarker templates.
Listeners invalidating the principals cache when the tenant administrators are changed.
Test for
LogFeature.Ensures that all log levels are preserved before launching the whole class test
RunnerFeature.beforeRun(FeaturesRunner) and correctly restored after that
which means after the execution of RunnerFeature.afterRun(FeaturesRunner)A runtime service used for JUnit tests.
Text template processing.
Append the watermark at the end of text file
Service handling the mapping between a page and its resources and flavors.
Default implementation for the
ThemeStylingServiceRuntime events that be fired once a thread is about to enter in the nuxeo runtime or leave it.
ThreadEvent handler that should be implemented by consumers.Wrap a
ThreadEventHandler for being enlisted in the EventService.Object wraping a 3D file
Blob, resources and transmission versions.Listener cleaning batch date when batch update is scheduled.
Listener batch updating transmission formats and renders if the main Blob has changed.
Simple data transfer object to report on the state of a 3D content work or conversion
Work running batch conversions to update 3D document type preview assets
Interface for document adapter wrapping a 3D document.
Default implementation of
ThreeDDocument.Factory instantiating
ThreeDDocument adapter.Constants regarding 3D document type.
Object containing info about a 3D content
Object wraping a 3D render view
Blob, spherical coordinates and title.Provides rendition definitions based on the existing render views and transmission formats.
Service to asynchronously launch and monitor 3D format conversions (including lod) and rendering.
Default implementation of
ThreeDServiceThumbnail adapter getting thumbnail blob from thumbnail registered factories
Audio thumbnail factory
Converter bean managing the thumbnail conversion for picture documents
Default thumbnail factory for all non folderish documents Return the main blob converted in thumbnail or get the
document big icon as a thumbnail
XMap descriptor for contributed thumbnail factories.
Helper to create document thumbnail if necessary.
Enrich
DocumentModel Json.Picture thumbnail factory
Deprecated.
since 11.1.
Thumbnail service providing 3 kind of factories: by facet, by doctype, and thumbnail default one
3D content thumbnail factory
Movie thumbnail factory
Interface for services that need to track when the resources they hold have been last modified.
Table of contents model.
Build the Table of Contents of a wiki page
Exception thrown when an error occurs in the
TokenAuthenticationService.Service to manage generation and storage of authentication tokens.
Default implementation of the
TokenAuthenticationService.Servlet that allows to get a unique authentication token given the request Principal and some device information
passed as request parameters: application name, device id, device description, permission.
Handles authentication with a token sent as a request header.
Configurator for an embedded Tomcat server.
Exception thrown by
FileSystemChangeFinder when too many document changes are found in the audit logs.Interface for the classes contributed to the
topLevelFolderItemFactory extension point of the
FileSystemItemAdapterService.XMap descriptor for factories contributed to the
topLevelFolderItemFactory extension point of the
FileSystemItemAdapterService.Registry for
topLevelFolderItemFactory contributions.Represent a Directed Acyclic Graph (DAG) of computations.
Automation Abstract tracer recording all automation execution traces.
Add some tags to span created by OcHttpServletFilter
Track consumer positions so they can be restored in case of fail-over
Transactional Blob Store.
Transient data recording operations applied to a blob, to be executed on the permanent store at commit time.
Annotation for
TransactionalFeature configuration.The transactional feature is responsible of transaction management.
Alternative to the default
DocumentPipe that handles Transactions demarcation aligned with the Pipe batch
sizeUtilities to work with transactions.
Reified checked errors caught while operating the transaction.
Object wrapping a transcoded video and related
VideoInfo.Transforms the message using the transformer and puts it in the context under transformed.
Component exposing the
TransientStoreService and managing the underlying extension pointSimple Listener used to GC Work for
TransientStoresService Interface for managing a transient store.
XMap descriptor for representing the Configuration of a TransientStoreFilter that use a Transient Store to pass big record value.
Transient Store SPI.
Service to expose access to
TransientStoreA work allowing to store a result in the
TransientStore.Object wrapping a transmission format with
ThreeD and LoD detailsProvides a rendition based on a 3d transmission format (referenced through the rendition definition lod).
Migrator of trashed state.
Info about the deletion/purge/undeletion of a list of document.
Service containing the logic about deleting/purging/undeleting a document.
Deprecated.
since 10.2, use
TrashService instead.Features of the implementation of the service.
Comment service implementation.
Helper to create tree structure based on date
A tree view manage a tree structure of items.
A Type object is used to describe some ECM content.
An object that can adapt a given object instance to an object of another type A type adapter accepts only one type of
objects and can produce only one type of object.
Helper for type adapters
UI type action compatibility descriptor from category action
This constraint ensures some object's is supported by some
Type.A representation for an exported document aware of property types.
Type representation access via document adapter
Service handling registered UI Types.
Manages a type system for a repository.
A provider of types (schemas, document types, facets).
The TypeService is the component dealing with registration of schemas and document types (and facets and prefetch
configuration).
Type view to display a given document type view.
Simple POJO to store pre-processed comment and associated document.
Common interface for UID generators.
Service that writes MetaData.
UID generator configuration holder.
UID entity - keeps last indexes of all generated UIDs.
UID Sequencer interface defines a method to retrieve next ids based on a given key.
Local configuration class to handle configuration of UI Types.
Default implementation of
UITypesConfiguration.Factory creating the
UITypesConfigurationAdapter adapter if the document has the
UITypesLocalConfiguration facet.Listener validating that the selected default type is part of the allowed type on the document.
Operation unblocking permission inheritance on a given ACL.
Minimal eventContext implementation that can be used for events that are not bound to a CoreSession.
Wrapper used because some consumer (SAX parser) tend to close the stream
Undeploy a runtime bundle, or a directory containing runtime bundles.
Undeploys runtime configuration files to the framework.
Install bundle, flush any application cache and perform Nuxeo preprocessing on the bundle.
Install bundle, flush any application cache and perform Nuxeo preprocessing on the bundle.
A
Mapper that uses a UnifiedCachingRowMapper for row-related operation, and delegates to the
Mapper for others.A
RowMapper that use an unified ehcache.Provides REST bindings for
Package install management.Un-Deploy an OSGi bundle from the running platform.
Resource for an unknown (ie non-existing) object.
Install bundle, flush any application cache and perform Nuxeo preprocessing on the bundle.
When a document is unlocked in Nuxeo, removes any related WOPI lock.
Unpublish all publications of the document.
PlaceHolder for Unregistered instances
Helper class to run code with an unrestricted session.
Operation to unsubscribe a user to the notifications of one or more of documents.
An
UPDATE statement.Listener triggering the work updating ACE status.
Work updating ACE status.
Live version of the update command, that handle hot-reloading of the jar by deploying it to the runtime.
Updates the number of comments stored on the
DocumentRouteStep.Updates entries for a given
Directory.Manage jar versions update.
Action to update the Read ACLs on a list of documents, without recursion.
Thumbnail listener handling creation and update of thumbnail preview on main blob update, for documents holding the
schema "file".
Helper class to parse a URI or build one given parameters.
Blob backed by a URL.
Reads
ExecutionRequest from a urlencoded POST (Needed for OAuth calls)Interface to expose user model fields
A class that exposes the fields from user schema
Helper class to detect Html5 Dnd compliant browsers based on the User Agent string
A class containing the configuration of an user principal instance.
A user name, and a set of permissions granted/denied.
Perform a lookup by name query on the UserManager service and suggest to navigate to the top user and / or group
profiles matching that query.
Encapsulates some information about a user and how it must be authenticated.
Helper class to get java runtime owner user id
Carries user information encoded inside an x509Name.
Simple operation to invite a User.
Provides user local stored in profile doc model
APG-240 All attributes are defined public because the user manager service do not get access to the fields.
Standard implementation of the Nuxeo UserManager.
This
ObjectResolver allows to manage integrity for fields containing group or user references.UserManager implementation that is aware of ComputedGroup.Interface for class providing a named implementation for the
UserMapperServiceUserResolver implementation that uses the
UserMapperServiceComponent to manage extension point and expose the
UserMapperService interface.XMap descriptor for contributing
UserMapper pluginsfactory to get the Mapper implementation
UserResolver implementation that uses the
UserMapperServiceThis service allows to map Nuxeo Users with users coming from external system like SSO or IDM.
Configurable Group Computer based on metadata of the user.
Implementations of this interface manages the multi-tenant behavior for UserManager.
Interface that must be extended by other interface representing user preferences.
NuxeoPrincipal stub implementation.
A service to manage user profiles
Implementation of
UserProfileService.Extract a real interface for resolving SAML users to Nuxeo Users
Handles marshaling for SCIM
UserResourceHandles marshaling for SCIM
UserResourceHelper for handling SCIM
UserResourceUsed to store user session.
Page provider listing users.
Suggest to navigate to a specific user profile.
User workspace based implementation of
FileSystemItemFactory for the parent FolderItem of the user's
synchronization roots.User workspace based implementation of the parent
FolderItem of the user's synchronization roots.Page provider for
DashBoardItem elements.Operation to retrieve the tasks waiting for the current user.
Enrich
DocumentModel Json.Simple operation to get the User's personal Workspace
Uses
FileManager to import files inside the User's personal workspace.User workspace manager actions business interface.
User workspace service class that is used to get the document model for the personal workspace of the current user.
This component is used to register the service that provide the userworkspace service support.
User workspace based implementation of
FileSystemItemFactory for a synchronization root FolderItem.User workspace based implementation of
FileSystemItemFactory for the parent FolderItem of the user's
synchronization roots.User workspace based implementation of the synchronization root parent
FolderItem.User workspace based implementation of the
TopLevelFolderItemFactory.User workspace based implementation of the top level
FolderItem.Provides utility functions in support of CAS clients.
Utility functions.
Some helper methods for parsing configuration and loading contributed servlets or filters.
Tag for indicating CAS's "validate URL" for the cas:auth tag.
Validation violation interface which serves a message key to be translated.
Validators rule API.
Validators rule descriptor.
Exporter for a document's values into a map.
Yet Another variable resolver.
Encapsulates cluster node VCS invalidations management.
A set of invalidations.
Propagator of invalidations to a set of
VCSInvalidationsQueues.Queue of invalidations.
Manager of locks stored in the repository SQL database.
PubSub implementation of the VCS
VCSClusterInvalidator.Repository factory for VCS, the repository implements internal pooling of sessions.
The version correspond to a JAR version that is required by some package.
A version consists of three fields, denoting the major version, the minor version, and the update version.
This class composes a result of versioning interrogation about what increment options are available.
Exports version information for a given
DocumentModelDefines actions to be taken in a document versioning increment process.
Helper class to send versions change event notifications in the core.
Versioning service component and implementation.
Declares constants and methods used to control document versions mostly when a document is saved.
Adapter showing the versioning aspects of documents.
Adapter class factory for Versioning Document interface.
Interface for the Versioning Manager (a service).
Versions management component implementation.
The versioning options that can be requested when saving a document, or when doing a check in.
A versioning policy filter for automatic versioning system.
Descriptor to contribute new restrictions in versioning system.
Descriptor used to restrict versioning options for a given lifeCycleState
The versioning service holds the versioning policy used to define what happens to a document's version when it is
created, saved, checked in, checked out or restored, and what version increment options (none, minor, major) are made
available to the user.
Descriptor to contribute a new
VersioningService.Exception indicating that a version cannot be modified.
Interface for the policy that decides which versions have to be removed when a working document is removed.
Version Service - manage document versions TODO not yet implemented
Endpoint to manage the versions.
Veto not to send notification when a version is the source document of the event.
Object wrapping a video
Blob and related VideoInfo.Light synchronous listener that schedules an asynchronous work to process the video info of a document.
The
VideoTool that extracts closed captions.The
VideoTool that joins two or more video blobs.Video constants.
Object representing a registered video conversion on the
VideoService .ContributionFragmentRegistry to register VideoConversion.Generic video convert configured by converter parameters contributions.
Simple data transfer object to report on the state of a video conversion.
Work running a defined video conversion.
Interface for document adapter wrapping a Video document.
Default implementation of
VideoDocument.Factory instantiating
VideoDocument adapter.Helper class to factorize logic than can be either called from the UI or from core event listener.
This class will create a Document of type "Video" from the uploaded file, if the uploaded file matches any of the
mime types listed in the filemanager-plugins.xml file.
Object containing info about a video file.
Work to process the video info of a Video document and schedule two works to process the storyboard and conversions,
see
VideoStoryboardWork and VideoConversionWork.Provides rendition definitions based on the existing transcoded videos.
Provides a rendition based on a transcoded video
(referenced through the rendition definition name).
Service to asynchronously launch and monitor video conversions.
Default implementation of
VideoService.The
VideoTool for slicing video blobs.Work to process the storyboard of a Video document.
Common interface to setup the video tools.
Service that allows the execution of different operations in video blobs through the execution of
VideoTool.The
VideoToolsService default implementation for handling video blobs.The
VideoTool for adding a watermark to a video blob.Interface for the classes contributed to the
topLevelFolderItemFactory extension point of the
FileSystemItemAdapterService.Interface for a virtual user.
Descriptor for virtual users.
Usage:
Watermark represents a point in time.
Keep track of minimum and maximum watermark level.
HTTP constants.
This filter sets up the
WebContext, made available through WebEngine.getActiveContext().Injects the JAXBContext needed to parse our webdav XML payloads.
A web application configured by a module.xml file.
TODO remove old WebEngine references and rename WebEngine2 to WebEngine
WebEngine integration with OSGi JAX-RS model from ECR.
A web form is a single page wizard.
Entry point for jax-rs calls to the
LayoutStore service.Service for web resources retrieval.
Flush resources in web-app class loader, needed for resetting the i18n.
Generic descriptor for query where clause, accepting predicates and a fixed part.
Widget interface.
Widget definition interface.
Converter for a widget definition.
Default implementation for a widget definition.
Registry holding widget definitions (global widgets) for a given category
Widget definition descriptor.
Widget exception
Implementation for widgets.
Reference for a widget within a layout row.
Descriptor for a widget reference with a row.
Single select option top be held by the
WidgetDefinition and Widget generated from the definition.Multiple select options top be held by the
WidgetDefinition and Widget generated from the definition.Interface for widget type.
Widget configuration interface
Descriptor for a widget type configuration
Widget type definition
Compares widget types on id or label.
Model for a widget type definition on client side.
Registry holding widget type definitions for a given category.
Helper class representing a list of widget type definitions
Widget type descriptor.
Implementation for widget types.
Registry holding widget type instances for a given category.
Exports and presents documentation about widget type definitions
Copied from last version of wikimodel
Dynamic wiki text that is generated after the serialization end
Special writer used to split the serialization result in dynamic or static segments.
The implementation of
ESHintQueryBuilder for the "wildcard" Elasticsearch hint operator.Microsoft Extension property. http://msdn.microsoft.com/en-us/library/cc250142(PROT.10).aspx
Microsoft Extension property. http://msdn.microsoft.com/en-us/library/cc250143(v=PROT.10).aspx
Microsoft Extension property. http://msdn.microsoft.com/en-us/library/cc250144(v=PROT.10).aspx
Microsoft Extension property. http://msdn.microsoft.com/en-us/library/cc250145(v=PROT.10).aspx
Annotation that will help you to set the
Framework's property in your test by annotating method.Features handling
WithFrameworkProperty annotations.The following actions are available:
GET
POST next
POST ok
POST cancel
POST back
WOPI info for a given blob xpath.
Class used to parse a WOPI discovery XML file.
Refreshes the WOPI discovery.
Base class for the WOPI endpoint exceptions.
Exception mapper for the
WOPIExceptions.Gets the WOPI action URLs available for each blob of the document.
Security policy to allow collaborative edition with WOPI.
WOPI Service.
WordXML implementation of the
BidirectionalTemplateProcessor.A
Work instance gets scheduled and executed by a WorkManager .A progress report about a work instance.
The running state of a
Work instance.Output information of Work in a StreamWorkManager Queue.
A Stream computation that consumes works.
Endpoint to manage the worflows.
A
WorkManager executes Work instances asynchronously.The scheduling policy to use when adding a work instance using
WorkManager.schedule(Work, Scheduling).The implementation of a
WorkManager.Simple synchronizer to wake up when an in-JVM work is completed.
Executes Works stored in the dead letter queue after failure.
Descriptor for a
WorkManager queue configuration.Provides coherent queue metrics
Interface describing how the
WorkManager implements queuing.Descriptor for a
WorkManager queuing implementation configuration.Manage works from the JMX console
Work state helper to handle, out-of-API, distributed, work states.
Provides a way to create sub contexts of
RenderingContext to broadcast marshalled entities or state
parameters from a marshaller to other marshaller.Simple entry adaptor implementation that leaves the entry as editable if the specified field value matches the
provided regexp or set the readonly flag of the entry to true if the value of the field does not match the regexp.
Interface of Java type to mimetype converter.
An annotation that injects the content of the current node as an XML string or DocumentFragment depending on the
field type.
Injects an execution context property.
XDocReport based
TemplateProcessorXMap maps an XML file to a java object.
Exception during XMap processing.
An annotation to identify XMap annotations.
This class plays a role in the export pipe.It is used to generate xml files that have a nuxeo specific format.Each
file contains information about a document model such as,general information like name, uid or document type, and
information about the schemas that the document includes.
Writes to a file or output stream the XML corresponding to the document content.
Source Node filtering only Folder, XML and ZIP files.
Main Nuxeo Runtime component managing extension points and exposing
XMLImporterServiceInterface for importer service
Main implementation class for delivering the Import logic
FilenameFilter implemetation to skip files that are not descriptorsDeprecated.
TemplateInput parameters are stored in the DocumentModel as a single String Property via XML
Serialization.XML zip to text converter: parses the XML zip entries to read their content.
Loader of XSD schemas into Nuxeo Schema objects.
Value factories are used to decode values from XML strings.
YAML representer for automation chains.
Operation to YAML converter
Zip2Html converter.
Deprecated.
since 11.5, unused
Zip the content of a directory.
A
Blob backed by an entry in a ZIP file.InputStream for a ZIP entry, that closes all necessary resources when closed.Utility class to read
ZipFiles.Reports traces to Zipkin.
Previewer for Zip blobs.
A reader to read zip files.
Expose zPages endpoint to control tracing.
AbstractBlobGarbageCollectorinstead