Package org.apache.geode.management.cli

Annotation Type CliMetaData

  • @Retention(RUNTIME)
@Target({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 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 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 isFileUploaded
      Indicates whether this command would require fileData to be sent from the client.
      boolean isPersisted
      Indicates that the effect of the command is persisted or the commands affects the persistent configuration
      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 Gfsh ExecutionStrategy will use this flag to determine whether to invoke remote call or not.
      java.lang.String valueSeparator
      Deprecated.
      since 1.2, Command methods may override both the delimiter and the escape through spring shell's splittingRegex option context

    • Field Detail

      • ANNOTATION_DEFAULT_VALUE

        static final java.lang.String ANNOTATION_DEFAULT_VALUE
        Represents a default value to an option of a command.

      • ANNOTATION_NULL_VALUE

        static final java.lang.String ANNOTATION_NULL_VALUE
        Represents a null value to an option of a command.

    • Element Detail

      • shellOnly

        boolean shellOnly
        Indicates that the command will only run in the gfsh shell Gfsh ExecutionStrategy will use this flag to determine whether to invoke remote call or not.
        Returns:
        whether the command will only run in the gfsh shell
        Default:
        false

      • isFileDownloadOverHttp

        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.
        Returns:
        whether this command downloads files from the member over http
        Default:
        false

      • isFileUploaded

        boolean isFileUploaded
        Indicates whether this command would require fileData to be sent from the client. If this is true, the preExecution of the interceptor needs to return a FileResult
        Returns:
        whether this command would require fileData to be sent from the client
        Default:
        false

      • isPersisted

        boolean isPersisted
        Indicates that the effect of the command is persisted or the commands affects the persistent configuration
        Returns:
        whether the effect of the command is persisted or the commands affects the persistent configuration
        Default:
        false

      • relatedTopic

        java.lang.String[] relatedTopic
        In help, topics that are related to this command
        Returns:
        topics that are related to this command
        Default:
        {"GemFire"}

      • interceptor

        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.
        Returns:
        the fully qualified name of a class which implements the CliAroundInterceptor interface
        Default:
        "__NULL__"

      • valueSeparator

        @Deprecated
java.lang.String valueSeparator
        Deprecated.
        since 1.2, Command methods may override both the delimiter and the escape through spring shell's splittingRegex option context
        String used as a separator when multiple values for a command are specified
        Returns:
        the String used as a separator when multiple values for a command are specified
        Default:
        "__NULL__"