com.gemstone.gemfire.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:

7.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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	isPersisted Indicates that the effect of the command is persisted or the commands affects the persistent configuration
boolean	readsSharedConfiguration
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
String	valueSeparator String used as a separator when multiple values for a command are specified
boolean	writesToSharedConfiguration

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

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 String[] relatedTopic

In help, topics that are related to this command

Default:

"GemFire"

interceptor

public abstract 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 String valueSeparator

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

Default:

"__NULL__"