com.marklogic.client

Class DatabaseClientFactory

java.lang.Object

com.marklogic.client.DatabaseClientFactory

public class DatabaseClientFactory
extends Object

A Database Client Factory configures a database client for making database requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseClientFactory.Authentication Deprecated. (as of 4.0.1) use BasicAuthContext, DigestAuthContext and KerberosAuthContext classes
static class	DatabaseClientFactory.BasicAuthContext
static class	DatabaseClientFactory.Bean A Database Client Factory Bean provides an object for specifying configuration before creating a client to make database requests.
static class	DatabaseClientFactory.CertificateAuthContext
static interface	DatabaseClientFactory.ClientConfigurator<T> A ClientConfigurator provides custom configuration for the communication library used to sending client requests and receiving server responses.
static class	DatabaseClientFactory.DigestAuthContext
static interface	DatabaseClientFactory.HandleFactoryRegistry A HandleFactoryRegistry associates IO representation classes with handle factories.
static class	DatabaseClientFactory.KerberosAuthContext
static interface	DatabaseClientFactory.SecurityContext
static interface	DatabaseClientFactory.SSLHostnameVerifier An SSLHostnameVerifier checks whether a hostname is acceptable during SSL authentication.

Method Summary

Modifier and Type	Method and Description
static void	addConfigurator(DatabaseClientFactory.ClientConfigurator<?> configurator) Adds a listener that provides custom configuration when a communication library is created.
static void	clearHandleRegistry() Removes the current registered associations so the handle registry is empty.
static DatabaseClientFactory.HandleFactoryRegistry	getHandleRegistry() Returns the default registry with factories for creating handles as adapters for IO representations.
static DatabaseClient	newClient(String host, int port) Creates a client to access the database by means of a REST server without any authentication.
static DatabaseClient	newClient(String host, int port, DatabaseClientFactory.SecurityContext securityContext) Creates a client to access the database by means of a REST server.
static DatabaseClient	newClient(String host, int port, String database) Creates a client to access the database by means of a REST server without any authentication.
static DatabaseClient	newClient(String host, int port, String database, DatabaseClientFactory.SecurityContext securityContext) Creates a client to access the database by means of a REST server.
static DatabaseClient	newClient(String host, int port, String user, String password, DatabaseClientFactory.Authentication type) Deprecated. (as of 4.0.1) use newClient(String host, int port, SecurityContext securityContext)
static DatabaseClient	newClient(String host, int port, String user, String password, DatabaseClientFactory.Authentication type, SSLContext context) Deprecated. (as of 4.0.1) use newClient(String host, int port, SecurityContext securityContext)
static DatabaseClient	newClient(String host, int port, String user, String password, DatabaseClientFactory.Authentication type, SSLContext context, DatabaseClientFactory.SSLHostnameVerifier verifier) Deprecated. (as of 4.0.1) use newClient(String host, int port, SecurityContext securityContext)
static DatabaseClient	newClient(String host, int port, String database, String user, String password, DatabaseClientFactory.Authentication type) Deprecated. (as of 4.0.1) use newClient(String host, int port, String database, SecurityContext securityContext)
static DatabaseClient	newClient(String host, int port, String database, String user, String password, DatabaseClientFactory.Authentication type, SSLContext context) Deprecated. (as of 4.0.1) use newClient(String host, int port, String database, SecurityContext securityContext)
static DatabaseClient	newClient(String host, int port, String database, String user, String password, DatabaseClientFactory.Authentication type, SSLContext context, DatabaseClientFactory.SSLHostnameVerifier verifier) Deprecated. (as of 4.0.1) use newClient(String host, int port, String database, SecurityContext securityContext)
static void	registerDefaultHandles() Initializes a handle registry with the default associations between the content handles provided by the API and the supported IO representation classes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newClient

public static DatabaseClient newClient(String host,
                                       int port)

Creates a client to access the database by means of a REST server without any authentication. Such clients can be convenient for experimentation but should not be used in production.

Parameters:

host - the host with the REST server

port - the port for the REST server

Returns:

a new client for making database requests

newClient

public static DatabaseClient newClient(String host,
                                       int port,
                                       String database)

Creates a client to access the database by means of a REST server without any authentication. Such clients can be convenient for experimentation but should not be used in production.

Parameters:

host - the host with the REST server

port - the port for the REST server

database - the database to access (default: configured database for the REST server)

Returns:

a new client for making database requests

newClient

public static DatabaseClient newClient(String host,
                                       int port,
                                       DatabaseClientFactory.SecurityContext securityContext)

Creates a client to access the database by means of a REST server.

Parameters:

host - the host with the REST server

port - the port for the REST server

securityContext - the security context created depending upon the authentication type - BasicAuthContext, DigestAuthContext or KerberosAuthContext and communication channel type (SSL)

Returns:

a new client for making database requests

newClient

public static DatabaseClient newClient(String host,
                                       int port,
                                       String database,
                                       DatabaseClientFactory.SecurityContext securityContext)

Creates a client to access the database by means of a REST server.

