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:

HttpURLConnection, URI, ClientCache, Function, GemfireAdminOperations, FunctionGemfireAdminTemplate, HttpHeaders, HttpMethod, HttpStatus, RequestEntity, ResponseEntity, ClientHttpRequestFactory, ClientHttpRequestInterceptor, SimpleClientHttpRequestFactory, RestOperations, RestTemplate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestHttpGemfireAdminTemplate.Builder
static class	RestHttpGemfireAdminTemplate.FollowRedirectsSimpleClientHttpRequestFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEFAULT_CREATE_REGION_SKIP_IF_EXISTS
protected static String	DEFAULT_HOST
protected static boolean	DEFAULT_HTTP_FOLLOW_REDIRECTS
protected static int	DEFAULT_PORT
protected static String	DEFAULT_SCHEME
protected static String	HTTP_SCHEME
protected static String	HTTPS_SCHEME
protected static String	MANAGEMENT_REST_API_NO_PORT_URL_TEMPLATE
protected static String	MANAGEMENT_REST_API_URL_TEMPLATE
protected static List<String>	VALID_SCHEMES

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 a new instance of RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the default HTTP schema, host and port when accessing the Apache Geode or Pivotal GemFire Management REST API interface.
RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache, String scheme, String host, int port, boolean followRedirects, List<ClientHttpRequestInterceptor> clientHttpRequestInterceptors) Constructs a new instance of RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the specified HTTP scheme, host, port, redirects and ClientHttpRequestInterceptors when accessing the Apache Geode or Pivotal GemFire Management REST API interface.
RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache, String scheme, String host, int port, boolean followRedirects, List<ClientHttpRequestInterceptor> clientHttpRequestInterceptors, List<RestTemplateConfigurer> restTemplateConfigurers) Constructs a new instance of RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the specified HTTP scheme, host, port, redirects and ClientHttpRequestInterceptors when accessing the Apache Geode or Pivotal GemFire 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 Pivotal GemFire/Apache Geode Management REST API URL.
protected <T extends RestOperations> T	getRestOperations() Returns a reference to the RestOperations used to perform REST API calls.
protected <T extends ClientHttpRequestFactory> T	newClientHttpRequestFactory(boolean followRedirects) Constructs a new instance of ClientHttpRequestFactory to make HTTP client requests.
protected <T extends RestOperations> T	newRestOperations(ClientHttpRequestFactory clientHttpRequestFactory, List<ClientHttpRequestInterceptor> clientHttpRequestInterceptors, List<RestTemplateConfigurer> restTemplateConfigurers) Constructs a new instance of the Spring RestTemplate to perform REST API operations over HTTP.
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

DEFAULT_CREATE_REGION_SKIP_IF_EXISTS

protected static final boolean DEFAULT_CREATE_REGION_SKIP_IF_EXISTS

See Also:

Constant Field Values

DEFAULT_HTTP_FOLLOW_REDIRECTS

protected static final boolean DEFAULT_HTTP_FOLLOW_REDIRECTS

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

DEFAULT_SCHEME

protected static final String DEFAULT_SCHEME

See Also:

Constant Field Values

HTTP_SCHEME

protected static final String HTTP_SCHEME

See Also:

Constant Field Values

HTTPS_SCHEME

protected static final String HTTPS_SCHEME

See Also:

Constant Field Values

MANAGEMENT_REST_API_URL_TEMPLATE

protected static final String MANAGEMENT_REST_API_URL_TEMPLATE

See Also:

Constant Field Values

MANAGEMENT_REST_API_NO_PORT_URL_TEMPLATE

protected static final String MANAGEMENT_REST_API_NO_PORT_URL_TEMPLATE

See Also:

Constant Field Values

VALID_SCHEMES

protected static final List<String> VALID_SCHEMES

Constructor Detail

RestHttpGemfireAdminTemplate

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

Constructs a new instance of RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the default HTTP schema, host and port when accessing the Apache Geode or Pivotal GemFire Management REST API interface.

