Package | Description |
---|---|
com.marklogic.client |
The package provides the core classes,
interfaces and exceptions for working with the database.
|
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.bitemporal | |
com.marklogic.client.datamovement |
The MarkLogic Data Movement SDK supports
long-running write, read, delete, or transform jobs.
|
com.marklogic.client.dataservices | |
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.eval | |
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.httpclient |
The package supports optional configuration of
the Open Source HttpClient library.
|
com.marklogic.client.extra.okhttpclient | |
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.pojo |
The goal of this package (sometimes referred to
as "the pojo facade" is to simplify working with custom Plain Old
Java Objects (pojos) without hassling with persistence
details.
|
com.marklogic.client.query |
The package provides classes for queries
including searching documents and reading values directly from
indexes in the database for the REST server.
|
com.marklogic.client.row |
The package provides classes for sending plan
requests to and processing row responses from the REST
server.
|
com.marklogic.client.semantics |
Class | Description |
---|---|
DatabaseClient |
A Database Client instantiates document and
query managers and other objects with shared access to a
database.
|
DatabaseClient.ConnectionResult | |
DatabaseClient.ConnectionType |
Identifies whether the client connects directly
to MarkLogic (the default) or by means of a gateway such as a load
balancer.
|
DatabaseClientBuilder |
Intended to support programmatically building a
DatabaseClient via chained "with" methods for setting
each possible input allowed for connecting to and authenticating
with MarkLogic. |
DatabaseClientFactory.Authentication |
Deprecated.
(as of 4.0.1) use BasicAuthContext, DigestAuthContext and KerberosAuthContext classes
|
DatabaseClientFactory.BasicAuthContext | |
DatabaseClientFactory.Bean |
A Database Client Factory Bean provides an
object for specifying configuration before creating a client to
make database requests.
|
DatabaseClientFactory.CertificateAuthContext | |
DatabaseClientFactory.ClientConfigurator |
A ClientConfigurator provides custom
configuration for the communication library used to sending client
requests and receiving server responses.
|
DatabaseClientFactory.DigestAuthContext | |
DatabaseClientFactory.HandleFactoryRegistry |
A HandleFactoryRegistry associates IO
representation classes with handle factories.
|
DatabaseClientFactory.KerberosAuthContext | |
DatabaseClientFactory.KerberosConfig | |
DatabaseClientFactory.MarkLogicCloudAuthContext | |
DatabaseClientFactory.SAMLAuthContext |
A SAMLAuthContext is used for authorization
using SAML.
|
DatabaseClientFactory.SAMLAuthContext.AuthorizerCallback |
A callback for getting a SAML assertions token
from the IDP (Identity Provider).
|
DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth |
ExpiringSAMLAuth is used by SAMLAuthContext when
renewing a SAML assertions token.
|
DatabaseClientFactory.SAMLAuthContext.RenewerCallback |
A callback for renewing the SAML assertions
token with the IDP (Identity Provider) by extending the expiration
time.
|
DatabaseClientFactory.SecurityContext | |
DatabaseClientFactory.SSLHostnameVerifier |
An SSLHostnameVerifier checks whether a hostname
is acceptable during SSL authentication.
|
DatabaseClientFactory.SSLHostnameVerifier.Builtin |
Builtin supports builtin implementations of
SSLHostnameVerifier.
|
FailedRequestException |
A FailedRequestException is used to capture and
report on problems from the REST API.
|
ForbiddenUserException |
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
|
MarkLogicServerException |
Abstract class that implements functionality for
errors returned from a MarkLogic REST API instance.
|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Class | Description |
---|---|
FailedRequestException |
A FailedRequestException is used to capture and
report on problems from the REST API.
|
ForbiddenUserException |
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
|
ResourceNotFoundException |
Exception thrown when the server responds with
HTTP status code 404.
|
ResourceNotResendableException |
Exception thrown when the server responds with
HTTP status code 503 and a Retry-After header of 1 but the request
is a PUT or POST and the payload is streaming.
|
Class | Description |
---|---|
FailedRequestException |
A FailedRequestException is used to capture and
report on problems from the REST API.
|
ForbiddenUserException |
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
|
ResourceNotFoundException |
Exception thrown when the server responds with
HTTP status code 404.
|
Class | Description |
---|---|
FailedRequestException |
A FailedRequestException is used to capture and
report on problems from the REST API.
|
ForbiddenUserException |
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
|
ResourceNotFoundException |
Exception thrown when the server responds with
HTTP status code 404.
|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Class | Description |
---|---|
DatabaseClient |
A Database Client instantiates document and
query managers and other objects with shared access to a
database.
|
DatabaseClient.ConnectionType |
Identifies whether the client connects directly
to MarkLogic (the default) or by means of a gateway such as a load
balancer.
|
Class | Description |
---|---|
DatabaseClient |
A Database Client instantiates document and
query managers and other objects with shared access to a
database.
|
SessionState |
Identifies a server state for sharing across
multiple calls to server endpoints.
|
Class | Description |
---|---|
FailedRequestException |
A FailedRequestException is used to capture and
report on problems from the REST API.
|
ForbiddenUserException |
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
|
MarkLogicIOException |
An IO Exception indicates that there was a
problem on input or output (similar to a java.lang.IOException but
defined as a runtime rather than checked exception).
|
Page |
A generic interface for pagination through large
sets of items of type <T>.
|
ResourceNotFoundException |
Exception thrown when the server responds with
HTTP status code 404.
|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Class | Description |
---|---|
FailedRequestException |
A FailedRequestException is used to capture and
report on problems from the REST API.
|
ForbiddenUserException |
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Class | Description |
---|---|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Class | Description |
---|---|
DatabaseClientFactory.ClientConfigurator |
A ClientConfigurator provides custom
configuration for the communication library used to sending client
requests and receiving server responses.
|
Class | Description |
---|---|
DatabaseClientFactory.ClientConfigurator |
A ClientConfigurator provides custom
configuration for the communication library used to sending client
requests and receiving server responses.
|
DatabaseClientFactory.SecurityContext |
Class | Description |
---|---|
DatabaseClientFactory.HandleFactoryRegistry |
A HandleFactoryRegistry associates IO
representation classes with handle factories.
|
Class | Description |
---|---|
FailedRequestException |
A FailedRequestException is used to capture and
report on problems from the REST API.
|
ForbiddenUserException |
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
|
Page |
A generic interface for pagination through large
sets of items of type <T>.
|
ResourceNotFoundException |
Exception thrown when the server responds with
HTTP status code 404.
|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Class | Description |
---|---|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Class | Description |
---|---|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Class | Description |
---|---|
FailedRequestException |
A FailedRequestException is used to capture and
report on problems from the REST API.
|
ForbiddenUserException |
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
|
ResourceNotFoundException |
Exception thrown when the server responds with
HTTP status code 404.
|
Transaction |
Identifies and provides methods to complete a
transaction.
|
Copyright © 2022 MarkLogic Corporation