Package org.identityconnectors.framework.spi

Annotation Interface 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
Version:
$Revision: /main/3 $
Author:
Will Droste

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    attributes
    List of attributes for which this property must be specified.
    boolean
    confidential
    Is this a confidential property whose value should be encrypted by the application when persisted?
    String
    displayMessageKey
    Change the default display message key.
    String
    helpMessageKey
    Change the default help message key.
    String[]
    objectClasses
    List of object classes for which this property must be specified.
    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 Details

    • order

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

    • helpMessageKey

      String helpMessageKey
      Change the default help message key.
      Default:
      ""

    • displayMessageKey

      String displayMessageKey
      Change the default display message key.
      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 iff the property is required
      Default:
      false

    • operations

      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:
      {}

    • objectClasses

      String[] objectClasses
      List of object classes for which this property must be specified. The default value of "empty array" is special in that it means that this property is applicable to all object classes.
      Default:
      {}

    • attributes

      String[] attributes
      List of attributes for which this property must be specified. The default value of "empty array" is special in that it means that this property is applicable to all attributes.
      Default:
      {}