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
Bean() Zero-argument constructor for bean applications.

Method Summary

Modifier and Type	Method and Description
void	clearHandleRegistry() Removes the current registered associations so the handle registry is empty.
DatabaseClientFactory.Authentication	getAuthentication() Deprecated. (as of 4.0.1) use instanceof on any SecurityContext to get its type
SSLContext	getContext() Deprecated. (as of 4.0.1) use SecurityContext.getSSLContext()
String	getDatabase() Returns the database for clients created with a DatabaseClientFactory.Bean object.
String	getExternalName() Returns the external name for Kerberos 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() Deprecated. (as of 4.0.1) use SecurityContext.getUser() with BasicAuthContext or DigestAuthContext
int	getPort() Returns the port for clients created with a DatabaseClientFactory.Bean object.
DatabaseClientFactory.SecurityContext	getSecurityContext() Returns the security context for clients created with a DatabaseClientFactory.Bean object - BasicAuthContext, DigestAuthContext or KerberosAuthContext
String	getUser() Deprecated. (as of 4.0.1) use SecurityContext.getUser() with BasicAuthContext or DigestAuthContext
DatabaseClientFactory.SSLHostnameVerifier	getVerifier() Deprecated. (as of 4.0.1) use SecurityContext.getSSLHostnameVerifier()
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) Deprecated. (as of 4.0.1) use constructor for any SecurityContext
void	setAuthenticationValue(String authentication) Deprecated. (as of 4.0.1) use constructor for any SecurityContext
void	setContext(SSLContext context) Deprecated. (as of 4.0.1) use SecurityContext.setSSLContext(SSLContext) or SecurityContext.withSSLContext(SSLContext)
void	setDatabase(String database) Specifies the database for clients created with a DatabaseClientFactory.Bean object.
void	setExternalName(String externalName) Specifies the external name for Kerberos clients created with a DatabaseClientFactory.Bean object.
void	setHost(String host) Specifies the host for clients created from a DatabaseClientFactory.Bean object.
void	setPassword(String password) Deprecated. (as of 4.0.1) use constructors for BasicAuthContext or DigestAuthContext
void	setPort(int port) Specifies the port for clients created with a DatabaseClientFactory.Bean object.
void	setSecurityContext(DatabaseClientFactory.SecurityContext securityContext) Specifies the security context for clients created with a DatabaseClientFactory.Bean object
void	setUser(String user) Deprecated. (as of 4.0.1) use constructors for BasicAuthContext or DigestAuthContext
void	setVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier) Deprecated. (as of 4.0.1) use SecurityContext.setSSLHostnameVerifier(SSLHostnameVerifier) or SecurityContext.withSSLHostnameVerifier(SSLHostnameVerifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

Bean

public 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

@Deprecated
public String getUser()

Deprecated. (as of 4.0.1) use SecurityContext.getUser() with BasicAuthContext or DigestAuthContext

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

Returns:

the user

setUser

@Deprecated
public void setUser(String user)

Deprecated. (as of 4.0.1) use constructors for BasicAuthContext or DigestAuthContext

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

Parameters:

user - the user

getPassword

@Deprecated
public String getPassword()

Deprecated. (as of 4.0.1) use SecurityContext.getUser() with BasicAuthContext or DigestAuthContext

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

Returns:

the password

setPassword

@Deprecated
public void setPassword(String password)

Deprecated. (as of 4.0.1) use constructors for BasicAuthContext or DigestAuthContext

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

Parameters:

password - the password

getExternalName

public String getExternalName()

Returns the external name for Kerberos clients created with a DatabaseClientFactory.Bean object.

Returns:

the external name

setExternalName

public void setExternalName(String externalName)

Specifies the external name for Kerberos clients created with a DatabaseClientFactory.Bean object.

Parameters:

externalName - the external name

getAuthentication

@Deprecated
public DatabaseClientFactory.Authentication getAuthentication()

Deprecated. (as of 4.0.1) use instanceof on any SecurityContext to get its type

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

Returns:

the authentication type

setAuthentication

@Deprecated
public void setAuthentication(DatabaseClientFactory.Authentication authentication)

Deprecated. (as of 4.0.1) use constructor for any SecurityContext

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

Parameters:

authentication - the authentication type

setAuthenticationValue

@Deprecated
public void setAuthenticationValue(String authentication)

Deprecated. (as of 4.0.1) use constructor for any SecurityContext

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

Parameters:

authentication - the authentication type

getDatabase

public String getDatabase()

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

Returns:

the database

setDatabase

public void setDatabase(String database)

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

Parameters:

database - a database to pass along to new DocumentManager and QueryManager instances

getContext

@Deprecated
public SSLContext getContext()

Deprecated. (as of 4.0.1) use SecurityContext.getSSLContext()

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

Returns:

the SSL context

setContext

@Deprecated
public void setContext(SSLContext context)

Deprecated. (as of 4.0.1) use SecurityContext.setSSLContext(SSLContext) or SecurityContext.withSSLContext(SSLContext)

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

Parameters:

context - the SSL context

getVerifier

@Deprecated
public DatabaseClientFactory.SSLHostnameVerifier getVerifier()

Deprecated. (as of 4.0.1) use SecurityContext.getSSLHostnameVerifier()

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

Returns:

the host verifier

setVerifier

@Deprecated
public void setVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

Deprecated. (as of 4.0.1) use SecurityContext.setSSLHostnameVerifier(SSLHostnameVerifier) or SecurityContext.withSSLHostnameVerifier(SSLHostnameVerifier)

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

Parameters:

verifier - the host verifier

getSecurityContext

public DatabaseClientFactory.SecurityContext getSecurityContext()

Returns the security context for clients created with a DatabaseClientFactory.Bean object - BasicAuthContext, DigestAuthContext or KerberosAuthContext

Returns:

the security context

setSecurityContext

public void setSecurityContext(DatabaseClientFactory.SecurityContext securityContext)

Specifies the security context for clients created with a DatabaseClientFactory.Bean object

Parameters:

securityContext - the security context - BasicAuthContext, DigestAuthContext or KerberosAuthContext

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