| java.lang.Object
 com.sun.ssoadapter.config.Configuration
| Configuration | | public class Configuration implements ConfigurationConstants(Code) | | This class acts as a container for either raw, or aggregated configuration
information.
A "configuration" is a collection of information comprised of
the following:
- A HashMap of
String arrays.
- A configuration name.
- A configuration type.
- A list of "listeners" to be notified in the event of a change
in the data in the HashMap.
Constructors are provided such that an empty Configuration
object may be instantiated, or may be initialized via a URL string
representation. Note that Configuration objects
have no direct linkage to a storage/retrieval mechanism, i.e.,
changes in a particular Configuration object are not
automatically reflected and/or reconciled to any form of persistent
database, e.g., a directory.
Methods are provided, appropriate for the manipulation of information
contained within a Configuration object.
See Also: com.sun.ssoadapter.config.ConfigurationFactory
See Also: com.sun.ssoadapter.config.ConfigurationListener
See Also: com.sun.ssoadapter.config.ConfigurationConstants
See Also: com.sun.ssoadapter.config.ConfigurationException |
| Constructor Summary | |
| public | Configuration()
Constructs an empty Configuration. | | public | Configuration(String configURLString)
Constructs a Configuration, based on a URL string. |
| Configuration | | public Configuration()(Code) | | Constructs an empty Configuration.
- An empty HashMap is created.
- The configuration name is set to
null.
- The configuration type is set to
null.
- The list of listeners is empty.
|
| Configuration | | public Configuration(String configURLString)(Code) | | Constructs a Configuration, based on a URL string.
Configuration information is derived from
the conventional syntactic components of a URL,
and includes all parameters that may be
present in a query string. The standard configuration
properties that are extracted from the URL and stored within the
HashMap are:
- protocol
- host
- port
- uid
- password
Two query string parameters are treated specially:
These values are stored within the Configuration
object, but not within the HashMap.
|
| addListener | | public void addListener(ConfigurationListener listener)(Code) | | Registers a ConfigurationListener.
Listeners will be notified whenever any of the following
methods are invoked upon this object:
setProperty()
setPropertyArray()
setHashMap()
|
| getConfigurationDescription | | public String getConfigurationDescription()(Code) | | Returns the configuration type of this Configuration object.
|
| getConfigurationName | | public String getConfigurationName()(Code) | | Returns the configuration name of this Configuration object.
|
| getConfigurationURL | | public String getConfigurationURL()(Code) | | Create a URL representation of this Configuration object.
A URL will be formed, with values derived from this
Configuration object's HashMap as well
configuration name and type. The URL will be of the following
form:
<protocol>://<uid>:<password>@<host>:<port>/?<queryString>
Where <queryString> contains parameters that define:
as well as all other property values that are not expressed by the
standard URL syntactic components.
Note: Owing to certain syntactic ambiguity of URL syntax in
this application, if the configuration property "protocol" is not
specified, a protocol of "undef" will appear in the resulting URL.
|
| getEncodedPropertiesList | | public List getEncodedPropertiesList()(Code) | | |
| getHashMap | | public HashMap getHashMap()(Code) | | Returns all properties as a HashMap of String
arrays.
Modifications to this HashMap in effect change the
properties associated with this Configuration object.
|
| getProperty | | public String getProperty(String key)(Code) | | Returns the first element of a configuration property.
Parameters:
key - Identifies the name of the configuration property to get. |
| getProperty | | public String getProperty(String key, String defaultVal)(Code) | | Returns the first element of a configuration property.
Parameters:
key - Identifies the name of the configuration property to get.
Parameters:
defaultVal - Specifies default value if property doesn't exist. |
| getPropertyArray | | public String[] getPropertyArray(String key)(Code) | | Returns all values of a configuration property as a String
array.
Parameters:
key - Identifies the name of the configuration property to get. |
| getUserPropertiesList | | public List getUserPropertiesList()(Code) | | |
| removeProperty | | public void removeProperty(String key)(Code) | | Removes a property.
Once the property is removed, all registered listeners are notified of
the change.
Parameters:
key - Identifies the name of the configuration property to remove. |
| removePropertyArray | | public void removePropertyArray(String key, String[] keyset)(Code) | | Removes a property in a Property Array
Once the property is removed, all registered listeners are notified of
the change.
Parameters:
key - Identifies the name of the configuration property array .
Parameters:
keyset - The keys to remove in the property array |
| setAsEncodedProperty | | public void setAsEncodedProperty(String key)(Code) | | |
| setAsUserProperty | | public void setAsUserProperty(String key)(Code) | | |
| setConfigurationDescription | | public void setConfigurationDescription(String desc)(Code) | | Sets the configuration type of this Configuration object.
Parameters:
type - The configuration type. |
| setConfigurationName | | public void setConfigurationName(String name)(Code) | | Sets the configuration name of this Configuration object.
Parameters:
name - The configuration name. |
| setHashMap | | public void setHashMap(HashMap hashMap)(Code) | | Replaces the HashMap of this Configuration
object.
Once the HashMap is set, all registered listenters are
notified of the change.
Parameters:
hashMap - The HashMap that this Configurationobject will now reference. |
| setProperty | | public void setProperty(String key, String value)(Code) | | Sets a single valued property.
Once the value is set, all registered listeners are notified of
the change.
Parameters:
key - Identifies the name of the configuration property to set.
Parameters:
val - The value to be set. |
| setPropertyArray | | public void setPropertyArray(String key, String[] values)(Code) | | Sets a multi-valued property.
Once the value is set, all registered listeners are notified of
the change.
Parameters:
key - Identifies the name of the configuration property to set.
Parameters:
val - The values to be set. |
| toString | | public String toString()(Code) | | Returns the string representation of this Configuration
object.
See getConfigurationURL().
|
|
|