com.marklogic.client.datamovement

Interface Forest

public interface Forest

Some details about a MarkLogic forest.

Method Summary

Modifier and Type	Method and 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.
boolean	isUpdateable() Whether or not this forest is updateable.

Method Detail

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

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, return getHost().

Returns:

the preferred host for this forest