Skip navigation links
A C D E F G H I J L M N O P R S T U V 

A

ALL_MEMBER_IDNAME - Static variable in interface org.apache.geode.management.cli.ConverterHint
Hint to be used for all types of GemFire cluster members
ANNOTATION_DEFAULT_VALUE - Static variable in annotation type org.apache.geode.management.cli.CliMetaData
Represents a default value to an option of a command.
ANNOTATION_NULL_VALUE - Static variable in annotation type org.apache.geode.management.cli.CliMetaData
Represents a null value to an option of a command.
ARGUMENT_INVALID - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating an invalid parameter of a command.
asString() - Method in interface org.apache.geode.management.cli.Result
 
authorize(ResourcePermission.Resource, ResourcePermission.Operation, ResourcePermission.Target) - Method in class org.apache.geode.management.cli.GfshCommand
 
authorize(ResourcePermission.Resource, ResourcePermission.Operation, String) - Method in class org.apache.geode.management.cli.GfshCommand
 
authorize(ResourcePermission.Resource, ResourcePermission.Operation, String, String) - Method in class org.apache.geode.management.cli.GfshCommand
 

C

CliFunction<T> - Class in org.apache.geode.management.cli
An abstract function implementation to be extended by cli functions.
CliFunction() - Constructor for class org.apache.geode.management.cli.CliFunction
 
CliMetaData - Annotation Type in org.apache.geode.management.cli
An annotation to define additional meta-data for commands.
CliMetaData.AvailabilityMetadata - Annotation Type in org.apache.geode.management.cli
Deprecated.
since Geode1.2, not used at all
COMMAND_INVALID - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating an invalid command
COMMAND_INVALID_OR_UNAVAILABLE - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating an unknown or unavailable command.
COMMAND_NAME_AMBIGUOUS - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating an ambiguous command name
CommandProcessingException - Exception in org.apache.geode.management.cli
Indicates that an exception occurred while processing a GemFire Command Line Interface (CLI) command.
CommandProcessingException(String, int, Object) - Constructor for exception org.apache.geode.management.cli.CommandProcessingException
Constructs a new CommandProcessingException
CommandService - Class in org.apache.geode.management.cli
Deprecated.
since 1.3 use OnlineCommandProcessor directly
CommandService() - Constructor for class org.apache.geode.management.cli.CommandService
Deprecated.
 
CommandServiceException - Exception in org.apache.geode.management.cli
Indicates that an exception occurred while accessing/creating a Command Service for processing GemFire Command Line Interface (CLI) commands.
CommandServiceException(String, Throwable) - Constructor for exception org.apache.geode.management.cli.CommandServiceException
Constructs a new CommandServiceException with the specified detail message and cause.
CommandServiceException(String) - Constructor for exception org.apache.geode.management.cli.CommandServiceException
Constructs a new CommandServiceException with the specified detail message.
CommandServiceException(Throwable) - Constructor for exception org.apache.geode.management.cli.CommandServiceException
Constructs a new CommandServiceException by wrapping the specified cause.
CommandStatement - Interface in org.apache.geode.management.cli
Deprecated.
since Geode 1.3. simply use commandProcessor to process the command
ConverterHint - Interface in org.apache.geode.management.cli
Used in CliOption annotations to indicate which converter(s) should or should not be used.
createCommandStatement(String) - Method in class org.apache.geode.management.cli.CommandService
Deprecated.
since Geode 1.3, simply call processCommand to execute the command
createCommandStatement(String, Map<String, String>) - Method in class org.apache.geode.management.cli.CommandService
Deprecated.
since Geode 1.3, simply call processCommand to execute the command
createLocalCommandService(Cache) - Static method in class org.apache.geode.management.cli.CommandService
Deprecated.
Returns a newly created or existing instance of the CommandService associated with the specified Cache.

D

DISABLE_ENUM_CONVERTER - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
DISABLE_STRING_CONVERTER - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
Disabled - Annotation Type in org.apache.geode.management.cli
This annotation disables a GfshCommand class from being loaded by the CommandManager unless the provided flag value exists in the VM's environment.
DISKSTORE - Static variable in interface org.apache.geode.management.cli.ConverterHint
 

E

EMPTY_ENV - Static variable in class org.apache.geode.management.cli.CommandService
Deprecated.
 
execute(FunctionContext<T>) - Method in class org.apache.geode.management.cli.CliFunction
 
executeAndGetFunctionResult(Function<?>, Object, Set<DistributedMember>) - Method in class org.apache.geode.management.cli.GfshCommand
 
