org.apache.geode.management.cli

Class GfshCommand

java.lang.Object

org.apache.geode.management.cli.GfshCommand

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

Direct Known Subclasses:

SingleGfshCommand

@Experimental
public abstract class GfshCommand
extends java.lang.Object
implements org.springframework.shell.core.CommandMarker

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXPERIMENTAL

Constructor Summary

Constructors

Constructor and Description
GfshCommand()

Method Summary

Modifier and Type	Method and Description
void	authorize(org.apache.geode.security.ResourcePermission.Resource resource, org.apache.geode.security.ResourcePermission.Operation operation, org.apache.geode.security.ResourcePermission.Target target)
void	authorize(org.apache.geode.security.ResourcePermission.Resource resource, org.apache.geode.security.ResourcePermission.Operation operation, java.lang.String target)
void	authorize(org.apache.geode.security.ResourcePermission.Resource resource, org.apache.geode.security.ResourcePermission.Operation operation, java.lang.String target, java.lang.String key)
java.util.List<org.apache.geode.management.internal.functions.CliFunctionResult>	executeAndGetFunctionResult(org.apache.geode.cache.execute.Function<?> function, java.lang.Object args, java.util.Set<org.apache.geode.distributed.DistributedMember> targetMembers)
org.apache.geode.cache.execute.ResultCollector<?,?>	executeFunction(org.apache.geode.cache.execute.Function<?> function, java.lang.Object args, org.apache.geode.distributed.DistributedMember targetMember)
org.apache.geode.cache.execute.ResultCollector<?,?>	executeFunction(org.apache.geode.cache.execute.Function<?> function, java.lang.Object args, java.util.Set<org.apache.geode.distributed.DistributedMember> targetMembers)
org.apache.geode.management.internal.functions.CliFunctionResult	executeFunctionAndGetFunctionResult(org.apache.geode.cache.execute.Function<?> function, java.lang.Object args, org.apache.geode.distributed.DistributedMember targetMember)
java.util.Set<org.apache.geode.distributed.DistributedMember>	findAnyMembersForRegion(java.lang.String regionPath)
org.apache.geode.distributed.DistributedMember	findMember(java.lang.String memberName) this will return the member found or null if no member with that name
java.util.Set<org.apache.geode.distributed.DistributedMember>	findMembers(java.lang.String[] groups, java.lang.String[] members) if no members matches these names, an empty set would return, this does not include locators
java.util.Set<org.apache.geode.distributed.DistributedMember>	findMembersForRegion(java.lang.String regionPath)
java.util.Set<org.apache.geode.distributed.DistributedMember>	findMembersIncludingLocators(java.lang.String[] groups, java.lang.String[] members) if no members matches these names, an empty set would return
java.util.Set<org.apache.geode.distributed.DistributedMember>	getAllMembers() Gets all members in the GemFire distributed system/cache, including locators
java.util.Set<org.apache.geode.distributed.DistributedMember>	getAllNormalMembers() Get All members, excluding locators
org.apache.geode.cache.Cache	getCache()
org.apache.geode.management.api.ClusterManagementService	getClusterManagementService()
<T extends org.apache.geode.distributed.ConfigurationPersistenceService> T	getConfigurationPersistenceService()
<T extends org.apache.geode.management.ManagementService> T	getManagementService()
org.apache.geode.distributed.DistributedMember	getMember(java.lang.String memberName) this either returns a non-null member or throw an exception if member is not found.
java.util.Set<org.apache.geode.distributed.DistributedMember>	getMembers(java.lang.String[] groups, java.lang.String[] members) if no members matches these names, a UserErrorException will be thrown
org.apache.geode.cache.execute.Execution	getMembersFunctionExecutor(java.util.Set<org.apache.geode.distributed.DistributedMember> members)
java.util.Set<org.apache.geode.distributed.DistributedMember>	getMembersIncludingLocators(java.lang.String[] groups, java.lang.String[] members) if no members matches these names, a UserErrorException will be thrown
java.util.Set<org.apache.geode.distributed.DistributedMember>	getNormalMembersWithSameOrNewerVersion(org.apache.geode.internal.serialization.Version version) Get All members >= a specific version, excluding locators
org.apache.shiro.subject.Subject	getSubject()
boolean	isOnlineCommandAvailable()
boolean	isSharedConfigurationRunning()
boolean	poll(long timeout, java.util.concurrent.TimeUnit unit, java.util.function.Supplier<java.lang.Boolean> function) Very basic polling functionality that executes a function until it returns true or the timeout is reached.
void	setCache(org.apache.geode.cache.Cache cache)

Methods inherited from class java.lang.Object

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

Field Detail

EXPERIMENTAL

public static final java.lang.String EXPERIMENTAL

See Also:

Constant Field Values

Constructor Detail

GfshCommand

public GfshCommand()

Method Detail

isOnlineCommandAvailable

public boolean isOnlineCommandAvailable()

authorize

public void authorize(org.apache.geode.security.ResourcePermission.Resource resource,
                      org.apache.geode.security.ResourcePermission.Operation operation,
                      org.apache.geode.security.ResourcePermission.Target target)

