org.codelibs.elasticsearch.runner

Class ElasticsearchClusterRunner

java.lang.Object

org.codelibs.elasticsearch.runner.ElasticsearchClusterRunner

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchClusterRunner
extends Object
implements Closeable

ElasticsearchClusterRunner manages multiple Elasticsearch instances.

Author:

shinsuke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ElasticsearchClusterRunner.Builder This builder sets parameters to create a node
static interface	ElasticsearchClusterRunner.BuilderCallback<T> Callback function.
static class	ElasticsearchClusterRunner.Configs ElasticsearchClusterRunner configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	baseHttpPort
protected String	basePath
protected int	baseTransportPort
protected ElasticsearchClusterRunner.Builder	builder
protected String	clusterName
protected static String	CONFIG_DIR
protected String	confPath
protected static String	DATA_DIR
protected String	dataPath
protected boolean	disableESLogger
protected static String	ELASTICSEARCH_YAML
protected String	indexStoreType
protected static String	LOG4J2_PROPERTIES
protected static String	LOGS_DIR
protected String	logsPath
protected int	maxHttpPort
protected int	maxTransportPort
static String[]	MODULE_TYPES
protected String	moduleTypes
protected List<org.elasticsearch.node.Node>	nodeList
protected int	numOfNode
protected Collection<Class<? extends org.elasticsearch.plugins.Plugin>>	pluginList
protected String	pluginTypes
protected boolean	printOnFailure
protected List<org.elasticsearch.common.settings.Settings>	settingsList
protected boolean	useLogger

Constructor Summary

Constructors

Constructor and Description
ElasticsearchClusterRunner()

Method Summary

Modifier and Type	Method and Description
org.elasticsearch.client.AdminClient	admin() Return an elasticsearch admin client.
void	build(ElasticsearchClusterRunner.Configs configs) Create and start Elasticsearch cluster with Configs instance.
void	build(String... args) Create and start Elasticsearch cluster with arguments.
protected org.elasticsearch.env.Environment	buildNodeEnvironment(int number)
void	clean() Delete all configuration files and directories.
org.elasticsearch.client.Client	client() Return an elasticsearch client.
void	close() Close a cluster runner.
org.elasticsearch.action.support.master.AcknowledgedResponse	closeIndex(String index)
org.elasticsearch.action.support.master.AcknowledgedResponse	closeIndex(String index, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.close.CloseIndexRequestBuilder> builder)
org.elasticsearch.cluster.service.ClusterService	clusterService()
org.elasticsearch.action.search.SearchResponse	count(String index, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.search.SearchRequestBuilder> builder)
org.elasticsearch.action.search.SearchResponse	count(String index, String type)
protected void	createDir(Path path)
org.elasticsearch.action.admin.indices.create.CreateIndexResponse	createIndex(String index, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder> builder)
org.elasticsearch.action.admin.indices.create.CreateIndexResponse	createIndex(String index, org.elasticsearch.common.settings.Settings settings)
org.elasticsearch.action.support.master.AcknowledgedResponse	createMapping(String index, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.mapping.put.PutMappingRequestBuilder> builder)
org.elasticsearch.action.support.master.AcknowledgedResponse	createMapping(String index, String type, String mappingSource)
org.elasticsearch.action.support.master.AcknowledgedResponse	createMapping(String index, String type, org.elasticsearch.common.xcontent.XContentBuilder source)
org.elasticsearch.action.delete.DeleteResponse	delete(String index, String type, String id)
org.elasticsearch.action.delete.DeleteResponse	delete(String index, String type, String id, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.delete.DeleteRequestBuilder> builder)
org.elasticsearch.action.support.master.AcknowledgedResponse	deleteIndex(String index)
org.elasticsearch.action.support.master.AcknowledgedResponse	deleteIndex(String index, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.delete.DeleteIndexRequestBuilder> builder)
org.elasticsearch.cluster.health.ClusterHealthStatus	ensureGreen(String... indices) Wait for green state of a cluster.
org.elasticsearch.cluster.health.ClusterHealthStatus	ensureYellow(String... indices) Wait for yellow state of a cluster.
org.elasticsearch.action.admin.indices.flush.FlushResponse	flush()
org.elasticsearch.action.admin.indices.flush.FlushResponse	flush(boolean force)
org.elasticsearch.action.admin.indices.flush.FlushResponse	flush(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.flush.FlushRequestBuilder> builder)
org.elasticsearch.action.admin.indices.forcemerge.ForceMergeResponse	forceMerge()
org.elasticsearch.action.admin.indices.forcemerge.ForceMergeResponse	forceMerge(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.forcemerge.ForceMergeRequestBuilder> builder)
org.elasticsearch.action.admin.indices.forcemerge.ForceMergeResponse	forceMerge(int maxNumSegments, boolean onlyExpungeDeletes, boolean flush)
org.elasticsearch.action.admin.indices.alias.get.GetAliasesResponse	getAlias(String alias)
org.elasticsearch.action.admin.indices.alias.get.GetAliasesResponse	getAlias(String alias, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.alias.get.GetAliasesRequestBuilder> builder)
protected int	getAvailableHttpPort(int number)
protected int	getAvailableTransportPort(int number)
String	getClusterName()
<T> T	getInstance(Class<T> clazz)
org.elasticsearch.node.Node	getNode(int i) Return a node by the node index.
org.elasticsearch.node.Node	getNode(String name) Return a node by the name.
int	getNodeIndex(org.elasticsearch.node.Node node) Return a node index.
int	getNodeSize() Return the number of nodes.
boolean	indexExists(String index)
boolean	indexExists(String index, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.exists.indices.IndicesExistsRequestBuilder> builder)
org.elasticsearch.action.index.IndexResponse	insert(String index, String type, String id, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.index.IndexRequestBuilder> builder)
org.elasticsearch.action.index.IndexResponse	insert(String index, String type, String id, String source)
boolean	isClosed() Check if a cluster runner is closed.
static void	main(String[] args)
org.elasticsearch.node.Node	masterNode() Return a master node.
static ElasticsearchClusterRunner.Configs	newConfigs()
org.elasticsearch.node.Node	node() Return an available node.
org.elasticsearch.node.Node	nonMasterNode() Return a non-master node.
ElasticsearchClusterRunner	onBuild(ElasticsearchClusterRunner.Builder builder) Configure each Elasticsearch instance by builder.
org.elasticsearch.action.admin.indices.open.OpenIndexResponse	openIndex(String index)
org.elasticsearch.action.admin.indices.open.OpenIndexResponse	openIndex(String index, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.open.OpenIndexRequestBuilder> builder)
void	print(String line)
protected void	putIfAbsent(org.elasticsearch.common.settings.Settings.Builder settingsBuilder, String key, String value)
org.elasticsearch.action.admin.indices.refresh.RefreshResponse	refresh()
org.elasticsearch.action.admin.indices.refresh.RefreshResponse	refresh(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.refresh.RefreshRequestBuilder> builder)
org.elasticsearch.action.search.SearchResponse	search(String index, ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.search.SearchRequestBuilder> builder)
org.elasticsearch.action.search.SearchResponse	search(String index, String type, org.elasticsearch.index.query.QueryBuilder queryBuilder, org.elasticsearch.search.sort.SortBuilder<?> sort, int from, int size)
void	setMaxHttpPort(int maxHttpPort)
void	setMaxTransportPort(int maxTransportPort)
boolean	startNode(int i) Start a closed node.
org.elasticsearch.action.support.master.AcknowledgedResponse	updateAlias(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequestBuilder> builder)
org.elasticsearch.action.support.master.AcknowledgedResponse	updateAlias(String alias, String[] addedIndices, String[] deletedIndices)
org.elasticsearch.action.admin.indices.upgrade.post.UpgradeResponse	upgrade()
org.elasticsearch.action.admin.indices.upgrade.post.UpgradeResponse	upgrade(boolean upgradeOnlyAncientSegments)
org.elasticsearch.action.admin.indices.upgrade.post.UpgradeResponse	upgrade(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.upgrade.post.UpgradeRequestBuilder> builder)
org.elasticsearch.cluster.health.ClusterHealthStatus	waitForRelocation()

Methods inherited from class java.lang.Object

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

Field Detail

LOG4J2_PROPERTIES

protected static final String LOG4J2_PROPERTIES

See Also:

Constant Field Values

ELASTICSEARCH_YAML

protected static final String ELASTICSEARCH_YAML

See Also:

Constant Field Values

MODULE_TYPES

public static String[] MODULE_TYPES

DATA_DIR

protected static final String DATA_DIR

See Also:

Constant Field Values

LOGS_DIR

protected static final String LOGS_DIR

See Also:

Constant Field Values

CONFIG_DIR

protected static final String CONFIG_DIR

See Also:

Constant Field Values

nodeList

protected List<org.elasticsearch.node.Node> nodeList

settingsList

protected List<org.elasticsearch.common.settings.Settings> settingsList

pluginList

protected Collection<Class<? extends org.elasticsearch.plugins.Plugin>> pluginList

maxHttpPort

protected int maxHttpPort

maxTransportPort

protected int maxTransportPort

basePath

protected String basePath

confPath

protected String confPath

dataPath

protected String dataPath

