com.marklogic.client.datamovement

Class FilteredForestConfiguration

java.lang.Object

com.marklogic.client.datamovement.FilteredForestConfiguration

All Implemented Interfaces:

ForestConfiguration

public class FilteredForestConfiguration
extends java.lang.Object
implements ForestConfiguration

A utility class for wrapping a ForestConfiguration retrieved from DataMovementManager.readForestConfig(). This class does not modify the ForestConfiguration (of course, ForestConfiguration is immutable) but instead provides a modified ForestConfiguration when listForests is called. Passing this (or any ForestConfiguration) to Batcher.withForestConfig(com.marklogic.client.datamovement.ForestConfiguration) will reset the forests seen and used by the Batcher. This class is used by HostAvailabilityListener to black-list unavailable hosts (such as in the case of a failover).

Since this does frequent comparision of host names and they compare case insensitive, this converts all host names to lower case.

FilteredForestConfiguration isn't thread-safe, so only one thread should use one instance. WriteBatcher.withForestConfig and QueryBatcher.withForestConfig are thread-safe, however, so any thread can call those any time to pass in an instance of FilteredForestConfiguration.

As with the provided listeners, this utility will not meet the needs of all applications but the source code for it should serve as helpful sample code so you can write your own custom ForestConfiguration wrapper.

Constructor Summary

Constructors

Constructor and Description
FilteredForestConfiguration(ForestConfiguration forestConfig) Initialize with a ForestConfiguration, usually from DataMovementManager.readForestConfig().

Method Summary

Modifier and Type	Method and Description
Forest[]	listForests() Must be called after configuration methods (withBlackList, withWhiteList, withRenamedHost).
FilteredForestConfiguration	withBlackList(java.lang.String... hostNames) Add hosts to the list of black-listed hosts (hosts which the Batcher will not see when it calls listForests).
FilteredForestConfiguration	withRenamedHost(java.lang.String hostName, java.lang.String targetHostName) Rename hosts to network-addressable names rather than the host names known to the MarkLogic cluster.
FilteredForestConfiguration	withWhiteList(java.lang.String... hostNames) Add hosts to a white-list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.marklogic.client.datamovement.ForestConfiguration

getPreferredHosts

Constructor Detail

FilteredForestConfiguration

public FilteredForestConfiguration(ForestConfiguration forestConfig)

Initialize with a ForestConfiguration, usually from DataMovementManager.readForestConfig().

Parameters:

forestConfig - the ForestConfiguration to wrap

Method Detail

listForests

public Forest[] listForests()

Must be called after configuration methods (withBlackList, withWhiteList, withRenamedHost).

Specified by:

listForests in interface ForestConfiguration

Returns:

the Forest instances that should be used to talk to this database

withBlackList

public FilteredForestConfiguration withBlackList(java.lang.String... hostNames)

Add hosts to the list of black-listed hosts (hosts which the Batcher will not see when it calls listForests). Do not use at the same time as withWhiteList.

Parameters:

hostNames - the hosts to black-list

Returns:

this instance (for method chaining)

withWhiteList

public FilteredForestConfiguration withWhiteList(java.lang.String... hostNames)

Add hosts to a white-list. Only hosts on the list will be returned when the Batcher calls listForests. Should not be used in combination with black-list as that could be confusing to manage.

Parameters:

hostNames - the hosts to white-list

Returns:

this instance (for method chaining)

withRenamedHost

public FilteredForestConfiguration withRenamedHost(java.lang.String hostName,
                                                   java.lang.String targetHostName)

Rename hosts to network-addressable names rather than the host names known to the MarkLogic cluster.

Parameters:

hostName - the host to rename

targetHostName - the network-addressable host name to use

Returns:

this instance (for method chaining)