|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.sm.ChoiceValues
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
.
Constructor Summary | |
ChoiceValues()
|
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 |
Constructor Detail |
public ChoiceValues()
Method Detail |
public abstract java.util.Map getChoiceValues()
java.util.Map
. Key being the choice and the value
being the I18N keypublic java.util.Map getChoiceValues(java.util.Map envParams)
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.
envParams
- environment parameters
java.util.Map
. Key being the choice and the value
being the I18N keypublic final java.lang.String getAttributeName()
public final java.util.Map getConfiguredKeyValues()
public final org.w3c.dom.Node getAttributeSchemaNode()
AttributeSchema
node associated
with this attribute
AttributeSchema
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |