Package org.dashbuilder.dataprovider.backend.elasticsearch.rest.impl

Class ElasticSearchNativeClient

java.lang.Object

org.dashbuilder.dataprovider.backend.elasticsearch.rest.impl.ElasticSearchNativeClient

All Implemented Interfaces:

Closeable, AutoCloseable, ElasticSearchClient<ElasticSearchNativeClient>

public class ElasticSearchNativeClient
extends Object
implements ElasticSearchClient<ElasticSearchNativeClient>

The Dashbuilder's client implementation for the ElasticSearch data provider. It uses the native Java admin client from ElasticSearch.

Since:

0.5.0

Field Summary

Fields

Modifier and Type	Field	Description
protected String	clusterName
protected static String	EL_CLIENT_TIMEOUT
protected static String	EL_CLUTER_NAME
protected String[]	index
protected String	serverURL
protected long	timeout
protected String[]	type

Fields inherited from interface org.dashbuilder.dataprovider.backend.elasticsearch.rest.ElasticSearchClient

HEADER_RESPONSE_CODE, RESPONSE_CODE_NOT_FOUND, RESPONSE_CODE_OK

Constructor Summary

Constructors

Constructor	Description
ElasticSearchNativeClient(ElasticSearchClientFactory clientFactory, ElasticSearchValueTypeMapper valueTypeMapper, org.dashbuilder.dataset.IntervalBuilderDynamicDate intervalBuilderDynamicDate, ElasticSearchUtils utils)

Method Summary

Modifier and Type	Method	Description
void	close()
ElasticSearchNativeClient	clusterName(String clusterName)	Builds the client for a given cluster.
CountResponse	count(String[] index, String... type)	Count documents for a given index/es and type/es
MappingsResponse	getMappings(String... index)	Obtain the mappings for a given index/es.
ElasticSearchNativeClient	index(String... indexes)	Builds the client for a given index/es.
SearchResponse	search(org.dashbuilder.dataset.def.ElasticSearchDataSetDef definition, org.dashbuilder.dataset.DataSetMetadata metadata, SearchRequest request)	Obtain documents for a given index/es and type/es
ElasticSearchNativeClient	serverURL(String serverURL)	Builds the client for a given serer URL.
ElasticSearchNativeClient	setTimeout(int timeout)	Sets the timeout value for the HTTP rest client requests.
ElasticSearchNativeClient	type(String... types)	Builds the client for a given types/es.

Methods inherited from class java.lang.Object

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

Field Detail

EL_CLUTER_NAME

protected static final String EL_CLUTER_NAME

See Also:

Constant Field Values

EL_CLIENT_TIMEOUT

protected static final String EL_CLIENT_TIMEOUT

See Also:

Constant Field Values

serverURL

protected String serverURL

clusterName

protected String clusterName

index

protected String[] index

type

protected String[] type

timeout

protected long timeout

Constructor Detail

ElasticSearchNativeClient

public ElasticSearchNativeClient(ElasticSearchClientFactory clientFactory,
                                 ElasticSearchValueTypeMapper valueTypeMapper,
                                 org.dashbuilder.dataset.IntervalBuilderDynamicDate intervalBuilderDynamicDate,
                                 ElasticSearchUtils utils)

Method Detail

serverURL

public ElasticSearchNativeClient serverURL(String serverURL)

Description copied from interface: ElasticSearchClient

Builds the client for a given serer URL.

Specified by:

serverURL in interface ElasticSearchClient<ElasticSearchNativeClient>

Parameters:

serverURL - The ElasticSearch server URL.

Returns:

The REST client for the given server URL.

index

public ElasticSearchNativeClient index(String... indexes)

Description copied from interface: ElasticSearchClient

Builds the client for a given index/es.

Specified by:

index in interface ElasticSearchClient<ElasticSearchNativeClient>

Parameters:

indexes - The ElasticSearch index/es.

Returns:

The REST client for the given index/es.

type

public ElasticSearchNativeClient type(String... types)

Description copied from interface: ElasticSearchClient

Builds the client for a given types/es.

Specified by:

type in interface ElasticSearchClient<ElasticSearchNativeClient>

Parameters:

types - The ElasticSearch types/es.

Returns:

The REST client for the given types/es.

clusterName

public ElasticSearchNativeClient clusterName(String clusterName)

Description copied from interface: ElasticSearchClient

Builds the client for a given cluster.

Specified by:

clusterName in interface ElasticSearchClient<ElasticSearchNativeClient>

Parameters:

clusterName - The ElasticSearch cluster name.

Returns:

The REST client for the given cluster.

setTimeout

public ElasticSearchNativeClient setTimeout(int timeout)

Description copied from interface: ElasticSearchClient

Sets the timeout value for the HTTP rest client requests.

Specified by:

setTimeout in interface ElasticSearchClient<ElasticSearchNativeClient>

Parameters:

timeout - The timeout value in miliseconds.

getMappings

public MappingsResponse getMappings(String... index)
                             throws ElasticSearchClientGenericException

Description copied from interface: ElasticSearchClient

Obtain the mappings for a given index/es.

Specified by:

getMappings in interface ElasticSearchClient<ElasticSearchNativeClient>

Parameters:

index - The index/es to obtain the mappings.

Returns:

The mappings for the given index/es

Throws:

ElasticSearchClientGenericException

count

public CountResponse count(String[] index,
                           String... type)
                    throws ElasticSearchClientGenericException

Description copied from interface: ElasticSearchClient

Count documents for a given index/es and type/es

Specified by:

count in interface ElasticSearchClient<ElasticSearchNativeClient>

Parameters:

index - The index/es for the document type to count. If value is null returns the count number of all documents if all indexes.

type - The type/s of the documents to count. If value is null returns the count number of all documents in all indexes or in the index specified by index.

Returns:

The number of documents for a given index/es and type/es

Throws:

ElasticSearchClientGenericException

search

public SearchResponse search(org.dashbuilder.dataset.def.ElasticSearchDataSetDef definition,
                             org.dashbuilder.dataset.DataSetMetadata metadata,
                             SearchRequest request)
                      throws ElasticSearchClientGenericException

Description copied from interface: ElasticSearchClient

Obtain documents for a given index/es and type/es

If the index/es value set in the request is null returns all documents of all indexes.

If the type/s value set in the request is null returns all documents in all indexes or in the index specified by index.

Specified by:

search in interface ElasticSearchClient<ElasticSearchNativeClient>

Parameters:

definition - The dataset definition.

metadata - The metadata.

request - The search request.

Returns:

The number of documents for a given index/es and type/es

Throws:

ElasticSearchClientGenericException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException