org.identityconnectors.framework.spi

Annotation Type ConfigurationProperty

@Retention(value=RUNTIME)
 @Target(value=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 and Description
java.lang.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?
java.lang.String	displayMessageKey Change the default display message key.
java.lang.String	helpMessageKey Change the default help message key.
java.lang.String[]	objectClasses List of object classes for which this property must be specified.
java.lang.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 Detail

order

public abstract int order

Order in which this property is displayed.

Default:

-1

helpMessageKey

public abstract java.lang.String helpMessageKey

Change the default help message key.

Default:

""

displayMessageKey

public abstract java.lang.String displayMessageKey

Change the default display message key.

Default:

""

confidential

public abstract boolean confidential

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

Default:

false

required

public abstract boolean required

Is this property required?

Returns:

True iff the property is required

Default:

false

operations

public abstract java.lang.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

public abstract java.lang.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

public abstract java.lang.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:

{}