authorize

public void authorize(org.apache.geode.security.ResourcePermission.Resource resource,
                      org.apache.geode.security.ResourcePermission.Operation operation,
                      java.lang.String target)

authorize

public void authorize(org.apache.geode.security.ResourcePermission.Resource resource,
                      org.apache.geode.security.ResourcePermission.Operation operation,
                      java.lang.String target,
                      java.lang.String key)

getCache

public org.apache.geode.cache.Cache getCache()

getManagementService

public <T extends org.apache.geode.management.ManagementService> T getManagementService()

getConfigurationPersistenceService

public <T extends org.apache.geode.distributed.ConfigurationPersistenceService> T getConfigurationPersistenceService()

getClusterManagementService

public org.apache.geode.management.api.ClusterManagementService getClusterManagementService()

setCache

public void setCache(org.apache.geode.cache.Cache cache)

isSharedConfigurationRunning

public boolean isSharedConfigurationRunning()

getSubject

public org.apache.shiro.subject.Subject getSubject()

getMember

public org.apache.geode.distributed.DistributedMember getMember(java.lang.String memberName)

this either returns a non-null member or throw an exception if member is not found.

findMember

public org.apache.geode.distributed.DistributedMember findMember(java.lang.String memberName)

this will return the member found or null if no member with that name

getAllMembers

public java.util.Set<org.apache.geode.distributed.DistributedMember> getAllMembers()

Gets all members in the GemFire distributed system/cache, including locators

getAllNormalMembers

public java.util.Set<org.apache.geode.distributed.DistributedMember> getAllNormalMembers()

Get All members, excluding locators

getNormalMembersWithSameOrNewerVersion

public java.util.Set<org.apache.geode.distributed.DistributedMember> getNormalMembersWithSameOrNewerVersion(org.apache.geode.internal.serialization.Version version)

Get All members >= a specific version, excluding locators

getMembersFunctionExecutor

public org.apache.geode.cache.execute.Execution getMembersFunctionExecutor(java.util.Set<org.apache.geode.distributed.DistributedMember> members)

findMembers

public java.util.Set<org.apache.geode.distributed.DistributedMember> findMembers(java.lang.String[] groups,
                                                                                 java.lang.String[] members)

if no members matches these names, an empty set would return, this does not include locators

getMembers

public java.util.Set<org.apache.geode.distributed.DistributedMember> getMembers(java.lang.String[] groups,
                                                                                java.lang.String[] members)

if no members matches these names, a UserErrorException will be thrown

findMembersIncludingLocators

public java.util.Set<org.apache.geode.distributed.DistributedMember> findMembersIncludingLocators(java.lang.String[] groups,
                                                                                                  java.lang.String[] members)

if no members matches these names, an empty set would return

getMembersIncludingLocators

public java.util.Set<org.apache.geode.distributed.DistributedMember> getMembersIncludingLocators(java.lang.String[] groups,
                                                                                                 java.lang.String[] members)

if no members matches these names, a UserErrorException will be thrown

findMembersForRegion

public java.util.Set<org.apache.geode.distributed.DistributedMember> findMembersForRegion(java.lang.String regionPath)

findAnyMembersForRegion

public java.util.Set<org.apache.geode.distributed.DistributedMember> findAnyMembersForRegion(java.lang.String regionPath)

executeFunction

public org.apache.geode.cache.execute.ResultCollector<?,?> executeFunction(org.apache.geode.cache.execute.Function<?> function,
                                                                           java.lang.Object args,
                                                                           java.util.Set<org.apache.geode.distributed.DistributedMember> targetMembers)

executeFunction

public org.apache.geode.cache.execute.ResultCollector<?,?> executeFunction(org.apache.geode.cache.execute.Function<?> function,
                                                                           java.lang.Object args,
                                                                           org.apache.geode.distributed.DistributedMember targetMember)

executeFunctionAndGetFunctionResult

public org.apache.geode.management.internal.functions.CliFunctionResult executeFunctionAndGetFunctionResult(org.apache.geode.cache.execute.Function<?> function,
                                                                                                            java.lang.Object args,
                                                                                                            org.apache.geode.distributed.DistributedMember targetMember)

executeAndGetFunctionResult

public java.util.List<org.apache.geode.management.internal.functions.CliFunctionResult> executeAndGetFunctionResult(org.apache.geode.cache.execute.Function<?> function,
                                                                                                                    java.lang.Object args,
                                                                                                                    java.util.Set<org.apache.geode.distributed.DistributedMember> targetMembers)

poll

public boolean poll(long timeout,
                    java.util.concurrent.TimeUnit unit,
                    java.util.function.Supplier<java.lang.Boolean> function)

Very basic polling functionality that executes a function until it returns true or the timeout is reached. The polling call is performed on the calling thread. Do not use it with a function that may have an unbounded runtime. The timeout is very coarse and will not account for the function overrunning the given time.

Parameters:

function - a Supplier<Boolean> function that will poll for the condition

Returns:

true if the function returns true within the timeout period; false otherwise