logsPath

protected String logsPath

numOfNode

protected int numOfNode

baseTransportPort

protected int baseTransportPort

baseHttpPort

protected int baseHttpPort

clusterName

protected String clusterName

indexStoreType

protected String indexStoreType

useLogger

protected boolean useLogger

disableESLogger

protected boolean disableESLogger

printOnFailure

protected boolean printOnFailure

moduleTypes

protected String moduleTypes

pluginTypes

protected String pluginTypes

builder

protected ElasticsearchClusterRunner.Builder builder

Constructor Detail

ElasticsearchClusterRunner

public ElasticsearchClusterRunner()

Method Detail

main

public static void main(String[] args)

isClosed

public boolean isClosed()

Check if a cluster runner is closed.

Returns:

true if a runner is closed.

close

public void close()
           throws IOException

Close a cluster runner.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

clean

public void clean()

Delete all configuration files and directories.

onBuild

public ElasticsearchClusterRunner onBuild(ElasticsearchClusterRunner.Builder builder)

Configure each Elasticsearch instance by builder.

Parameters:

builder -

Returns:

build

public void build(ElasticsearchClusterRunner.Configs configs)

Create and start Elasticsearch cluster with Configs instance.

Parameters:

configs -

build

public void build(String... args)

Create and start Elasticsearch cluster with arguments.

Parameters:

args -

buildNodeEnvironment

protected org.elasticsearch.env.Environment buildNodeEnvironment(int number)
                                                          throws IOException,
                                                                 org.elasticsearch.cli.UserException

Throws:

IOException

org.elasticsearch.cli.UserException

getAvailableHttpPort

protected int getAvailableHttpPort(int number)

getAvailableTransportPort

protected int getAvailableTransportPort(int number)

putIfAbsent

protected void putIfAbsent(org.elasticsearch.common.settings.Settings.Builder settingsBuilder,
                           String key,
                           String value)

setMaxHttpPort

public void setMaxHttpPort(int maxHttpPort)

setMaxTransportPort

public void setMaxTransportPort(int maxTransportPort)

getNode

public org.elasticsearch.node.Node getNode(int i)

Return a node by the node index.

Parameters:

i - A node index

Returns:

null if the node is not found

startNode

public boolean startNode(int i)

Start a closed node.

Parameters:

i -

Returns:

true if the node is started.

getNode

public org.elasticsearch.node.Node getNode(String name)

Return a node by the name.

Parameters:

name - A node name

Returns:

null if the node is not found by the name

getNodeIndex

public int getNodeIndex(org.elasticsearch.node.Node node)

Return a node index.

Parameters:

node -

Returns:

-1 if the node does not exist.

getNodeSize

public int getNodeSize()

Return the number of nodes.

Returns:

the number of nodes

print

public void print(String line)

createDir

protected void createDir(Path path)

node

public org.elasticsearch.node.Node node()

Return an available node.

Returns:

masterNode

public org.elasticsearch.node.Node masterNode()

Return a master node.

Returns:

nonMasterNode

public org.elasticsearch.node.Node nonMasterNode()

Return a non-master node.

Returns:

client

public org.elasticsearch.client.Client client()

Return an elasticsearch client.

Returns:

admin

public org.elasticsearch.client.AdminClient admin()

Return an elasticsearch admin client.

Returns:

ensureGreen

public org.elasticsearch.cluster.health.ClusterHealthStatus ensureGreen(String... indices)

Wait for green state of a cluster.

Parameters:

indices -

Returns:

ensureYellow

public org.elasticsearch.cluster.health.ClusterHealthStatus ensureYellow(String... indices)

Wait for yellow state of a cluster.

Parameters:

indices -

Returns:

waitForRelocation

public org.elasticsearch.cluster.health.ClusterHealthStatus waitForRelocation()

flush

public org.elasticsearch.action.admin.indices.flush.FlushResponse flush()

flush

public org.elasticsearch.action.admin.indices.flush.FlushResponse flush(boolean force)

flush

public org.elasticsearch.action.admin.indices.flush.FlushResponse flush(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.flush.FlushRequestBuilder> builder)

refresh

public org.elasticsearch.action.admin.indices.refresh.RefreshResponse refresh()

refresh

public org.elasticsearch.action.admin.indices.refresh.RefreshResponse refresh(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.refresh.RefreshRequestBuilder> builder)

upgrade

public org.elasticsearch.action.admin.indices.upgrade.post.UpgradeResponse upgrade()

upgrade

public org.elasticsearch.action.admin.indices.upgrade.post.UpgradeResponse upgrade(boolean upgradeOnlyAncientSegments)

upgrade

