Package com.attivio.sdk.server.annotation

Annotation Type ConfigurationOption

  • @Retention(RUNTIME)
@Target({METHOD,TYPE})
@Inherited
public @interface ConfigurationOption
    Describes all the ways in which a bean's properties can be reflected on the command line and via messages.

    Ideally, we could have used classes for formEntryClass() but this would create a runtime dependency. So we are needed to use string instead and as a result, String constants are used for common (non-reflection) based entries.

    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.String DOCUMENT_MODE
      Used for any String method that should be rendered as an ingest document mode option box
      static java.lang.String FALSE_SWITCH_VALUE
      Constant FALSE for switchValue()
      static java.lang.String HTTPS
      Used for any String method that should be rendered as a HTTP, HTTPS option box
      static java.lang.String OPTION
      Used for selecting from among provided options
      static java.lang.String PASSWORD
      Used for any String method that should be rendered as a password
      static java.lang.String QUERY_LANGUAGE
      Used for selecting from among available query languages
      static java.lang.String SORTED_STRING_LIST
      Use for List methods but when the UI should display the list in sorted order
      static java.lang.String SPRING_BEAN
      Use for any Object that should be pulled from spring
      static java.lang.String STRING_LIST
      Use for List methods
      static java.lang.String STRING_TO_STRING_MAP
      Use for Map<String,String> methods
      static java.lang.String TEXT_AREA
      Used for any String method that should be rendered as a text area (aka multiple lines)
      static java.lang.String TRUE_SWITCH_VALUE
      Constant TRUE for switchValue()

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean addDefaultValue
      If true, adds [Default = `default from class`] to the end of the description if default value != null.
      java.lang.String description
      Description for this option.
      java.lang.String displayName
      displayed to the user in the admin interface
      java.lang.String formEntryClass
      Class to implement the Form Entry (see GWT Commons)
      java.lang.String help
      extra help text for this option
      boolean hidden
      If true, hide from the command line option generation process, default = false.
      java.lang.String[] labels  
      java.lang.String longOpt
      The long option for a command line argument.
      java.lang.String messageProp
      Deprecated.
      No longer used.
      ConfigurationOption.OptionLevel optionLevel
      Determines if an option is required, basic or advanced.
      boolean required
      Deprecated.
      use optionLevel = OptionLevel.Required instead
      java.lang.String shortOpt
      The short option for a command line argument.
      java.lang.String[] switchValue
      If specified, this option will be a no argument command line switch that will received the switchValue() if used.

    • Field Detail

      • STRING_LIST

        static final java.lang.String STRING_LIST
        Use for List methods

      • SORTED_STRING_LIST

        static final java.lang.String SORTED_STRING_LIST
        Use for List methods but when the UI should display the list in sorted order

      • STRING_TO_STRING_MAP

        static final java.lang.String STRING_TO_STRING_MAP
        Use for Map<String,String> methods

      • SPRING_BEAN

        static final java.lang.String SPRING_BEAN
        Use for any Object that should be pulled from spring

      • PASSWORD

        static final java.lang.String PASSWORD
        Used for any String method that should be rendered as a password

      • TEXT_AREA

        static final java.lang.String TEXT_AREA
        Used for any String method that should be rendered as a text area (aka multiple lines)

      • OPTION

        static final java.lang.String OPTION
        Used for selecting from among provided options

      • QUERY_LANGUAGE

        static final java.lang.String QUERY_LANGUAGE
        Used for selecting from among available query languages

      • HTTPS

        static final java.lang.String HTTPS
        Used for any String method that should be rendered as a HTTP, HTTPS option box

      • DOCUMENT_MODE

        static final java.lang.String DOCUMENT_MODE
        Used for any String method that should be rendered as an ingest document mode option box

      • TRUE_SWITCH_VALUE

        static final java.lang.String TRUE_SWITCH_VALUE
        Constant TRUE for switchValue()

      • FALSE_SWITCH_VALUE

        static final java.lang.String FALSE_SWITCH_VALUE
        Constant FALSE for switchValue()

    • Element Detail

      • shortOpt

        java.lang.String shortOpt
        The short option for a command line argument. Example: -A
        Default:
        ""

      • longOpt

        java.lang.String longOpt
        The long option for a command line argument. Example: --myoption
        Default:
        ""

      • messageProp

        java.lang.String messageProp
        Deprecated.
        No longer used.
        Default:
        ""

      • addDefaultValue

        boolean addDefaultValue
        If true, adds [Default = `default from class`] to the end of the description if default value != null.
        Default:
        true

      • hidden

        boolean hidden
        If true, hide from the command line option generation process, default = false.
        Default:
        false

      • description

        java.lang.String description
        Description for this option.
        Default:
        ""

      • required

        @Deprecated
boolean required
        Deprecated.
        use optionLevel = OptionLevel.Required instead
        A required option to be set for the containing bean.
        Default:
        false

      • optionLevel

        ConfigurationOption.OptionLevel optionLevel
        Determines if an option is required, basic or advanced.
        Default:
        com.attivio.sdk.server.annotation.ConfigurationOption.OptionLevel.Advanced

      • help

        java.lang.String help
        extra help text for this option
        Default:
        ""

      • displayName

        java.lang.String displayName
        displayed to the user in the admin interface
        Default:
        ""

      • formEntryClass

        java.lang.String formEntryClass
        Class to implement the Form Entry (see GWT Commons)
        Default:
        ""

      • switchValue

        java.lang.String[] switchValue
        If specified, this option will be a no argument command line switch that will received the switchValue() if used.
        Default:
        {}

      • labels

        java.lang.String[] labels
        Default:
        {}