Package org.odpi.openmetadata.frameworks.connectors.controls

Class ConfigurationPropertyType

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.controls.ConfigurationPropertyType
public class ConfigurationPropertyType extends Object
ConfigurationPropertyType characterises one of the configuration parameters supported by a specific connector. This enables the capability of a connector to be correctly matched to the resources and elements that it works with.

  • Constructor Details

    • ConfigurationPropertyType

      public ConfigurationPropertyType()
      Default constructor

    • ConfigurationPropertyType

      public ConfigurationPropertyType(ConfigurationPropertyType template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getName

      public String getName()
      Return the string to use as the name of the configuration property.
      Returns:
      string name

    • setName

      public void setName(String name)
      Set up the string to use as the name of the configuration property.
      Parameters:
      name - string name

    • getDescription

      public String getDescription()
      Return the description of the configuration property.
      Returns:
      string

    • setDescription

      public void setDescription(String description)
      Set up the description of the configuration property.
      Parameters:
      description - string

    • getDataType

      public String getDataType()
      Return the data type name for the configuration property value.
      Returns:
      data type

    • setDataType

      public void setDataType(String dataType)
      Set up data type name for the configuration property value.
      Parameters:
      dataType - data type

    • getExample

      public String getExample()
      Return an example configuration property value.
      Returns:
      string

    • setExample

      public void setExample(String example)
      Set up an example configuration property value.
      Parameters:
      example - string

    • getRequired

      public boolean getRequired()
      Return whether this configuration property is required for this connector to work successful.
      Returns:
      boolean flag

    • setRequired

      public void setRequired(boolean required)
      Set up whether this configuration property is required for this connector to work successful.
      Parameters:
      required - boolean flag

    • getOtherPropertyValues

      public Map<String,String> getOtherPropertyValues()
      Return a map of property name to property value to provide additional information for this configuration property.
      Returns:
      map of string to string

    • setOtherPropertyValues

      public void setOtherPropertyValues(Map<String,String> otherPropertyValues)
      Set up a map of property name to property value to provide additional information for this configuration property.
      Parameters:
      otherPropertyValues - map of string to string

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code