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

Class FunctionGemfireAdminTemplate

java.lang.Object

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

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

All Implemented Interfaces:

GemfireAdminOperations

Direct Known Subclasses:

RestHttpGemfireAdminTemplate

public class FunctionGemfireAdminTemplate
extends AbstractGemfireAdminOperations

The FunctionGemfireAdminTemplate class is an implementation of the GemfireAdminOperations interface supporting the Pivotal GemFire / Apache Geode administrative functions/operations via Function execution in the cluster. Note: any schema changing functionality (e.g. createRegion(RegionDefinition)) does not get recorded by the GemFire/Geode Cluster Configuration Service using this strategy.

Since:

2.0.0

Author:

John Blum

See Also:

• ClientCache
• Function
• ListRegionsOnServerFunction
• AbstractGemfireAdminOperations
• GemfireOnServersFunctionTemplate

Field Summary

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

NOT_IMPLEMENTED

Constructor Summary

Constructors

Constructor	Description
FunctionGemfireAdminTemplate(ClientCache clientCache)	Constructs a new instance of the FunctionGemfireAdminTemplate initialized with a ClientCache instance.

Method Summary

Modifier and Type	Method	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.
Iterable<String>	getAvailableServerRegionIndexes()	Returns an Iterable of all the server Region Indexes.
Iterable<String>	getAvailableServerRegions()	Lists all available Regions configured for all servers in the remote Pivotal GemFire / Apache Geode cluster.
protected ClientCache	getClientCache()	Returns a reference to the configured ClientCache instance.
protected GemfireFunctionOperations	newGemfireFunctionOperations()
protected GemfireFunctionOperations	newGemfireFunctionOperations(ClientCache clientCache)

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

Constructor Details

FunctionGemfireAdminTemplate

public FunctionGemfireAdminTemplate(ClientCache clientCache)

Constructs a new instance of the FunctionGemfireAdminTemplate initialized with a ClientCache instance.

Parameters:

clientCache - reference to a ClientCache instance.

Throws:

IllegalArgumentException - if ClientCache is null.

See Also:

• ClientCache

Method Details

getClientCache

protected ClientCache getClientCache()

Returns a reference to the configured ClientCache instance.

Returns:

a reference to the configured ClientCache instance.

See Also:

• ClientCache

getAvailableServerRegions

public Iterable<String> getAvailableServerRegions()

Lists all available Regions configured for all servers in the remote Pivotal GemFire / Apache Geode cluster.

Specified by:

getAvailableServerRegions in interface GemfireAdminOperations

Overrides:

getAvailableServerRegions in class AbstractGemfireAdminOperations

Returns:

an Iterable of servers-side Region names for all Regions defined across all servers in the remote GemFire/Geode cluster.

See Also:

• Iterable

getAvailableServerRegionIndexes

public Iterable<String> getAvailableServerRegionIndexes()

Returns an Iterable of all the server Region Indexes.

Specified by:

getAvailableServerRegionIndexes in interface GemfireAdminOperations

Overrides:

getAvailableServerRegionIndexes in class AbstractGemfireAdminOperations

Returns:

an Iterable of all the server Region Indexes.

See Also:

• Index.getName()
• Iterable

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 AbstractGemfireAdminOperations

Parameters:

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

See Also:

• RegionDefinition
• GemFireCache
• Region

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 AbstractGemfireAdminOperations

Parameters:

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

See Also:

• IndexDefinition
• Index
• Region

newGemfireFunctionOperations

protected GemfireFunctionOperations newGemfireFunctionOperations()

newGemfireFunctionOperations

protected GemfireFunctionOperations newGemfireFunctionOperations(ClientCache clientCache)