com.sun.identity.sm
Class  DefaultValues
java.lang.Object
  |
  +--com.sun.identity.sm.DefaultValues
- public abstract class DefaultValues- extends java.lang.Object
The abstract class DefaultValues provides a mechanism
 for services to obtain their default values dynamically instead of
 being statically defined in the service XML file stored in the
 directory. 
 An implementation of this class must be specified in the service
 configuration XML file in the definition of the respective attribute
 schema. Instead of providing the default values in the XML configuration
 file, the class name must be specified within the XML node
 DefaultValuesClassName.
 
| Method Summary | 
|  java.lang.String | getAttributeName()Returns the name of the attribute for which the default values 
 will be returned.
 | 
|  org.w3c.dom.Node | getAttributeSchemaNode()Returns the XML
 AttributeSchemanode associated
 with this attribute | 
|  java.util.Map | getConfiguredKeyValues()Returns the configured key-value pairs for the class in the
 service's configuration file
 | 
| abstract  java.util.Set | getDefaultValues()Abstract method that must be implemented by a class extending
 this interface, and should return the default values for the
 attribute.
 | 
|  java.util.Set | getDefaultValues(java.util.Map envParams)Returns a Set of default values for the attribute, given
 the environment parameters.
 | 
 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
DefaultValues
public DefaultValues()
getDefaultValues
public abstract java.util.Set getDefaultValues()
- Abstract method that must be implemented by a class extending
 this interface, and should return the default values for the
 attribute.- 
- Returns:
- defaults values for the attribute as a
 java.util.Set
 
getDefaultValues
public java.util.Set getDefaultValues(java.util.Map envParams)
- Returns a Set of default values for the attribute, given
 the environment parameters. The default implementation
 calls the interface getDefaultValues()which takes no parameters. The class extending this
 class can override this method to take advantage of
 the additional environment parameters.
- 
- Returns:
- defaults values for the attribute as a
 java.util.Set
 
getAttributeName
public final java.lang.String getAttributeName()
- Returns the name of the attribute for which the default values 
 will be returned.- 
- Returns:
- the name of attribute for which the default values are returned
 
getConfiguredKeyValues
public final java.util.Map getConfiguredKeyValues()
- Returns the configured key-value pairs for the class in the
 service's configuration file- 
- Returns:
- key-value pairs configured for this class in the service
 schema XML file
 
getAttributeSchemaNode
public final org.w3c.dom.Node getAttributeSchemaNode()
- Returns the XML AttributeSchemanode associated
 with this attribute
- 
- Returns:
- XML node of AttributeSchema
 
Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.