Package com.sun.identity.policy

Class ActionSchema

  • public class ActionSchema
extends AttributeSchemaImpl
    The class ActionSchema provides interfaces to obtain meta information about service action values. For example, information about the syntax of the action values, defaults values, choice values, etc.

    • Constructor Detail

      • ActionSchema

        protected ActionSchema​(Node node)
        Constructor with the action schema node
        Parameters:
        node - Node representing w3c DOM representation of the object.

    • Method Detail

      • getActionValues

        public Set getActionValues()
        Returns a Set of possible action values if the action schema is of choice type ie SINGLE_CHOICE or MULTIPLE_CHOICE in the service schema definition. The choice values are sorted alphabetically in the ascending order. If the action values are not of choice type, this method return an empty Set and not null.
        Returns:
        choice values for action values

      • getActionValueI18NKey

        public String getActionValueI18NKey​(String actionValue)
        Returns the I18N key for the action value. This method can be used only when the action schema is of type SINGLE_CHOICE or MULTIPLE_CHOICE. Also each action value must have defined its i18nKey in the XML.
        Returns:
        i18n key for the action value if present in the service XML; null otherwise

      • requiresResourceName

        public boolean requiresResourceName()
        Returns true if the action requires a resource name. An action can have a resource name only if its type is either SINGLE_CHOICE or MULTIPLE_CHOICE, or if its syntax is boolean.
        Returns:
        true if the action name requires a resource name; false otherwise

      • getResourceNames

        public Set getResourceNames​(String actionValue)
        Returns the default resource names associated with the action value. If it is not configured, it returns an empty Set.
        Returns:
        default resource names associated with the action value

      • getResourceNameI18NKey

        public String getResourceNameI18NKey​(String actionValue)
        Returns the I18N key for displaying resource names associated with the action value. If it is not configured, it returns null.
        Returns:
        String representing i18nKey for displaying resource names.