org.apache.geode.management.cli

Annotation Type CliMetaData

@Retention(value=RUNTIME)
 @Target(value={METHOD,PARAMETER})
public @interface CliMetaData

An annotation to define additional meta-data for commands.

Since:

GemFire 7.0

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	ANNOTATION_DEFAULT_VALUE Represents a default value to an option of a command.
static java.lang.String	ANNOTATION_NULL_VALUE Represents a null value to an option of a command.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	interceptor The fully qualified name of a class which implements the CliAroundInterceptor interface in order to provide additional pre- and post-execution functionality for a command.
boolean	isFileDownloadOverHttp Indicates when executed over http, is this command downloading files from the member.
boolean	isPersisted Indicates that the effect of the command is persisted or the commands affects the persistent configuration
boolean	readsSharedConfiguration
java.lang.String[]	relatedTopic In help, topics that are related to this command
boolean	shellOnly Indicates that the command will only run in the gfsh shell and will not need the management service
java.lang.String	valueSeparator String used as a separator when multiple values for a command are specified
boolean	writesToSharedConfiguration

Field Detail

ANNOTATION_DEFAULT_VALUE

public static final java.lang.String ANNOTATION_DEFAULT_VALUE

Represents a default value to an option of a command.

ANNOTATION_NULL_VALUE

public static final java.lang.String ANNOTATION_NULL_VALUE

Represents a null value to an option of a command.

Element Detail

shellOnly

public abstract boolean shellOnly

Indicates that the command will only run in the gfsh shell and will not need the management service

Default:

false

isFileDownloadOverHttp

public abstract boolean isFileDownloadOverHttp

Indicates when executed over http, is this command downloading files from the member. When this is set to true, the RestHttpOperationInvoker will use an extractor to extract the inputstream in the response to a temporary file and it's up to your command's interceptor's postExecution to use that temp file to fit your need.

Default:

false

isPersisted

public abstract boolean isPersisted

Indicates that the effect of the command is persisted or the commands affects the persistent configuration

Default:

false

readsSharedConfiguration

public abstract boolean readsSharedConfiguration

Default:

false

writesToSharedConfiguration

public abstract boolean writesToSharedConfiguration

Default:

false

relatedTopic

public abstract java.lang.String[] relatedTopic

In help, topics that are related to this command

Default:

"Geode"

interceptor

public abstract java.lang.String interceptor

The fully qualified name of a class which implements the CliAroundInterceptor interface in order to provide additional pre- and post-execution functionality for a command.

Default:

"__NULL__"

valueSeparator

public abstract java.lang.String valueSeparator

String used as a separator when multiple values for a command are specified

Default:

"__NULL__"