public org.elasticsearch.action.admin.indices.upgrade.post.UpgradeResponse upgrade(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.upgrade.post.UpgradeRequestBuilder> builder)

forceMerge

public org.elasticsearch.action.admin.indices.forcemerge.ForceMergeResponse forceMerge()

forceMerge

public org.elasticsearch.action.admin.indices.forcemerge.ForceMergeResponse forceMerge(int maxNumSegments,
                                                                                       boolean onlyExpungeDeletes,
                                                                                       boolean flush)

forceMerge

public org.elasticsearch.action.admin.indices.forcemerge.ForceMergeResponse forceMerge(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.forcemerge.ForceMergeRequestBuilder> builder)

openIndex

public org.elasticsearch.action.admin.indices.open.OpenIndexResponse openIndex(String index)

openIndex

public org.elasticsearch.action.admin.indices.open.OpenIndexResponse openIndex(String index,
                                                                               ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.open.OpenIndexRequestBuilder> builder)

closeIndex

public org.elasticsearch.action.support.master.AcknowledgedResponse closeIndex(String index)

closeIndex

public org.elasticsearch.action.support.master.AcknowledgedResponse closeIndex(String index,
                                                                               ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.close.CloseIndexRequestBuilder> builder)

createIndex

public org.elasticsearch.action.admin.indices.create.CreateIndexResponse createIndex(String index,
                                                                                     org.elasticsearch.common.settings.Settings settings)

createIndex

public org.elasticsearch.action.admin.indices.create.CreateIndexResponse createIndex(String index,
                                                                                     ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder> builder)

indexExists

public boolean indexExists(String index)

indexExists

public boolean indexExists(String index,
                           ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.exists.indices.IndicesExistsRequestBuilder> builder)

deleteIndex

public org.elasticsearch.action.support.master.AcknowledgedResponse deleteIndex(String index)

deleteIndex

public org.elasticsearch.action.support.master.AcknowledgedResponse deleteIndex(String index,
                                                                                ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.delete.DeleteIndexRequestBuilder> builder)

createMapping

public org.elasticsearch.action.support.master.AcknowledgedResponse createMapping(String index,
                                                                                  String type,
                                                                                  String mappingSource)

createMapping

public org.elasticsearch.action.support.master.AcknowledgedResponse createMapping(String index,
                                                                                  String type,
                                                                                  org.elasticsearch.common.xcontent.XContentBuilder source)

createMapping

public org.elasticsearch.action.support.master.AcknowledgedResponse createMapping(String index,
                                                                                  ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.mapping.put.PutMappingRequestBuilder> builder)

insert

public org.elasticsearch.action.index.IndexResponse insert(String index,
                                                           String type,
                                                           String id,
                                                           String source)

insert

public org.elasticsearch.action.index.IndexResponse insert(String index,
                                                           String type,
                                                           String id,
                                                           ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.index.IndexRequestBuilder> builder)

delete

public org.elasticsearch.action.delete.DeleteResponse delete(String index,
                                                             String type,
                                                             String id)

delete

public org.elasticsearch.action.delete.DeleteResponse delete(String index,
                                                             String type,
                                                             String id,
                                                             ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.delete.DeleteRequestBuilder> builder)

count

public org.elasticsearch.action.search.SearchResponse count(String index,
                                                            String type)

count

public org.elasticsearch.action.search.SearchResponse count(String index,
                                                            ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.search.SearchRequestBuilder> builder)

search

public org.elasticsearch.action.search.SearchResponse search(String index,
                                                             String type,
                                                             org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                             org.elasticsearch.search.sort.SortBuilder<?> sort,
                                                             int from,
                                                             int size)

search

public org.elasticsearch.action.search.SearchResponse search(String index,
                                                             ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.search.SearchRequestBuilder> builder)

getAlias

public org.elasticsearch.action.admin.indices.alias.get.GetAliasesResponse getAlias(String alias)

getAlias

public org.elasticsearch.action.admin.indices.alias.get.GetAliasesResponse getAlias(String alias,
                                                                                    ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.alias.get.GetAliasesRequestBuilder> builder)

updateAlias

public org.elasticsearch.action.support.master.AcknowledgedResponse updateAlias(String alias,
                                                                                String[] addedIndices,
                                                                                String[] deletedIndices)

updateAlias

public org.elasticsearch.action.support.master.AcknowledgedResponse updateAlias(ElasticsearchClusterRunner.BuilderCallback<org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequestBuilder> builder)

clusterService

public org.elasticsearch.cluster.service.ClusterService clusterService()

getInstance

public <T> T getInstance(Class<T> clazz)

getClusterName

public String getClusterName()

newConfigs

public static ElasticsearchClusterRunner.Configs newConfigs()