Package com.marklogic.client

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.

Interface Summary

Interface	Description
DatabaseClient	A Database Client instantiates document and query managers and other objects with shared access to a database.
DatabaseClient.ConnectionResult
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.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.
Page<T>	A generic interface for pagination through large sets of items of type <T>.
SessionState	Identifies a server state for sharing across multiple calls to server endpoints.
Transaction	Identifies and provides methods to complete a transaction.

Class Summary

Class	Description
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	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.KerberosConfig
DatabaseClientFactory.MarkLogicCloudAuthContext
DatabaseClientFactory.SAMLAuthContext	A SAMLAuthContext is used for authorization using SAML.
DatabaseClientFactory.SSLHostnameVerifier.Builtin	Builtin supports builtin implementations of SSLHostnameVerifier.
DatabaseClientFactory.SSLHostnameVerifier.HostnameVerifierAdapter	HostnameVerifierAdapter verifies the hostname,SSLSession and X509Certificate certificate.
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
DatabaseClient.ConnectionType	Identifies whether the client connects directly to MarkLogic (the default) or by means of a gateway such as a load balancer.
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.
FailedRetryException	A FailedRetryException is used to capture and report when retry of the request timed out or failed in some other way.
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.