Package oracle.tip.pc.services.identity.config

Class Configuration

java.lang.Object
java.util.Dictionary<K,V>
java.util.Hashtable<Object,Object>
java.util.Properties
oracle.tip.pc.services.identity.config.ConfigurationProperties
oracle.tip.pc.services.identity.config.Configuration
All Implemented Interfaces:
Serializable, Cloneable, Map<Object,Object>
public class Configuration extends ConfigurationProperties
This class represents configuration as described in the configuration file.
Since:
release specific (what release of product did this appear in)
See Also:

  • Constructor Details

    • Configuration

      public Configuration(ISConfiguration isconfig, Element element) throws BPMConfigException
      Constructor Constructs a Configuration object out of the XML element. This element is expected to adhere to the schema definition.
      Parameters:
      isconfig - An ISConfiguration instance that is obtained using the ISConfigurationService. This instance is the parent of this Configuration. It can be null.
      element - An XML element representing the configuration.
      Throws:
      BPMConfigException - If the element is malformed.

    • Configuration

      public Configuration(ISConfiguration isconfig, ConfigurationType config) throws BPMConfigException
      Constructor Constructs a Configuration object out of the JAXB model object.
      Parameters:
      isconfig - An ISConfiguration instance that is obtained using the ISConfigurationService. This instance is the parent of this Configuration. It can be null.
      config - A JAXB model object representing the Configration.
      Throws:
      BPMConfigException - If the model object does not have a realm associated with it.

    • Configuration

      public Configuration(Element element) throws BPMConfigException
      Constructor Constructs a Configuration object out of the XML element. This element is expected to adhere to the schema definition.
      Parameters:
      element - An XML element representing the configuration.
      Throws:
      BPMConfigException - If the element is malformed.

  • Method Details

    • getISConfiguration

      public ISConfiguration getISConfiguration()
      Gets the parent ISConfiguration of this configuration. Value is null if non is associated.
      Returns:
      An ISConfiguration instance or null.

    • getRealmName

      public String getRealmName()
      Gets the name of the logical realm associated with this configuration.
      Returns:
      Name of the logical realm.

    • getDisplayName

      public String getDisplayName()
      Gets display name associated with this configuration.
      Returns:
      display name

    • isDefault

      public boolean isDefault()
      Check if configuration is default
      Returns:
      true if default, else false

    • setDefault

      public boolean setDefault()
      Set configuration to be default

    • getProviders

      public Map getProviders()
      Gets a Map of the providers associated with this configuration. The Map has ProviderCfg instnaces with the service name as the key.
      Returns:
      Map(SerivceName, ProviderCfg)

    • getProviderCfg

      public ProviderCfg getProviderCfg(String serviceName) throws BPMConfigException
      Gets a ProviderCfg associated with the given service name. If no provider is found, then the default is returned.
      Parameters:
      serviceName - The name of the service for which a provider is to be fetched.
      Returns:
      ProviderCfg
      Throws:
      BPMConfigException - If there are no providers associated at all.

    • toXMLElement

      public Element toXMLElement(Document doc, Element rootElt)
      Returns an XMLElement representation of this configuration.
      Parameters:
      doc - A Document which is expected to contain this configuration as a child.
      rootElt - An element that is to contain this configuration as a child.
      Returns:
      root Element. Returns null if a problem is encountered.

    • hashCode

      public int hashCode()
      hash code for ISConfiguration
      Specified by:
      hashCode in interface Map<Object,Object>
      Overrides:
      hashCode in class Properties
      Returns:
      hash code

    • equals

      public boolean equals(Object obj)
      Check if object same
      Specified by:
      equals in interface Map<Object,Object>
      Overrides:
      equals in class Properties
      Parameters:
      obj -
      Returns:
      true, if same, else false

    • toString

      public String toString()
      To String
      Overrides:
      toString in class ConfigurationProperties
      Returns:
      string representation

    • getServiceExtensions

      public Map<String,ServiceExtensionType> getServiceExtensions()
      Gets a ServiceExtesnions defined for the configurations

    • getServiceProviderInstance

      public IServiceProvider getServiceProviderInstance(ServiceProviderExtensionType serviceProviderType) throws BPMIdentityException
      Gets the instance of the service provider from the configuration. If the configuration does not have the provider defined, returns null;
      Parameters:
      serviceProviderType -
      Returns:
      Throws:
      BPMIdentityException