Package com.marklogic.client

The package provides the core classes, interfaces and exceptions for working with the database.

See: Description

Interface Summary

Interface	Description
DatabaseClient	A Database Client instantiates document and query managers and other objects with shared access to a database.
DatabaseClientFactory.ClientConfigurator<T>	A ClientConfigurator provides custom configuration for the communication library used to sending client requests and receiving server responses.
DatabaseClientFactory.HandleFactoryRegistry	A HandleFactoryRegistry associates IO representation classes with handle factories.
DatabaseClientFactory.SecurityContext
DatabaseClientFactory.SSLHostnameVerifier	An SSLHostnameVerifier checks whether a hostname is acceptable during SSL authentication.
Page<T>	A generic interface for pagination through large sets of items of type <T>.
Transaction	Identifies and provides methods to complete a transaction.

Class Summary

Class	Description
DatabaseClientFactory	A Database Client Factory configures a database client for making database requests.
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.DigestAuthContext
DatabaseClientFactory.KerberosAuthContext
DatabaseClientFactory.SSLHostnameVerifier.Builtin	Builtin supports builtin implementations of SSLHostnameVerifier.
RequestConstants	The RequestConstants class provides constants for the common namespace prefixes and URIs used in the Java API (similar to the XML constants provided by the javax.xml.XMLConstants class).

Enum Summary

Enum	Description
DatabaseClientFactory.Authentication	Deprecated (as of 4.0.1) use BasicAuthContext, DigestAuthContext and KerberosAuthContext classes

Exception Summary

Exception	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.
MarkLogicBindingException	A Binding Exception indicates a problem converting between a Java object and XML representation of the data.
MarkLogicInternalException	An InternalException suggests a defect in the API.
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).
MarkLogicServerException	Abstract class that implements functionality for errors returned from a MarkLogic REST API instance.
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.
UnauthorizedUserException	An Unauthorized User Exception indicates the user is not recognized by the server.

Package com.marklogic.client Description

The package provides the core classes, interfaces and exceptions for working with the database. Use DatabaseClientFactory.newClient() to create a DatabaseClient object. Use the Client object to create document managers for reading, writing, and deleting documents, QueryOptionsManager to write configuration options for queries, and QueryManager to execute queries.

The list of exceptions in this package enumerate the ways in which a REST server request can go wrong.