Package org.identityconnectors.framework.spi

Annotation Type 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
    Author:
    Will Droste

    • Element Detail

      • 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:
        ""

      • groupMessageKey

        String groupMessageKey
        Grouping of properties for UI.
        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 if 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:
        {}

      • allowedValues

        String[] allowedValues
        List of allowed values for the property. The values are specified as a list of strings. They are converted to appropriate data format before use.
        Since:
        1.5.2.0
        Default:
        {}

      • allowedValuesOpenness

        ValueListOpenness allowedValuesOpenness
        Specification of openness of list of allowed values. In closed list, values specified in the list are the only valid values for the property. Any unlisted value is considered to be invalid. In open list, the values specified in the list should be considered suggestions only. Even an unlisted value can be specified as a valid value of the property.
        Since:
        1.5.2.0
        Default:
        org.identityconnectors.framework.common.objects.ValueListOpenness.CLOSED