Package org.identityconnectors.framework.api

Interface ConfigurationProperties

public interface ConfigurationProperties
Encapsulates the Configuration at the SPI layer and uses reflection to identify the individual properties that are available for an application to manipulate.

  • Method Details

    • getPropertyNames

      List<String> getPropertyNames()
      Get the list of properties names for this Configuration.
      Returns:
      a list containing the names of properties that an application can configure for a connector.

    • getPropertyNames

      List<String> getPropertyNames(ConfigurationFilter configFilter)
      Get the filtered list of properties names for this Configuration.
      Parameters:
      configFilter -
      Returns:
      a list containing the names of properties that an application can configure for a connector.

    • getProperty

      ConfigurationProperty getProperty(String name)
      Get a particular ConfigurationProperty by name.
      Parameters:
      name - the unique name of the property.
      Returns:
      a ConfigurationProperty if it exists otherwise null.

    • setPropertyValue

      void setPropertyValue(String name, Object value)
      Set the value of the Configuration property by name.
      Parameters:
      name - Name of the property to set the value against.
      value - Value to set on the configuration property.
      Throws:
      IllegalArgumentException - iff the property name does not exist.