java.io.Serializable
public static class DatabaseClientFactory.Bean
extends java.lang.Object
implements java.io.Serializable
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"/>
Constructor | Description |
---|---|
Bean() |
Zero-argument constructor for bean
applications.
|
Modifier and Type | Method | 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
|
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.
|
javax.net.ssl.SSLContext |
getContext() |
Deprecated.
(as of 4.0.1) use SecurityContext.getSSLContext()
|
java.lang.String |
getDatabase() |
Returns the database for clients created with a
DatabaseClientFactory.Bean object.
|
java.lang.String |
getExternalName() |
Deprecated.
(as of 6.1.0, though has never had any impact)
|
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.
|
java.lang.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
|
java.lang.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(java.lang.String authentication) |
Deprecated.
(as of 4.0.1) use constructor for any SecurityContext
|
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 |
setContext(javax.net.ssl.SSLContext context) |
Deprecated.
(as of 4.0.1) use SecurityContext.withSSLContext(SSLContext,X509TrustManager)
|
void |
setDatabase(java.lang.String database) |
Specifies the database for clients created with
a DatabaseClientFactory.Bean object.
|
void |
setExternalName(java.lang.String externalName) |
Deprecated.
(as of 6.1.0, though has never had any impact)
|
void |
setHost(java.lang.String host) |
Specifies the host for clients created from a
DatabaseClientFactory.Bean object.
|
void |
setPassword(java.lang.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(java.lang.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)
|
public Bean()
public java.lang.String getHost()
public void setHost(java.lang.String host)
host
- the client hostpublic int getPort()
public void setPort(int port)
port
- the client portpublic java.lang.String getBasePath()
public void setBasePath(java.lang.String basePath)
basePath
-@Deprecated public java.lang.String getUser()
@Deprecated public void setUser(java.lang.String user)
user
- the user@Deprecated public java.lang.String getPassword()
@Deprecated public void setPassword(java.lang.String password)
password
- the password@Deprecated public java.lang.String getExternalName()
@Deprecated public void setExternalName(java.lang.String externalName)
externalName
- the external name@Deprecated public DatabaseClientFactory.Authentication getAuthentication()
@Deprecated public void setAuthentication(DatabaseClientFactory.Authentication authentication)
authentication
- the authentication type@Deprecated public void setAuthenticationValue(java.lang.String authentication)
authentication
- the authentication typepublic java.lang.String getDatabase()
public void setDatabase(java.lang.String database)
database
- a database to pass along to new
DocumentManager and QueryManager instances@Deprecated public javax.net.ssl.SSLContext getContext()
@Deprecated public void setContext(javax.net.ssl.SSLContext context)
context
- the SSL context@Deprecated public DatabaseClientFactory.SSLHostnameVerifier getVerifier()
@Deprecated public void setVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)
verifier
- the host verifierpublic DatabaseClientFactory.SecurityContext getSecurityContext()
public void setSecurityContext(DatabaseClientFactory.SecurityContext securityContext)
securityContext
- the security context -
BasicAuthContext, DigestAuthContext or KerberosAuthContextpublic DatabaseClient.ConnectionType getConnectionType()
public void setConnectionType(DatabaseClient.ConnectionType connectionType)
connectionType
- the connection typepublic DatabaseClientFactory.HandleFactoryRegistry getHandleRegistry()
public void clearHandleRegistry()
public void registerDefaultHandles()
public DatabaseClient newClient()
Copyright © 2022 MarkLogic Corporation