executeFunction(FunctionContext<T>) - Method in class org.apache.geode.management.cli.CliFunction
 
executeFunction(Function<?>, Object, Set<DistributedMember>) - Method in class org.apache.geode.management.cli.GfshCommand
 
executeFunction(Function<?>, Object, DistributedMember) - Method in class org.apache.geode.management.cli.GfshCommand
 
executeFunctionAndGetFunctionResult(Function<?>, Object, DistributedMember) - Method in class org.apache.geode.management.cli.GfshCommand
 
EXPERIMENTAL - Static variable in class org.apache.geode.management.cli.GfshCommand
 

F

failedToPersist() - Method in interface org.apache.geode.management.cli.Result
Deprecated.
since 1.10. This only affect the gfsh output line which is not api bound
FILE - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
FILE_PATH - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
findAnyMembersForRegion(String) - Method in class org.apache.geode.management.cli.GfshCommand
 
findMember(String) - Method in class org.apache.geode.management.cli.GfshCommand
this will return the member found or null if no member with that name
findMembers(String[], String[]) - Method in class org.apache.geode.management.cli.GfshCommand
if no members matches these names, an empty set would return, this does not include locators
findMembersForRegion(String) - Method in class org.apache.geode.management.cli.GfshCommand
 
findMembersIncludingLocators(String[], String[]) - Method in class org.apache.geode.management.cli.GfshCommand
if no members matches these names, an empty set would return

G

GATEWAY_SENDER_ID - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
getAllMembers() - Method in class org.apache.geode.management.cli.GfshCommand
Gets all members in the GemFire distributed system/cache, including locators
getAllNormalMembers() - Method in class org.apache.geode.management.cli.GfshCommand
Get All members, excluding locators
getCache() - Method in class org.apache.geode.management.cli.GfshCommand
 
getClusterManagementService() - Method in class org.apache.geode.management.cli.GfshCommand
 
getCode() - Method in enum org.apache.geode.management.cli.Result.Status
Returns the code associated with this state.
getCommandString() - Method in interface org.apache.geode.management.cli.CommandStatement
Deprecated.
Returns the user specified command string.
getConfigurationPersistenceService() - Method in class org.apache.geode.management.cli.GfshCommand
 
getEnv() - Method in interface org.apache.geode.management.cli.CommandStatement
Deprecated.
Returns the CLI environment variables.
getErrorData() - Method in exception org.apache.geode.management.cli.CommandProcessingException
Returns the error data.
getErrorType() - Method in exception org.apache.geode.management.cli.CommandProcessingException
Returns the Error Type.
getManagementService() - Method in class org.apache.geode.management.cli.GfshCommand
 
getMember(String) - Method in class org.apache.geode.management.cli.GfshCommand
this either returns a non-null member or throw an exception if member is not found.
getMembers(String[], String[]) - Method in class org.apache.geode.management.cli.GfshCommand
if no members matches these names, a UserErrorException will be thrown
getMembersFunctionExecutor(Set<DistributedMember>) - Method in class org.apache.geode.management.cli.GfshCommand
 
getMembersIncludingLocators(String[], String[]) - Method in class org.apache.geode.management.cli.GfshCommand
if no members matches these names, a UserErrorException will be thrown
getNormalMembersWithSameOrNewerVersion(Version) - Method in class org.apache.geode.management.cli.GfshCommand
Get All members >= a specific version, excluding locators
getStatus() - Method in interface org.apache.geode.management.cli.Result
Returns the status of a processed command.
getSubject() - Method in class org.apache.geode.management.cli.GfshCommand
 
getUsableLocalCommandService() - Static method in class org.apache.geode.management.cli.CommandService
Deprecated.
Returns an existing 'usable' CommandService>.
GfshCommand - Class in org.apache.geode.management.cli
 
GfshCommand() - Constructor for class org.apache.geode.management.cli.GfshCommand
 

H

hasIncomingFiles() - Method in interface org.apache.geode.management.cli.Result
Deprecated.
since 1.10. file transfer in plugin commands is never supported
hasNextLine() - Method in interface org.apache.geode.management.cli.Result
Returns whether the result has any more lines of information.
HELP - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
HINT - Static variable in interface org.apache.geode.management.cli.ConverterHint
 

I

INDEX_TYPE - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
isHA() - Method in class org.apache.geode.management.cli.CliFunction
 
isOnlineCommandAvailable() - Method in class org.apache.geode.management.cli.GfshCommand
 
