Interface Forest

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Interface

  Description

  static enum 

  Forest.HostType

  Enum containing the list of host types a forest can have.

• Method Summary

  All MethodsInstance MethodsAbstract MethodsDefault Methods

  Modifier and Type

  Method

  Description

  String

  getAlternateHost()

  The alternate host name associated with the forest in the MarkLogic server.

  String

  getDatabaseName()

  The database name associated with the forest in the MarkLogic server.

  String

  getForestId()

  The id for the forest as provided by the MarkLogic server.

  String

  getForestName()

  The name of the forest as provided by the MarkLogic server.

  String

  getHost()

  The host name associated with the forest in the MarkLogic server.

  String

  getOpenReplicaHost()

  The replica host name associated with the forest in the MarkLogic server.

  default String

  getPreferredHost()

  Returns the host your application should talk to for this forest.

  default Forest.HostType

  getPreferredHostType()

  Returns the preferred host type for this forest.

  String

  getRequestHost()

  The request host name associated with the forest in the MarkLogic server.

  boolean

  isUpdateable()

  Whether or not this forest is updateable.

• Method Details

  • getForestId

    String getForestId()
    The id for the forest as provided by the MarkLogic server.

    Returns:

    the id for the forest in MarkLogic server

  • getForestName

    String getForestName()
    The name of the forest as provided by the MarkLogic server.

    Returns:

    the name of the forest in MarkLogic server

  • getDatabaseName

    String getDatabaseName()
    The database name associated with the forest in the MarkLogic server.

    Returns:

    the database name of the forest in the MarkLogic server

  • getHost

    String getHost()
    The host name associated with the forest in the MarkLogic server.

    Returns:

    the host name associated with the forest in the MarkLogic server

  • getOpenReplicaHost

    String getOpenReplicaHost()
    The replica host name associated with the forest in the MarkLogic server. If this is not null this forest has failed over to a replica.

    Returns:

    the host name for the replica forest in the MarkLogic server

  • getAlternateHost

    String getAlternateHost()
    The alternate host name associated with the forest in the MarkLogic server. If this is not null this forest cannot be accessed directly and should instead be accessed through this alternate host. One reason a forest could not be accessed directly is if the forest is on a d-node (a MarkLogic instance with no app servers).

    Returns:

    the host name of the alternat host in the MarkLogic server

  • getRequestHost

    String getRequestHost()
    The request host name associated with the forest in the MarkLogic server. The host name with which we have created the client - host name on the request header.

    Returns:

    the host name of the request host in the MarkLogic server

  • isUpdateable

    boolean isUpdateable()
    Whether or not this forest is updateable.

    Returns:

    whether or not this forest is updateable

  • getPreferredHost

    default String getPreferredHost()
    Returns the host your application should talk to for this forest. If getAlternateHost() is not null, return it. Otherwise, if getOpenReplicaHost() is not null, return it. Otherwise, if getRequestHost() is not null, return it. Otherwise, return getHost().

    Returns:

    the preferred host for this forest

  • getPreferredHostType

    default Forest.HostType getPreferredHostType()
    Returns the preferred host type for this forest. If getAlternateHost() is not null, return ALTERNATE_HOST. Otherwise, if getOpenReplicaHost() is not null, return OPEN_REPLICA_HOST. Otherwise, if getRequestHost() is not null, return REQUEST_HOST. Otherwise, return FOREST_HOST.

    Returns:

    the host type of the forest

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