DatabaseClientFactory.Bean (MarkLogic Java Client API 6.6.1)

java.lang.Object
- com.marklogic.client.DatabaseClientFactory.Bean

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

DatabaseClientFactory
```
public static class DatabaseClientFactory.Bean
extends java.lang.Object
implements java.io.Serializable
```
A Database Client Factory Bean provides an object for specifying configuration before creating a client to make database requests.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Bean()
Zero-argument constructor for bean applications.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearHandleRegistry()` Removes the current registered associations so the handle registry is empty.
`java.lang.String`	`getBasePath()`
`DatabaseClient.ConnectionType`	`getConnectionType()` Identifies whether the client connects directly with a MarkLogic host or by means of a gateway such as a load balancer.
`java.lang.String`	`getDatabase()` Returns the database for clients created with a DatabaseClientFactory.Bean object.
`DatabaseClientFactory.HandleFactoryRegistry`	`getHandleRegistry()` Returns the registry for associating IO representation classes with handle factories.
`java.lang.String`	`getHost()` Returns the host for clients created with a DatabaseClientFactory.Bean object.
`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
`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`	`setBasePath(java.lang.String basePath)` Set a base path to use for constructing a client
`void`	`setConnectionType(DatabaseClient.ConnectionType connectionType)` Specify whether the client connects directly with a MarkLogic host or by means of a gateway such as a load balancer.
`void`	`setDatabase(java.lang.String database)` Specifies the database for clients created with a DatabaseClientFactory.Bean object.
`void`	`setHost(java.lang.String host)` Specifies the host for clients created from a DatabaseClientFactory.Bean object.
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, 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 java.lang.String getHost()
```
    Returns the host for clients created with a DatabaseClientFactory.Bean object.
    
    Returns:
    
    the client host
  - setHost
```
public void setHost(java.lang.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
  - getBasePath
```
public java.lang.String getBasePath()
```
    Returns:
    
    optional base path to use for constructing a client
    
    Since:
    
    6.1.0
  - setBasePath
```
public void setBasePath(java.lang.String basePath)
```
    Set a base path to use for constructing a client
    
    Parameters:
    
    basePath -
    
    Since:
    
    6.1.0
  - getDatabase
```
public java.lang.String getDatabase()
```
    Returns the database for clients created with a DatabaseClientFactory.Bean object.
    
    Returns:
    
    the database
  - setDatabase
```
public void setDatabase(java.lang.String database)
```
    Specifies the database for clients created with a DatabaseClientFactory.Bean object. A data service interface can only call an endpoint for the configured content database of the appserver. You cannot specify the database when constructing a client for working with a data service.
    
    Parameters:
    
    database - a database to pass along to new DocumentManager and QueryManager instances
  - 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
  - getConnectionType
```
public DatabaseClient.ConnectionType getConnectionType()
```
    Identifies whether the client connects directly with a MarkLogic host or by means of a gateway such as a load balancer.
    
    Returns:
    
    the connection type
  - setConnectionType
```
public void setConnectionType(DatabaseClient.ConnectionType connectionType)
```
    Specify whether the client connects directly with a MarkLogic host or by means of a gateway such as a load balancer.
    
    Parameters:
    
    connectionType - the connection type
  - 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

Class DatabaseClientFactory.Bean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Bean

Method Detail

getHost

setHost

getPort

setPort

getBasePath

setBasePath

getDatabase

setDatabase

getSecurityContext

setSecurityContext

getConnectionType

setConnectionType

getHandleRegistry

clearHandleRegistry

registerDefaultHandles

newClient