Package com.sun.identity.console.property

Class AgentPropertyXMLBuilder

java.lang.Object

com.sun.identity.console.property.PropertyXMLBuilderBase

com.sun.identity.console.property.AgentPropertyXMLBuilder

All Implemented Interfaces:

PropertyTemplate

public class AgentPropertyXMLBuilder
extends PropertyXMLBuilderBase

This class is responsible for building agent configuration XML.

Field Summary

Fields inherited from class com.sun.identity.console.property.PropertyXMLBuilderBase

allAttributesReadonly, currentRealm, debug, mapSchemaTypeToName, mapSyntaxToName, mapTypeToAttributeSchema, mapTypeToName, mapUITypeToName, model, orderDisplaySchemaType, properties, serviceBundle, serviceName, supportSubConfig, svcSchemaManager, viewBeanName

Fields inherited from interface com.sun.identity.console.property.PropertyTemplate

ADD_REMOVE_COMPONENT_XML, ANY_ADMIN_DISPLAY, ANY_ADMIN_DISPLAYRO, ANY_DISPLAY, ANY_DISPLAYRO, ANY_REQUIRED, BLANK_VALUE, COMPONENT_ACTION_BUTTON_START_TAG, COMPONENT_ADD_REMOVE_DUPLICATION_EDIT_TAG, COMPONENT_BOOLEAN_START_TAG, COMPONENT_BUTTON_START_TAG, COMPONENT_EDITABLE_LIST_START_TAG, COMPONENT_END_TAG, COMPONENT_GLOBAL_MAP_LIST_START_TAG, COMPONENT_LINK_START_TAG, COMPONENT_MAP_LIST_START_TAG, COMPONENT_ORDERED_LIST_START_TAG, COMPONENT_PWD_START_TAG, COMPONENT_START_TAG, COMPONENT_UNORDERED_LIST_START_TAG, COMPONENT_UPLOAD_BUTTON_START_TAG, DATE_MARKER, DATE_MARKER_NAME, DEFAULT_TEXTFIELD_SIZE, DEFINITION, DYN_GUI_MULTIPLE_LIST_CHECKBOX_MARKER, DYN_GUI_MULTIPLE_LIST_CHECKBOX_PREFIX, DYN_GUI_MULTIPLE_LIST_CHECKBOX_XML, DYN_GUI_MULTIPLE_LIST_MARKER_XML, END_TAG, GROUP_END_TAG, GROUP_START_TAG, HELP_TAG, LABEL_PWD_TAG, LABEL_TAG, LIST_SIZE_TAG, MULTIPLE_ATTRIBUTE_TAG, NO_AUTO_SUBMIT, NON_LOCALIZED_FIELD, NULL_TYPE, OPTION_LABEL_ATTR_NAME, OPTION_TAG, OPTION_TAG_NAME, OPTION_VALUE_ATTR_NAME, PARAM_ATTR_NAME, PARAM_PROPERTIES_VIEW_BEAN_URL, PASSWORD_VALUE_TAG, PROPERTY_END_TAG, PROPERTY_REQUIRED_START_TAG, PROPERTY_START_OPEN_TAG, PROPERTY_START_TAG, PWD_CONFIRM_SUFFIX, READONLY_START_TAG, SECTION_DUMMY_START_TAG, SECTION_END_TAG, SECTION_START_TAG, START_TAG, STATIC_TEXT_TAG_NAME, SUB_CONFIG_TABLE_VIEW_BEAN, SUB_CONFIG_TABLE_XML, SUBSECTION_DUMMY_START_TAG, SUBSECTION_END_TAG, SUBSECTION_START_TAG, TAGNAME_BUTTON, TAGNAME_CHECKBOX, TAGNAME_DROPDOWN_MENU, TAGNAME_EDITABLE_LIST, TAGNAME_GLOBAL_MAP_LIST, TAGNAME_HREF, TAGNAME_MAP_LIST, TAGNAME_MULTIPLE_CHOICE, TAGNAME_ORDERED_LIST, TAGNAME_PASSWORD, TAGNAME_TEXTAREA, TAGNAME_TEXTFIELD, TAGNAME_UNORDERED_LIST, TEXTAREA_SIZE_TAG, TEXTBOX_SIZE_TAG, VALUE_OPTION_TAG, VALUE_OPTION_TAG_NAME

Constructor Summary

Constructors

Constructor	Description
AgentPropertyXMLBuilder(String agentType, boolean bGroup, boolean olderAgentType, String tab, AMModel model)	Constructor

Method Summary

Modifier and Type	Method	Description
Set	getAttributeSchemas()	Returns a set of attribute schemas for generating the XML.
String	getXML(Set readonly, String choice)	Returns a XML for displaying attribute in property sheet.

Methods inherited from class com.sun.identity.console.property.PropertyXMLBuilderBase

appendXMLProperty, buildAttributeSchemaTypeXML, buildConfirmPasswordXML, buildReadonlyXML, buildSchemaTypeXML, buildSchemaTypeXML, buildSchemaTypeXML, escapeSpecialChars, filterAttributes, filterHiddenAttributes, formPropertySheetXML, formPropertySheetXML, getAttributeNameForPropertyXML, getAttributeSchemaForSection, getCurrentRealm, getMultipleChoiceCheck, getServiceResourceBundle, getServiceResourceBundle, getServiceSchemaManager, getViewBeanName, getXMLDefinitionHeader, hasAnyAttribute, insertXML, insertXML, isSubConfigSupported, prependXMLProperty, removeAttributeSchemaWithoutI18nKey, removeSubSection, setAllAttributeReadOnly, setCurrentRealm, setSupportSubConfig, setViewBeanName, swapXMLProperty, tagSwap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgentPropertyXMLBuilder

public AgentPropertyXMLBuilder(String agentType,
                               boolean bGroup,
                               boolean olderAgentType,
                               String tab,
                               AMModel model)
                        throws SMSException,
                               SSOException

Constructor

Parameters:

agentType - Type of agent

bGroup - true if this is for agent group.

olderAgentType - true if agent is older ones like 2.2 agent

tab - Tab name.

model - Model for getting localized string and user locale.

Throws:

SMSException - if attribute schema cannot obtained.

SSOException - if single sign on token is invalid.

Method Detail

getXML

public String getXML(Set readonly,
                     String choice)
              throws SMSException,
                     SSOException,
                     AMConsoleException

Returns a XML for displaying attribute in property sheet.

Parameters:

readonly - Set of readonly attribute names.

choice - Choice of type of configuration.

Returns:

XML for displaying attribute in property sheet.

Throws:

SMSException - if attribute schema cannot obtained.

SSOException - if single sign on token is invalid.

AMConsoleException - if there are no attribute to display.

getAttributeSchemas

public Set getAttributeSchemas()

Returns a set of attribute schemas for generating the XML.

Overrides:

getAttributeSchemas in class PropertyXMLBuilderBase

Returns:

a set of attribute schemas for generating the XML.