Parameters:

host - the host with the REST server

port - the port for the REST server

database - the database to access (default: configured database for the REST server)

securityContext - the security context created depending upon the authentication type - BasicAuthContext, DigestAuthContext or KerberosAuthContext and communication channel type (SSL)

Returns:

a new client for making database requests

newClient

@Deprecated
public static DatabaseClient newClient(String host,
                                                   int port,
                                                   String user,
                                                   String password,
                                                   DatabaseClientFactory.Authentication type)

Deprecated. (as of 4.0.1) use newClient(String host, int port, SecurityContext securityContext)

Creates a client to access the database by means of a REST server.

Parameters:

host - the host with the REST server

port - the port for the REST server

user - the user with read, write, or administrative privileges

password - the password for the user

type - the type of authentication applied to the request

Returns:

a new client for making database requests

newClient

@Deprecated
public static DatabaseClient newClient(String host,
                                                   int port,
                                                   String database,
                                                   String user,
                                                   String password,
                                                   DatabaseClientFactory.Authentication type)

Deprecated. (as of 4.0.1) use newClient(String host, int port, String database, SecurityContext securityContext)

Creates a client to access the database by means of a REST server.

Parameters:

host - the host with the REST server

port - the port for the REST server

database - the database to access (default: configured database for the REST server)

user - the user with read, write, or administrative privileges

password - the password for the user

type - the type of authentication applied to the request

Returns:

a new client for making database requests

newClient

@Deprecated
public static DatabaseClient newClient(String host,
                                                   int port,
                                                   String user,
                                                   String password,
                                                   DatabaseClientFactory.Authentication type,
                                                   SSLContext context)

Deprecated. (as of 4.0.1) use newClient(String host, int port, SecurityContext securityContext)

Creates a client to access the database by means of a REST server.

Parameters:

host - the host with the REST server

port - the port for the REST server

user - the user with read, write, or administrative privileges

password - the password for the user

type - the type of authentication applied to the request

context - the SSL context for authenticating with the server

Returns:

a new client for making database requests

newClient

@Deprecated
public static DatabaseClient newClient(String host,
                                                   int port,
                                                   String database,
                                                   String user,
                                                   String password,
                                                   DatabaseClientFactory.Authentication type,
                                                   SSLContext context)

Deprecated. (as of 4.0.1) use newClient(String host, int port, String database, SecurityContext securityContext)

Creates a client to access the database by means of a REST server.

Parameters:

host - the host with the REST server

port - the port for the REST server

database - the database to access (default: configured database for the REST server)

user - the user with read, write, or administrative privileges

password - the password for the user

type - the type of authentication applied to the request

context - the SSL context for authenticating with the server

Returns:

a new client for making database requests

newClient

@Deprecated
public static DatabaseClient newClient(String host,
                                                   int port,
                                                   String user,
                                                   String password,
                                                   DatabaseClientFactory.Authentication type,
                                                   SSLContext context,
                                                   DatabaseClientFactory.SSLHostnameVerifier verifier)

Deprecated. (as of 4.0.1) use newClient(String host, int port, SecurityContext securityContext)

Creates a client to access the database by means of a REST server.

Parameters:

host - the host with the REST server

port - the port for the REST server

user - the user with read, write, or administrative privileges

password - the password for the user

type - the type of authentication applied to the request

context - the SSL context for authenticating with the server

verifier - a callback for checking hostnames

Returns:

a new client for making database requests

newClient

@Deprecated
public static DatabaseClient newClient(String host,
                                                   int port,
                                                   String database,
                                                   String user,
                                                   String password,
                                                   DatabaseClientFactory.Authentication type,
                                                   SSLContext context,
                                                   DatabaseClientFactory.SSLHostnameVerifier verifier)

Deprecated. (as of 4.0.1) use newClient(String host, int port, String database, SecurityContext securityContext)

Creates a client to access the database by means of a REST server.

Parameters:

host - the host with the REST server

port - the port for the REST server

database - the database to access (default: configured database for the REST server)

user - the user with read, write, or administrative privileges

password - the password for the user

type - the type of authentication applied to the request

context - the SSL context for authenticating with the server

verifier - a callback for checking hostnames

Returns:

a new client for making database requests

getHandleRegistry

public static DatabaseClientFactory.HandleFactoryRegistry getHandleRegistry()

Returns the default registry with factories for creating handles as adapters for IO representations. To create custom registries, use

Returns:

the default registry

clearHandleRegistry

public static void clearHandleRegistry()

Removes the current registered associations so the handle registry is empty.

registerDefaultHandles

public static void registerDefaultHandles()

Initializes a handle registry with the default associations between the content handles provided by the API and the supported IO representation classes. Use this method only after clearing or overwriting associations in the handle registry.

addConfigurator

public static void addConfigurator(DatabaseClientFactory.ClientConfigurator<?> configurator)

Adds a listener that provides custom configuration when a communication library is created.

Parameters:

configurator - the listener for configuring the communication library

See Also:

HttpClientConfigurator