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.ClientCache
,
Function
,
GemfireAdminOperations
,
FunctionGemfireAdminTemplate
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 |
NOT_IMPLEMENTED
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. |
Modifier and Type | Method and Description |
---|---|
void |
createIndex(IndexDefinition indexDefinition)
|
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 org.springframework.web.client.RestOperations |
getRestOperations()
Returns a reference to the
RestOperations used to perform REST API calls. |
protected URI |
resolveCreateIndexUri() |
protected URI |
resolveCreateRegionUri() |
getAvailableServerRegionIndexes, getAvailableServerRegions, getClientCache, newGemfireFunctionOperations, newGemfireFunctionOperations
createDiskStore, createLuceneIndex
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createDiskStores, createDiskStores, createIndexes, createIndexes, createLuceneIndexes, createLuceneIndexes, createRegions, createRegions
protected static final boolean CREATE_REGION_SKIP_IF_EXISTS_DEFAULT
protected static final int DEFAULT_PORT
protected static final String DEFAULT_HOST
protected static final String MANAGEMENT_REST_API_URL_TEMPLATE
public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache)
RestHttpGemfireAdminTemplate
initialized with
the given ClientCache
and configured with the default host and port when accessing
the GemFire or Geode Management REST API interface.clientCache
- reference to the ClientCache
IllegalArgumentException
- if the ClientCache
reference is null.ClientCache
public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache, String host, int port)
RestHttpGemfireAdminTemplate
initialized with
the given ClientCache
and configured with the specified host and port when accessing
the GemFire or Geode Management REST API interface.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.IllegalArgumentException
- if the ClientCache
reference is null.ClientCache
protected String getManagementRestApiUrl()
String
containing the resolved GemFire/Geode Management REST API URL.protected org.springframework.web.client.RestOperations getRestOperations()
RestOperations
used to perform REST API calls.RestOperations
used to perform REST API calls.RestOperations
public void createIndex(IndexDefinition indexDefinition)
AbstractGemfireAdminOperations
createIndex
in interface GemfireAdminOperations
createIndex
in class FunctionGemfireAdminTemplate
indexDefinition
- IndexDefinition
encapsulating the configuration meta-data
defining a Region
OQL Index
.IndexDefinition
,
Index
,
Region
protected URI resolveCreateIndexUri()
public void createRegion(RegionDefinition regionDefinition)
AbstractGemfireAdminOperations
Region
based on the given schema object definition
.createRegion
in interface GemfireAdminOperations
createRegion
in class FunctionGemfireAdminTemplate
regionDefinition
- RegionDefinition
encapsulating configuration meta-data defining
a cache Region
.RegionDefinition
,
GemFireCache
,
Region
protected URI resolveCreateRegionUri()
Copyright © 2011–2017 Pivotal Software, Inc.. All rights reserved.