com.marklogic.client

Class DatabaseClientFactory.Bean

java.lang.Object

com.marklogic.client.DatabaseClientFactory.Bean

All Implemented Interfaces:

Serializable

Enclosing class:

DatabaseClientFactory

public static class DatabaseClientFactory.Bean
extends Object
implements Serializable

A Database Client Factory Bean provides an object for specifying configuration before creating a client to make database requests.

For instance, a Spring configuration file might resemble the following example:

 <bean name="databaseClientFactory"
           class="com.marklogic.client.DatabaseClientFactory.Bean">
   <property name="host"                value="localhost"/>
   <property name="port"                value="8012"/>
   <property name="user"                value="rest-writer-user"/>
   <property name="password"            value="rest-writer-password"/>
   <property name="authenticationValue" value="digest"/>
 </bean>
 
 <bean name="databaseClient"
           class="com.marklogic.client.DatabaseClient"
           factory-bean="databaseClientFactory"
           factory-method="newClient"/>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DatabaseClientFactory.Bean() Zero-argument constructor for bean applications.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearHandleRegistry() Removes the current registered associations so the handle registry is empty.
DatabaseClientFactory.Authentication	getAuthentication() Returns the authentication type for clients created with a DatabaseClientFactory.Bean object.
SSLContext	getContext() Returns the SSLContext for SSL clients created with a DatabaseClientFactory.Bean object.
DatabaseClientFactory.HandleFactoryRegistry	getHandleRegistry() Returns the registry for associating IO representation classes with handle factories.
String	getHost() Returns the host for clients created with a DatabaseClientFactory.Bean object.
String	getPassword() Returns the password authentication for clients created with a DatabaseClientFactory.Bean object.
int	getPort() Returns the port for clients created with a DatabaseClientFactory.Bean object.
String	getUser() Returns the user authentication for clients created with a DatabaseClientFactory.Bean object.
DatabaseClientFactory.SSLHostnameVerifier	getVerifier() Returns the host verifier for clients created with a DatabaseClientFactory.Bean object.
DatabaseClient	newClient() Creates a client for bean applications based on the properties.
void	registerDefaultHandles() Initializes a handle registry with the default associations between the content handles provided by the API and the supported IO representation classes.
void	setAuthentication(DatabaseClientFactory.Authentication authentication) Specifies the authentication type for clients created with a DatabaseClientFactory.Bean object.
void	setAuthenticationValue(String authentication) Specifies the authentication type for clients created with a DatabaseClientFactory.Bean object based on a string value.
void	setContext(SSLContext context) Specifies the SSLContext for clients created with a DatabaseClientFactory.Bean object that authenticate with SSL.
void	setHost(String host) Specifies the host for clients created from a DatabaseClientFactory.Bean object.
void	setPassword(String password) Specifies the password authentication for clients created with a DatabaseClientFactory.Bean object.
void	setPort(int port) Specifies the port for clients created with a DatabaseClientFactory.Bean object.
void	setUser(String user) Specifies the user authentication for clients created with a DatabaseClientFactory.Bean object.
void	setVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier) Specifies the host verifier for clients created with a DatabaseClientFactory.Bean object that verify hosts for additional security.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseClientFactory.Bean

public DatabaseClientFactory.Bean()

Zero-argument constructor for bean applications. Other applications can use the static newClient() factory methods of DatabaseClientFactory.

Method Detail

getHost

public String getHost()

Returns the host for clients created with a DatabaseClientFactory.Bean object.

Returns:

the client host

setHost

public void setHost(String host)

Specifies the host for clients created from a DatabaseClientFactory.Bean object.

Parameters:

host - the client host

getPort

public int getPort()

Returns the port for clients created with a DatabaseClientFactory.Bean object.

Returns:

the client port

setPort

public void setPort(int port)

Specifies the port for clients created with a DatabaseClientFactory.Bean object.

Parameters:

port - the client port

getUser

public String getUser()

Returns the user authentication for clients created with a DatabaseClientFactory.Bean object.

Returns:

the user

setUser

public void setUser(String user)

Specifies the user authentication for clients created with a DatabaseClientFactory.Bean object.

Parameters:

user - the user

getPassword

public String getPassword()

Returns the password authentication for clients created with a DatabaseClientFactory.Bean object.

Returns:

the password

setPassword

public void setPassword(String password)

Specifies the password authentication for clients created with a DatabaseClientFactory.Bean object.

Parameters:

password - the password

getAuthentication

public DatabaseClientFactory.Authentication getAuthentication()

Returns the authentication type for clients created with a DatabaseClientFactory.Bean object.

Returns:

the authentication type

setAuthentication

public void setAuthentication(DatabaseClientFactory.Authentication authentication)

Specifies the authentication type for clients created with a DatabaseClientFactory.Bean object.

Parameters:

authentication - the authentication type

setAuthenticationValue

public void setAuthenticationValue(String authentication)

Specifies the authentication type for clients created with a DatabaseClientFactory.Bean object based on a string value.

Parameters:

authentication - the authentication type

getContext

public SSLContext getContext()

Returns the SSLContext for SSL clients created with a DatabaseClientFactory.Bean object.

Returns:

the SSL context

setContext

public void setContext(SSLContext context)

Specifies the SSLContext for clients created with a DatabaseClientFactory.Bean object that authenticate with SSL.

Parameters:

context - the SSL context

getVerifier

public DatabaseClientFactory.SSLHostnameVerifier getVerifier()

Returns the host verifier for clients created with a DatabaseClientFactory.Bean object.

Returns:

the host verifier

setVerifier

public void setVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

Specifies the host verifier for clients created with a DatabaseClientFactory.Bean object that verify hosts for additional security.

Parameters:

verifier - the host verifier

getHandleRegistry

public DatabaseClientFactory.HandleFactoryRegistry getHandleRegistry()

Returns the registry for associating IO representation classes with handle factories.

Returns:

the registry instance

clearHandleRegistry

public void clearHandleRegistry()

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

registerDefaultHandles

public 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.

newClient

public DatabaseClient newClient()

Creates a client for bean applications based on the properties. Other applications can use the static newClient() factory methods of DatabaseClientFactory. The client accesses the database by means of a REST server.

Returns:

a new client for making database requests