Annotation Type ConfigurationProperty


  • @Retention(RUNTIME)
    @Target(METHOD)
    public @interface ConfigurationProperty
    The Configuration interface is traversed through reflection. This annotation provides a way to override the default configuration operation for each property.
    Since:
    1.0
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean confidential
      Is this a confidential property whose value should be encrypted by the application when persisted?
      java.lang.String displayMessageKey
      Change the default display message key.
      java.lang.String groupMessageKey
      Grouping of properties for UI.
      java.lang.String helpMessageKey
      Change the default help message key.
      java.lang.Class<? extends SPIOperation>[] operations
      List of operations for which this property must be specified.
      int order
      Order in which this property is displayed.
      boolean required
      Is this property required?
    • Element Detail

      • order

        int order
        Order in which this property is displayed.
        Default:
        -1
      • helpMessageKey

        java.lang.String helpMessageKey
        Change the default help message key.
        Default:
        ""
      • displayMessageKey

        java.lang.String displayMessageKey
        Change the default display message key.
        Default:
        ""
      • groupMessageKey

        java.lang.String groupMessageKey
        Grouping of properties for UI.
        Default:
        ""
      • confidential

        boolean confidential
        Is this a confidential property whose value should be encrypted by the application when persisted?
        Default:
        false
      • required

        boolean required
        Is this property required?
        Returns:
        True if the property is required
        Default:
        false
      • operations

        java.lang.Class<? extends SPIOperation>[] operations
        List of operations for which this property must be specified. This is used for the case where a connector may or may not implement certain operations depending in the configuration. The default value of "empty array" is special in that it means that this property is applicable to all operations.
        Default:
        {}