All Classes

Class	Description
AbstractDocumentFileReader	Defines some generic features for the DefaultDocumentFileReader and JarDocumentFileReader.
AbstractStaticChecker	Has all the guts for doing static checking, but delegates the execution of an XQuery script to a subclass.
AdhocQueryCallback	Simple callback for executing an adhoc query.
AssetFileLoader	File loaded for "assets", as defined by the REST API - basically, any server module.
BaseModulesFinder	Abstract implementation that provides implementations for loading all the different kinds of modules.
BasicConfig	Provides a basic configuration for Spring-based applications.
BatchHandler	Allows for customizing what RestBatchWriter does with each batch of documents.
BatchWriter	Interface for writing batches of documents to pre-ML9 clusters (DMSDK can be used with ML9+).
BatchWriterSupport	Support class for BatchWriter implementations that uses Spring's TaskExecutor interface for parallelizing writes to MarkLogic.
BinaryExtensions
ClientHelper	The intent of this class is to provide some syntactic sugar on common operations using the ML Java API, which is a wrapper around the ML REST API.
CodeGenerationRequest
CollectionsDocumentFileProcessor	Adds the given collections to each DocumentFile that it processes.
CollectionsFileDocumentFileProcessor	Looks for a special file in each directory - defaults to collections.properties - that contains properties where the key is the name of a file in the directory, and the value is a comma-delimited list of collections to load the file into (which means you can't use a comma in any collection name).
ConfiguredDatabaseClientFactory	Hides how a DatabaseClient is constructed based on the inputs in a DatabaseClientConfig object.
DatabaseClientConfig	Captures all the possible inputs used to construct an instance of DatabaseClient.
DatabaseClientManager	Hooks into Spring container lifecycle so that the DatabaseClient is initialized when the container starts up and released when the container shuts down.
DatabaseClientProvider
DataMovementBatchWriter
DefaultBatchHandler	Default implementation of BatchHandler that uses a DocumentManager to write documents, along with an optional ServerTransform.
DefaultConfiguredDatabaseClientFactory	Default implementation for constructing a new instance of DatabaseClient based on the inputs in an instance of DatabaseClientConfig.
DefaultDocumentFileReader	Non-threadsafe implementation that implements FileVisitor as a way of descending one or more file paths.
DefaultDocumentFormatGetter	Default impl.
DefaultDocumentPermissionsParser
DefaultDocumentWriteOperationAdapter
DefaultExtensionMetadataProvider
DefaultFileFilter	Simple implementation that accepts every file and ignores anything starting with ".".
DefaultModulesFinder	Default implementation that loads all of the different kinds of REST modules.
DefaultModulesLoader	Default implementation of ModulesLoader.
DefaultSchemasLoader
DefaultTokenReplacer	Default implementation of TokenReplacer that relies on a list of PropertiesSource implementations for finding tokens to replace in text.
DefaultWorkspaceManager	Default implementation that uses the ML Java Client API to manage workspaces.
DefaultWriteListener
DocumentFile	Encapsulates a file that should be written to MarkLogic as a single document.
DocumentFileProcessor	Interface for processing - i.e.
DocumentFileReader	Strategy interface for determining which files to load into MarkLogic, with those files being captured as a List of DocumentFile objects.
DocumentPermissionsParser
DocumentWriteOperationAdapter	Interface for adapting a REST DocumentWriteOperation instance into an XCC Content instance.
EntityServicesManager	Handles loading a model and then making calls to generate code for it.
ExtDocumentFileProcessor	Appends "/ext" to assets loaded from the REST API-specific "/ext" directory.
ExtensionMetadataAndParams
ExtensionMetadataProvider
FileLoader	Interface for an object that can load files as documents from many paths.
FilenameUtil
FilePropertiesSource	Simple implementation of PropertiesSource that reads properties from a file.
FormatDocumentFileProcessor	Delegates to DefaultDocumentFormatGetter by default for determining what Format to use for the File in a given DocumentFile.
FormatGetter	Strategy interface for the Format that should be used when writing the given File as a document into MarkLogic.
GeneratedCode
GenericFileLoader	Generic implementation of FileLoader.
InsertContentCallback	Simple callback for inserting a single document.
JarDocumentFileReader	Implementation of DocumentFileReader for reading documents in a JAR file.
LoadedAsset
LoadModulesFailureListener	This is just for loading REST modules, which DefaultModulesLoader loads by default in parallel.
LoggingObject
Modules
ModulesFinder	Given a directory, return a Modules instance capturing all of the REST API modules to load.
ModulesLoader	Interface for objects that can load a set of modules via the REST API, which is intended to include not just what the REST API calls "assets" (regular modules), but also options, services, transforms, and namespaces.
ModulesManager	Defines operations for managing whether a module needs to be installed or not.
ModulesManagerDocumentFileProcessor
PermissionsDocumentFileProcessor	DocumentFileProcessor that uses a DocumentPermissionsParser to parse a string of permissions (typically, a delimited string of roles and capabilities) and adds them to each DocumentFile.
PermissionsFileDocumentFileProcessor	Looks for a special file in each directory - defaults to permissions.properties - that contains properties where the key is the name of a file in the directory, and the value is a comma-delimited list of role,capability,role,capability,etc.
PropertiesDrivenDocumentFileProcessor	Base class for processors that look for a special file in each directory and intend to perform some processing based on the contents of that file.
PropertiesModuleManager
PropertiesSource	Intent is to allow for a Properties object to be provided to DefaultTokenReplacer without that class knowing where the properties are retrieved from.
QconsoleScripts
ResourceExtension
ResourceManagerSupport
RestBatchWriter	REST API-based implementation, using the Java Client API.
RoxyTokenReplacer	Loads properties from typical Roxy locations of "deploy/default.properties", "deploy/build.properties", and "deploy/local.properties", if any of those exist.
SchemasLoader
SecurityContextType	The Authentication enum in marklogic-client-api was deprecated in 4.0.1, but this enum is useful in DatabaseClientConfig as a way of referencing a particular SecurityContext implementation to use.
SimpleDatabaseClientProvider
SimpleLoadModulesFailureListener
SimpleX509TrustManager	"Simple" in that it doesn't do anything.
SpringDatabaseClientConfig	Extends DatabaseClientConfig to apply 4 Value annotations for host/port/username/password.
SslConfig	Captures the output of functions in SslUtil so that they can be easily used when constructing a DatabaseClient, which requires the X509TrustManager to be an input separate from the SSLContext.
SslUtil
StaticChecker	Interface for performing static checks on a list of modules that have been loaded into MarkLogic already.
TdeDocumentFileProcessor
TestServerModulesFinder	Search options and REST properties are specific to a REST API server.
TokenReplacer	Interface for objects that replace implementation-defined tokens within a String of text, which typically will be the content of a document before it's written to MarkLogic.
TokenReplacerDocumentFileProcessor	Processor that delegates to a TokenReplacer for replacing tokens in the content of a DocumentFile.
WorkspaceManager	Interface for exporting and importing qconsole workspaces to/from disk.
WriteListener	Callback interface for when a list of DocumentWriteOperation instances cannot be written to MarkLogic.
WriteListenerSupport	WriteListener implementors should extend this to avoid issues when methods are added to WriteListener.
XccBatchWriter	XCC implementation for batched writes.
XccCallback<T>	Spring-style callback interface that provides an open Session to an implementation, which then doesn't have to worry about how to open or close the Session.
XccStaticChecker	XCC gives more information about a static check error - specifically, line-precise information - and the REST API does not by default.
XccTemplate	Spring-style Template class that handles instantiating an XCC Session and then closing it, allowing the Callback implementation to focus on what to do with the Session.