isSharedConfigurationRunning() - Method in class org.apache.geode.management.cli.GfshCommand
 
isUsable() - Method in class org.apache.geode.management.cli.CommandService
Deprecated.
Returns whether the underlying Cache exists and is not closed.

J

JARDIR - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
JARFILES - Static variable in interface org.apache.geode.management.cli.ConverterHint
 

L

LOCATOR_DISCOVERY_CONFIG - Static variable in interface org.apache.geode.management.cli.ConverterHint
Hint to be used for configured locators for discovery
LOCATOR_MEMBER_IDNAME - Static variable in interface org.apache.geode.management.cli.ConverterHint
Hint to be used for GemFire stand-alone locator members
LOG_LEVEL - Static variable in interface org.apache.geode.management.cli.ConverterHint
 

M

MEMBERGROUP - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
MEMBERIDNAME - Static variable in interface org.apache.geode.management.cli.ConverterHint
Hint to be used for all non locator GemFire cluster members

N

nextLine() - Method in interface org.apache.geode.management.cli.Result
Returns the next line of information from the Result.

O

OPTION_INVALID - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating an invalid named parameter of a command.
OPTION_VALUE_INVALID - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating an invalid value for a parameter of a command.
OPTION_VALUE_REQUIRED - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating the absence of value for named parameter of a command.
org.apache.geode.management.cli - package org.apache.geode.management.cli
The Command Line Interface (CLI) package provides a set of APIs for writing commands that can be used to manage and monitor GemFire components.

P

poll(long, TimeUnit, Supplier<Boolean>) - Method in class org.apache.geode.management.cli.GfshCommand
Very basic polling functionality that executes a function until it returns true or the timeout is reached.
process() - Method in interface org.apache.geode.management.cli.CommandStatement
Deprecated.
Processes this command statement with the user specified command string and environment
processCommand(String) - Method in class org.apache.geode.management.cli.CommandService
Deprecated.
Processes the specified command string.
processCommand(String, Map<String, String>) - Method in class org.apache.geode.management.cli.CommandService
Deprecated.
Processes the specified command string.

R

REGION_PATH - Static variable in interface org.apache.geode.management.cli.ConverterHint
 
REQUIRED_ARGUMENT_MISSING - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating the absence of a mandatory parameter of a command.
REQUIRED_OPTION_MISSING - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating the absence of a mandatory named parameter of a command.
resetToFirstLine() - Method in interface org.apache.geode.management.cli.Result
Resets the pointer to the first line in the Result.
RESOURCE_ACCESS_ERROR - Static variable in exception org.apache.geode.management.cli.CommandProcessingException
Error Type indicating IO errors occurred while accessing File/Network resource
Result - Interface in org.apache.geode.management.cli
The result of processing a GemFire Command Line Interface (CLI) command string.
Result.Status - Enum in org.apache.geode.management.cli
Indicates a Results status.

S

saveIncomingFiles(String) - Method in interface org.apache.geode.management.cli.Result
Deprecated.
since 1.10. file transfer in plugin commands is never supported
setCache(Cache) - Method in class org.apache.geode.management.cli.GfshCommand
 
setCommandPersisted(boolean) - Method in interface org.apache.geode.management.cli.Result
Deprecated.
since 1.10. This only affect the gfsh output line which is not api bound
SingleGfshCommand - Class in org.apache.geode.management.cli
Command class that extends this class can only have one single command method, i.e only one method that is annotated with @CliCommand.
SingleGfshCommand() - Constructor for class org.apache.geode.management.cli.SingleGfshCommand
 

T

toString() - Method in exception org.apache.geode.management.cli.CommandProcessingException
Returns the String representation of this CommandProcessingException

U

UpdateAllConfigurationGroupsMarker - Interface in org.apache.geode.management.cli
This interface is implemented by gfsh commands that can potentially update the configuration for all groups (including the cluster-wide group, "cluster").
updateConfigForGroup(String, CacheConfig, Object) - Method in class org.apache.geode.management.cli.SingleGfshCommand
Implement this method for updating the configuration of a given group the implementation should update the passed in config object with appropriate changes if for any reason config can't be updated.

V

validate() - Method in interface org.apache.geode.management.cli.CommandStatement
Deprecated.
Returns whether the command statement is well formed.
valueOf(String) - Static method in enum org.apache.geode.management.cli.Result.Status
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.geode.management.cli.Result.Status
Returns an array containing the constants of this enum type, in the order they are declared.
A C D E F G H I J L M N O P R S T U V