Class DatabaseClientFactory.Bean

All Implemented Interfaces:

Serializable

Enclosing class:

DatabaseClientFactory

See Also:

• Serialized Form

• Constructor Summary

  Constructors
  Constructor

  Description

  Bean()

  Zero-argument constructor for bean applications.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  void

  clearHandleRegistry()

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

  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.

  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.

  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(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(String database)

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

  void

  setHost(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 Details

  • Bean

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

• Method Details

  • 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

  • getBasePath

    public String getBasePath()

    Returns:

    optional base path to use for constructing a client

    Since:

    6.1.0

  • setBasePath

    public void setBasePath(String basePath)
    Set a base path to use for constructing a client

    Parameters:

    basePath -

    Since:

    6.1.0

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

Copyright (c) 2010-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.