Package org.identityconnectors.framework.api

Interface ConfigurationProperty

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName​(java.lang.String def)
      Get the display name for this configuration property.
      java.lang.String getGroup​(java.lang.String def)
      Get name of the group for this configuration property.
      java.lang.String getHelpMessage​(java.lang.String def)
      Get the help message from the message catalog.
      java.lang.String getName()
      Get the unique name of the configuration property.
      java.util.Set<java.lang.Class<? extends APIOperation>> getOperations()
      Set of operations for which this property must be specified.
      java.lang.Class<?> getType()
      Get the type of the property.
      java.lang.Object getValue()
      Get the value from the property.
      boolean isConfidential()
      Is this a confidential property whose value should be encrypted by the application when persisted?
      boolean isRequired()
      Is this a required property
      void setValue​(java.lang.Object o)
      Set the value of the property.

    • Method Detail

      • getName

        java.lang.String getName()
        Get the unique name of the configuration property.

      • getHelpMessage

        java.lang.String getHelpMessage​(java.lang.String def)
        Get the help message from the message catalog.

      • getDisplayName

        java.lang.String getDisplayName​(java.lang.String def)
        Get the display name for this configuration property.

      • getGroup

        java.lang.String getGroup​(java.lang.String def)
        Get name of the group for this configuration property.

      • getValue

        java.lang.Object getValue()
        Get the value from the property. This value should be the default value.

      • setValue

        void setValue​(java.lang.Object o)
        Set the value of the property.

      • getType

        java.lang.Class<?> getType()
        Get the type of the property.

      • isConfidential

        boolean isConfidential()
        Is this a confidential property whose value should be encrypted by the application when persisted?

      • isRequired

        boolean isRequired()
        Is this a required property
        Returns:
        True if the property is required

      • getOperations

        java.util.Set<java.lang.Class<? extends APIOperation>> getOperations()
        Set 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.