Package org.forgerock.openidm.tools.scriptedbundler

Class ProvidedProperty

java.lang.Object
org.forgerock.openidm.tools.scriptedbundler.CustomBaseObject
org.forgerock.openidm.tools.scriptedbundler.ProvidedProperty
public class ProvidedProperty extends CustomBaseObject
A single connector configuration property, contained in CustomConfiguration. The JSON configuration might contain something like the following: 
 "providedProperties" : [
      {
          "name" : "FirstProperty",
          "value" : "firstValue",
          "type" : "String"
      }, {
          "name" : "SecondProperty",
          "value" : 1.234,
          "type" : "Float"
      }
  ]
This object represents a single property in the list above. These properties populate values for the properties defined by default in the connector's base configuration class. For example, the ScriptedSQLConfiguration class provides for a "name" property and a "password" property (among others). To preset these values or even set a default in the connector's provisioner config a developer would add providedProperties for name and password.

  • Constructor Details

    • ProvidedProperty

      public ProvidedProperty()

  • Method Details

    • getName

      public String getName()
      Return the name of this property.
      Returns:

    • getNameCamelCase

      public String getNameCamelCase()
      Template utility method to lower-case the first character of the name attribute.
      Returns:

    • setName

      public void setName(String name)
      Set the name of this property.
      Parameters:
      name -

    • getValue

      public Object getValue()
      Return the default value of this property.
      Returns:

    • setValue

      public void setValue(Object value)
      Set the default value of this property.
      Parameters:
      value -

    • getFormattedValue

      public Object getFormattedValue()
      Helper method for handlebars template, not a configuration parameter.
      Returns:

    • getType

      public String getType()
      Return the type of this property. Enhanced getter to enforce supported types
      Returns:

    • setType

      public void setType(String type)
      Set the type of this property. Enhanced setter to enforce supported types
      Parameters:
      type -