Parameters:

clientCache - reference to the ClientCache.

Throws:

IllegalArgumentException - if ClientCache is null.

See Also:

RestHttpGemfireAdminTemplate(ClientCache, String, String, int, boolean, List), ClientCache

RestHttpGemfireAdminTemplate

public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache,
                                    String scheme,
                                    String host,
                                    int port,
                                    boolean followRedirects,
                                    List<ClientHttpRequestInterceptor> clientHttpRequestInterceptors)

Constructs a new instance of RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the specified HTTP scheme, host, port, redirects and ClientHttpRequestInterceptors when accessing the Apache Geode or Pivotal GemFire Management REST API interface.

Parameters:

clientCache - reference to the ClientCache

scheme - String specifying the HTTP scheme to use (e.g. HTTP or HTTPS).

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.

followRedirects - boolean indicating whether HTTP Redirects (with HTTP Status Code 3xx) should be followed.

clientHttpRequestInterceptors - List of ClientHttpRequestInterceptor used to intercept and decorate the HTTP request and HTTP response.

Throws:

IllegalArgumentException - if the ClientCache reference is null.

See Also:

ClientHttpRequestInterceptor, ClientCache

RestHttpGemfireAdminTemplate

public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache,
                                    String scheme,
                                    String host,
                                    int port,
                                    boolean followRedirects,
                                    List<ClientHttpRequestInterceptor> clientHttpRequestInterceptors,
                                    List<RestTemplateConfigurer> restTemplateConfigurers)

Constructs a new instance of RestHttpGemfireAdminTemplate initialized with the given ClientCache and configured with the specified HTTP scheme, host, port, redirects and ClientHttpRequestInterceptors when accessing the Apache Geode or Pivotal GemFire Management REST API interface.

Parameters:

clientCache - reference to the ClientCache

scheme - String specifying the HTTP scheme to use (e.g. HTTP or HTTPS).

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.

followRedirects - boolean indicating whether HTTP Redirects (with HTTP Status Code 3xx) should be followed.

clientHttpRequestInterceptors - List of ClientHttpRequestInterceptor used to intercept and decorate the HTTP request and HTTP response.

Throws:

IllegalArgumentException - if the ClientCache reference is null.

See Also:

ClientCache, RestTemplateConfigurer, ClientHttpRequestInterceptor, newClientHttpRequestFactory(boolean), newRestOperations(ClientHttpRequestFactory, List, List), resolveManagementRestApiUrl(String, String, int)

Method Detail

newClientHttpRequestFactory

protected <T extends ClientHttpRequestFactory> T newClientHttpRequestFactory(boolean followRedirects)

Constructs a new instance of ClientHttpRequestFactory to make HTTP client requests.

Parameters:

followRedirects - boolean value indicating whether HTTP redirects (with HTTP Status Code 3xx) should be followed.

Returns:

a new ClientHttpRequestFactory.

See Also:

ClientHttpRequestFactory

newRestOperations

protected <T extends RestOperations> T newRestOperations(ClientHttpRequestFactory clientHttpRequestFactory,
                                                         List<ClientHttpRequestInterceptor> clientHttpRequestInterceptors,
                                                         List<RestTemplateConfigurer> restTemplateConfigurers)

Constructs a new instance of the Spring RestTemplate to perform REST API operations over HTTP.

Parameters:

clientHttpRequestFactory - ClientHttpRequestFactory used to construct HTTP request objects.

clientHttpRequestInterceptors - List of ClientHttpRequestInterceptor used to intercept and decorate the HTTP request and HTTP response.

Returns:

a new instance of Spring's RestTemplate.

See Also:

ClientHttpRequestInterceptor, SimpleClientHttpRequestFactory, RestOperations, RestTemplate

getManagementRestApiUrl

protected String getManagementRestApiUrl()

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

Returns:

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

getRestOperations

protected <T extends RestOperations> T 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()