com.sun.identity.sm
Class ChoiceValues
java.lang.Object
|
+--com.sun.identity.sm.ChoiceValues
- public abstract class ChoiceValues
- extends java.lang.Object
The abstract class ChoiceValues
provides a mechanism
for services to provide choice values for attributes 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 choice values in the XML configuration
file, the class name must be specified within the XML node
ChoiceValuesClassName
.
Method Summary |
java.lang.String |
getAttributeName()
Returns the name of the attribute for which the choice values
will be returned. |
org.w3c.dom.Node |
getAttributeSchemaNode()
Returns the XML AttributeSchema node associated
with this attribute |
abstract java.util.Map |
getChoiceValues()
Abstract method that must be implemented by a class extending
this class, and should return the choice values and their
corresponding I18N key, for the attribute. |
java.util.Map |
getChoiceValues(java.util.Map envParams)
Returns the choice values for attribute for the given
environment parameters. |
java.util.Map |
getConfiguredKeyValues()
Returns the configured key-value pairs for the class in the
service's configuration file |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ChoiceValues
public ChoiceValues()
getChoiceValues
public abstract java.util.Map getChoiceValues()
- Abstract method that must be implemented by a class extending
this class, and should return the choice values and their
corresponding I18N key, for the attribute.
- Returns:
- choice values for the attribute as a
java.util.Map
. Key being the choice and the value
being the I18N key
getChoiceValues
public java.util.Map getChoiceValues(java.util.Map envParams)
- Returns the choice values for attribute for the given
environment parameters. The default implementation calls
the interface
getChoiceValues
without the
parameter. A class extending this class can override
this method to return the choice values and their
corresponding I18N key, for the attribute.
- Parameters:
envParams
- environment parameters- Returns:
- choice values for the attribute as a
java.util.Map
. Key being the choice and the value
being the I18N key
getAttributeName
public final java.lang.String getAttributeName()
- Returns the name of the attribute for which the choice values
will be returned.
- Returns:
- the name of attribute for which the choice 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
AttributeSchema
node associated
with this attribute
- Returns:
- XML node of
AttributeSchema
Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.