org.springframework.data.gemfire.config.admin.remote

Class RestHttpGemfireAdminTemplate

java.lang.Object

org.springframework.data.gemfire.config.admin.AbstractGemfireAdminOperations

org.springframework.data.gemfire.config.admin.remote.FunctionGemfireAdminTemplate

org.springframework.data.gemfire.config.admin.remote.RestHttpGemfireAdminTemplate

All Implemented Interfaces:

GemfireAdminOperations

public class RestHttpGemfireAdminTemplate
extends FunctionGemfireAdminTemplate

RestHttpGemfireAdminTemplate is class implementing the GemfireAdminOperations interface, extending the FunctionGemfireAdminTemplate to support administrative (management) operations on a Pivotal GemFire or Apache Geode cluster using the Management REST API interface over HTTP. The fallback is using Function execution if the a particular administrative (management) operation is not supported or has not been implemented against the Management REST API interface over HTTP.

Since:

2.0.0

Author:

John Blum

See Also:

ClientCache, Function, GemfireAdminOperations, FunctionGemfireAdminTemplate

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	CREATE_REGION_SKIP_IF_EXISTS_DEFAULT
protected static String	DEFAULT_HOST
protected static int	DEFAULT_PORT
protected static String	MANAGEMENT_REST_API_URL_TEMPLATE

Fields inherited from class org.springframework.data.gemfire.config.admin.AbstractGemfireAdminOperations

NOT_IMPLEMENTED

Constructor Summary

Constructors

Constructor and Description
RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache) Constructs an instance of the RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the default host and port when accessing the GemFire or Geode Management REST API interface.
RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache, String host, int port) Constructs an instance of the RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the specified host and port when accessing the GemFire or Geode Management REST API interface.

Method Summary

Modifier and Type	Method and Description
void	createIndex(IndexDefinition indexDefinition) Creates a Region OQL Index based on the given schema object definition.
void	createRegion(RegionDefinition regionDefinition) Creates a cache Region based on the given schema object definition.
protected String	getManagementRestApiUrl() Returns a reference to the resolved GemFire/Geode Management REST API URL.
protected RestOperations	getRestOperations() Returns a reference to the RestOperations used to perform REST API calls.
protected URI	resolveCreateIndexUri()
protected URI	resolveCreateRegionUri()

Methods inherited from class org.springframework.data.gemfire.config.admin.remote.FunctionGemfireAdminTemplate

getAvailableServerRegionIndexes, getAvailableServerRegions, getClientCache, newGemfireFunctionOperations, newGemfireFunctionOperations

Methods inherited from class org.springframework.data.gemfire.config.admin.AbstractGemfireAdminOperations

createDiskStore, createLuceneIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.gemfire.config.admin.GemfireAdminOperations

createDiskStores, createDiskStores, createIndexes, createIndexes, createLuceneIndexes, createLuceneIndexes, createRegions, createRegions

Field Detail

CREATE_REGION_SKIP_IF_EXISTS_DEFAULT

protected static final boolean CREATE_REGION_SKIP_IF_EXISTS_DEFAULT

See Also:

Constant Field Values

DEFAULT_PORT

protected static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_HOST

protected static final String DEFAULT_HOST

See Also:

Constant Field Values

MANAGEMENT_REST_API_URL_TEMPLATE

protected static final String MANAGEMENT_REST_API_URL_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

RestHttpGemfireAdminTemplate

public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache)

Constructs an instance of the RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the default host and port when accessing the GemFire or Geode Management REST API interface.

Parameters:

clientCache - reference to the ClientCache

Throws:

IllegalArgumentException - if the ClientCache reference is null.

See Also:

ClientCache

RestHttpGemfireAdminTemplate

public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache,
                                    String host,
                                    int port)

Constructs an instance of the RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the specified host and port when accessing the GemFire or Geode Management REST API interface.

Parameters:

clientCache - reference to the ClientCache

host - String containing the hostname of the GemFire/Geode Manager.

port - integer value specifying the port on which the GemFire/Geode Manager HTTP Service is listening for HTTP clients.

Throws:

IllegalArgumentException - if the ClientCache reference is null.

See Also:

ClientCache

Method Detail

getManagementRestApiUrl

protected String getManagementRestApiUrl()

Returns a reference to the resolved GemFire/Geode Management REST API URL.

Returns:

a String containing the resolved GemFire/Geode Management REST API URL.

getRestOperations

protected RestOperations getRestOperations()

Returns a reference to the RestOperations used to perform REST API calls.

Returns:

a reference to the RestOperations used to perform REST API calls.

See Also:

RestOperations

createIndex

public void createIndex(IndexDefinition indexDefinition)

Description copied from class: AbstractGemfireAdminOperations

Creates a Region OQL Index based on the given schema object definition.

Specified by:

createIndex in interface GemfireAdminOperations

Overrides:

createIndex in class FunctionGemfireAdminTemplate

Parameters:

indexDefinition - IndexDefinition encapsulating the configuration meta-data defining a Region OQL Index.

See Also:

IndexDefinition, Index, Region

resolveCreateIndexUri

protected URI resolveCreateIndexUri()

createRegion

public void createRegion(RegionDefinition regionDefinition)

Description copied from class: AbstractGemfireAdminOperations

Creates a cache Region based on the given schema object definition.

Specified by:

createRegion in interface GemfireAdminOperations

Overrides:

createRegion in class FunctionGemfireAdminTemplate

Parameters:

regionDefinition - RegionDefinition encapsulating configuration meta-data defining a cache Region.

See Also:

RegionDefinition, GemFireCache, Region

resolveCreateRegionUri

protected URI resolveCreateRegionUri()