Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Metadata nameJSON typeDefaultExample valueDescription
multiplebooleanfalsetrue/falseif comma separated values
mustExtendClassString
a.b.c.SomeClassIf the value is a class and must extend another class
mustImplementInterfaceString
a.b.c.SomeInterfaceIf the value is a class and must extend an interface

regex

String
^configuration.autocreate.group.description.[0-9]+$If the key must match a certain regex
requiredbooleanfalsetrue/falseIf a value must be provided
requiresRestartbooleanfalsetrue/falseIf the JVM needs to be restarted when changing value
sampleValueString
SomethingAn example value that shows the user how to configure
sensitivebooleanfalsetrue/falseIf the value can be a password or something sensitive
valueTypeStringString

attributeDef, attributeDefName, boolean, class, floating, group, integer, password, stem, string, subject

From enum ConfigItemMetadataType, the type of the value
formElement (new in 2.5 build)Stringtext for most things and password for sensitive itemstext, textarea, password, dropdown;From enum ConfigItemFormElement
optionValuesString[]
if this is a dropdown then this is the option values available


Configuration file layout

...