Package | Description |
---|---|
com.marklogic.client.admin |
The package provides the classes for configuration and initialization
of the REST server.
|
com.marklogic.client.alerting |
A REST interface to MarkLogic alerting capabilities.
|
com.marklogic.client.document |
The package provides classes for creating, retrieving, updating, and deleting
documents in the database for the REST server.
|
com.marklogic.client.example.extension |
The package provides examples of extensions that operate on a batch
of database documents.
|
com.marklogic.client.example.handle |
The package provides examples of extensions that read or write database documents
in a new way or with a new representation.
|
com.marklogic.client.extensions |
The package provides base and support classes so you can derive
a new Resource Manager to provide a client interface for a
Resource Services extension on the REST server.
|
com.marklogic.client.extra.dom4j |
The package provides an adapter for using the dom4j Open Source library
to read and write XML documents, XML structured search, and other XML
data structures.
|
com.marklogic.client.extra.gson |
The package provides an adapter for using the GSON Open Source library
to read and write JSON documents, JSON structured search, and other JSON
input and output.
|
com.marklogic.client.extra.jackson |
The package provides an adapter for using the Jackson Open Source library
to read and write JSON documents, JSON structured search, and other JSON
input and output.
|
com.marklogic.client.extra.jdom |
The package provides an adapter for using the JDOM Open Source library
to read and write XML documents, XML structured search, and other XML
data structures.
|
com.marklogic.client.extra.xom |
The package provides an adapter for using the XOM Open Source library
to read and write XML documents, XML structured search, and other XML
data structures.
|
com.marklogic.client.io |
The package provides the handle classes with different representations for document content
when you read documents from the database or write documents to the database.
|
com.marklogic.client.io.marker |
The package provides marker interfaces for reading and writing each kind of document format.
|
Modifier and Type | Method and Description |
---|---|
void |
ExtensionLibrariesManager.write(ExtensionLibraryDescriptor libraryDescriptor,
AbstractWriteHandle contentHandle)
Writes the contents of a handle to the provided path on the REST server.
|
void |
ExtensionLibrariesManager.write(String libraryPath,
AbstractWriteHandle contentHandle)
Writes the contents of a handle to the provided path on the REST server.
|
Modifier and Type | Class and Description |
---|---|
class |
RuleDefinition
A RuleDefinition represents a set of criteria that describe a named condition.
|
Modifier and Type | Interface and Description |
---|---|
interface |
DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>
A Document Manager provides database operations on a document.
|
Modifier and Type | Interface and Description |
---|---|
static interface |
DocumentMetadataPatchBuilder.PatchHandle
A PatchHandle produced by the builder can produce a string
representation of the patch for saving, logging, or other uses.
|
Modifier and Type | Method and Description |
---|---|
BatchManager.BatchRequest |
BatchManager.BatchRequest.withWrite(String uri,
AbstractWriteHandle content) |
BatchManager.BatchRequest |
BatchManager.BatchRequest.withWrite(String uri,
DocumentMetadataHandle metadata,
AbstractWriteHandle content) |
Modifier and Type | Class and Description |
---|---|
class |
HTMLCleanerHandle
An HTMLCleaner Handle writes an HTML document to the database
as an XHTML document.
|
class |
URIHandle
A URI Handle sends read document content to a URI or
receives written database content from a URI.
|
Modifier and Type | Method and Description |
---|---|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
R output)
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
String... mimetypes)
Applies multiple content by calling a POST service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
Transaction transaction,
R output)
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
Transaction transaction,
String... mimetypes)
Applies multiple content by calling a POST service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input,
R output)
Writes multiple content by calling a PUT service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input,
Transaction transaction,
R output)
Writes multiple content by calling a PUT service.
|
Modifier and Type | Method and Description |
---|---|
<R extends AbstractReadHandle> |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
R output)
Applies content by calling a POST service.
|
ResourceServices.ServiceResultIterator |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
String... mimetypes)
Applies multiple content by calling a POST service.
|
<R extends AbstractReadHandle> |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
R output)
Applies content by calling a POST service.
|
ResourceServices.ServiceResultIterator |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
String... mimetypes)
Applies multiple content by calling a POST service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
R output)
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
String... mimetypes)
Applies multiple content by calling a POST service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
Transaction transaction,
R output)
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
Transaction transaction,
String... mimetypes)
Applies multiple content by calling a POST service.
|
<R extends AbstractReadHandle> |
ResourceServices.put(RequestParameters params,
AbstractWriteHandle input,
R output)
Writes content by calling a PUT service.
|
<R extends AbstractReadHandle> |
ResourceServices.put(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
R output)
Writes content by calling a PUT service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input,
R output)
Writes multiple content by calling a PUT service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input,
Transaction transaction,
R output)
Writes multiple content by calling a PUT service.
|
Modifier and Type | Class and Description |
---|---|
class |
DOM4JHandle
A DOM4JHandle represents XML content as a dom4j document for reading or writing.
|
Modifier and Type | Class and Description |
---|---|
class |
GSONHandle
A GSONHandle represents JSON content as a GSON JsonElement for reading or
writing.
|
Modifier and Type | Class and Description |
---|---|
class |
JacksonHandle
A JacksonHandle represents JSON content as a Jackson JsonNode for reading or
writing.
|
Modifier and Type | Class and Description |
---|---|
class |
JDOMHandle
A JDOM Handle represents XML content as a JDOM document for reading or writing.
|
Modifier and Type | Class and Description |
---|---|
class |
XOMHandle
A XOM Handle represents XML content as a XOM document for reading or writing.
|
Modifier and Type | Class and Description |
---|---|
class |
BytesHandle
A Bytes Handle represents document content as a byte array for reading or writing.
|
class |
DocumentMetadataHandle
A DocumentMetadataHandle represents the metadata for a database document
as a POJO (Plain Old Java Object).
|
class |
DOMHandle
A DOM Handle represents XML content as a DOM document for reading or writing.
|
class |
FileHandle
A File Handle represents document content as a file for reading or writing.
|
class |
InputSourceHandle
An Input Source Handle represents XML content as an input source for reading or writing.
|
class |
InputStreamHandle
An Input Stream Handle represents a resource as an input stream for reading or writing.
|
class |
JAXBHandle<C>
A JAXB Handle roundtrips a POJO (a Java data structure) to and from a database document.
|
class |
OutputStreamHandle
An OutputStreamHandle generates output during writing.
|
class |
QueryOptionsHandle
Deprecated.
Use a JSON or XML
write handle or
read handle
implementation instead of this class to write or read
query options. For instance:
or
|
class |
ReaderHandle
A Reader Handle represents a character content as a reader
for reading to or writing from the database.
|
class |
SourceHandle
A Source Handle represents XML content as a transform source for reading
or transforms a source into a result for writing.
|
class |
StringHandle
A String Handle represents document content as a string for reading or writing.
|
class |
XMLEventReaderHandle
An XML Event Reader Handle represents XML content as an XML event reader
for reading as a series of StAX events.
|
class |
XMLStreamReaderHandle
An XML Stream Reader Handle represents XML content as an XML stream reader
for reading as a StAX pull stream.
|
Modifier and Type | Interface and Description |
---|---|
interface |
BinaryWriteHandle
A Binary Write Handle can represent binary content written to the database.
|
interface |
ContentHandle<C>
A Content Handle provides get / set access to a representation
of content such a byte[] array, input stream, file, reader, string,
and so on.
|
interface |
DocumentMetadataWriteHandle
A Document Metadata Write Handle can represent document metadata written to the database.
|
interface |
DocumentPatchHandle
A Document Patch Handle can represent a patch with changes
to document metadata or structured content.
|
interface |
GenericWriteHandle
A Generic Write Handle can represent content of an unknown format written to the database.
|
interface |
JSONWriteHandle
A JSON Write Handle can represent JSON content written to the database.
|
interface |
QueryOptionsWriteHandle
A QueryOptionsWriteHandle represents a query options node to be written to the server configuration.
|
interface |
RuleWriteHandle |
interface |
StructureWriteHandle
A Structure Write Handle can represent a data structure written to the database.
|
interface |
TextWriteHandle
A Text Write Handle can represent text content written to the database.
|
interface |
XMLWriteHandle
A XML Write Handle can represent XML content written to the database.
|
Copyright © 2013-2015 MarkLogic Corporation.