|
Oracle® Fusion Middleware .NET API Reference for Identity Connector Framework
E57662-01
|
|
Oracle® Fusion Middleware .NET API Reference for Identity Connector Framework
E57662-01
|
Encapsulates the configuration of a connector. More...
Inherited by Org.IdentityConnectors.Framework.Spi.AbstractConfiguration.
Public Member Functions | |
| void | Validate () |
| Determines if the configuration is valid. More... | |
Properties | |
| ConnectorMessages | ConnectorMessages [get, set] |
| Gets or sets the message catalog instance that allows the Connector to localize messages. The setter is called before any bean property setter, the M:Validate method or this property getter. More... | |
Encapsulates the configuration of a connector.
Implementations of the Configuration interface must have a default constructor. All properties are considered configuration for the connector. The initial value of the property is considered the default value of the property. The types of the properties can be only those returned by M:Org.IdentityConnectors.Framework.Common.FrameworkUtil.GetAllSupportedConfigTypes and multi-dimensional arrays thereof. The properties are not required by default, but a property can be marked as required through use of the ConfigurationPropertyAttribute.
Each property corresponds to two entries in a resource named Messages: [Property].display and [Property].help. For example, hostname.help and hostname.display would be the keys corresponding to a hostname property. The display message is the display name of the property and can be used to display the property in a view. The help message holds the description of the property. The names of the two keys can be overridden through the ConfigurationProperty annotation.
| void Org.IdentityConnectors.Framework.Spi.Configuration.Validate | ( | ) |
Determines if the configuration is valid.
A valid configuration is one that is ready to be used by the connector: it is complete (all the required properties have been given values) and the property values are well-formed (are in the expected range, have the expected format, etc.)
Implementations of this method should not connect to the resource in an attempt to validate the configuration. For example, implementations should not attempt to check that a host of the specified name exists by making a connection to it. Such checks can be performed in the implementation of the M:Org.IdentityConnectors.Framework.Spi.Operations.TestOp.Test method.
| System.Exception | iff the configuration is not valid. Implementations are encouraged to throw the most specific exception available. When no specific exception is available, implementations can throw Org.IdentityConnectors.Framework.Common.Exceptions.ConfigurationException. |
Implemented in Org.IdentityConnectors.Framework.Spi.AbstractConfiguration.
|
getset |
Gets or sets the message catalog instance that allows the Connector to localize messages. The setter is called before any bean property setter, the M:Validate method or this property getter.
