org.identityconnectors.framework.api

Interface ConfigurationProperty

All Known Implementing Classes:

ConfigurationPropertyImpl

public interface ConfigurationProperty

Represents at the API level a property of a Connector's Configuration at the SPI layer.

Method Summary

Modifier and Type	Method and Description
SuggestedValues	getAllowedValues() Returns list of allowed values for the property.
String	getDisplayName(String def) Get the display name for this configuration property.
String	getGroup(String def) Get name of the group for this configuration property.
String	getHelpMessage(String def) Get the help message from the message catalog.
String	getName() Get the unique name of the configuration property.
Set<Class<? extends APIOperation>>	getOperations() Set of operations for which this property must be specified.
Class<?>	getType() Get the type of the property.
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(Object o) Set the value of the property.

Method Detail

getName

String getName()

Get the unique name of the configuration property.

getHelpMessage

String getHelpMessage(String def)

Get the help message from the message catalog.

getDisplayName

String getDisplayName(String def)

Get the display name for this configuration property.

getGroup

String getGroup(String def)

Get name of the group for this configuration property.

getValue

Object getValue()

Get the value from the property. This value should be the default value.

setValue

void setValue(Object o)

Set the value of the property.

getType

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

Set<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.

getAllowedValues

SuggestedValues getAllowedValues()

Returns list of allowed values for the property. If a closed list is returned, values specified in the list are the only valid values for the property. Any other value is invalid. If an open list is returned, 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. If null is returned, there are no restrictions or suggestions for this property.

Since:

1.5.2.0