Package com.sun.identity.console.property

Class PropertyXMLBuilder

java.lang.Object

com.sun.identity.console.property.PropertyXMLBuilderBase

com.sun.identity.console.property.PropertyXMLBuilder

All Implemented Interfaces:

PropertyTemplate

Direct Known Subclasses:

MultiServicesPropertyXMLBuilder

public class PropertyXMLBuilder
extends PropertyXMLBuilderBase

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
PropertyXMLBuilder(ServiceSchema serviceSchema, AMModel model)	Returns a XML for displaying attribute in property sheet.
PropertyXMLBuilder(ServiceSchema serviceSchema, AMModel model, ResourceBundle serviceBundle, Map<SchemaType,List<String>> sectionForType, String sectionOrderFileName)	Returns a XML for displaying attribute in property sheet.
PropertyXMLBuilder(ServiceSchema serviceSchema, AMModel model, Set attributeSchemas)	Returns a XML for displaying attribute in property sheet.
PropertyXMLBuilder(String serviceName, AMModel model, Set attributeSchemas)
PropertyXMLBuilder(String serviceName, AMModel model, Set attributeSchemas, SchemaType schemaType)	Constructs a XML builder.
PropertyXMLBuilder(String serviceName, Set schemaTypes, AMModel model)	Returns a XML for displaying attribute in property sheet.

Method Summary

Modifier and Type	Method	Description
void	discardAttribute(Set discard)	Discards attributes from the builder.
String	getXML()	Returns a XML for displaying attribute in property sheet.
String	getXML(boolean bPropertySheetElementNode)	Returns a XML for displaying attribute in property sheet.
String	getXML(String realmName)	Returns an XML string for displaying attributes in a property sheet for a specific realm.
String	getXML(Set readonly)	Returns a XML for displaying attribute in property sheet.
String	getXML(Set readonly, boolean bPropertySheetElementNode)	Returns a XML for displaying attribute in property sheet.
protected void	onBeforeBuildingXML(Map<SchemaType,Set<AttributeSchema>> map)	Extends this method to selective drop attribute schema that you do not want to display.

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

appendXMLProperty, buildAttributeSchemaTypeXML, buildConfirmPasswordXML, buildReadonlyXML, buildSchemaTypeXML, buildSchemaTypeXML, buildSchemaTypeXML, escapeSpecialChars, filterAttributes, filterHiddenAttributes, formPropertySheetXML, formPropertySheetXML, getAttributeNameForPropertyXML, getAttributeSchemaForSection, getAttributeSchemas, 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

PropertyXMLBuilder

public PropertyXMLBuilder(String serviceName,
                          Set schemaTypes,
                          AMModel model)
                   throws SMSException,
                          SSOException

Returns a XML for displaying attribute in property sheet.

Parameters:

serviceName - Name of the service.

schemaTypes - Set of schema types to display.

model - Model for getting localized string and user locale.

Throws:

SMSException - if attribute schema cannot obtained.

SSOException - if single sign on token is invalid.

PropertyXMLBuilder

public PropertyXMLBuilder(ServiceSchema serviceSchema,
                          AMModel model)
                   throws SMSException,
                          SSOException

Returns a XML for displaying attribute in property sheet.

Parameters:

serviceSchema - Service schemas.

model - Model for getting localized string and user locale.

Throws:

SMSException - if attribute schema cannot obtained.

SSOException - if single sign on token is invalid.

PropertyXMLBuilder

public PropertyXMLBuilder(ServiceSchema serviceSchema,
                          AMModel model,
                          ResourceBundle serviceBundle,
                          Map<SchemaType,List<String>> sectionForType,
                          String sectionOrderFileName)
                   throws SMSException,
                          SSOException

Returns a XML for displaying attribute in property sheet.

Parameters:

serviceSchema - Service schemas.

model - Model for getting localized string and user locale.

serviceBundle - The service resource bundle.

sectionForType - A list of section headings for each schema type.

sectionOrderFileName - The name of the section attribute order file.

Throws:

SMSException - if attribute schema cannot obtained.

SSOException - if single sign on token is invalid.

PropertyXMLBuilder

public PropertyXMLBuilder(String serviceName,
                          AMModel model,
                          Set attributeSchemas)
                   throws SMSException,
                          SSOException

Throws:

SMSException

SSOException

PropertyXMLBuilder

public PropertyXMLBuilder(String serviceName,
                          AMModel model,
                          Set attributeSchemas,
                          SchemaType schemaType)
                   throws SMSException,
                          SSOException

Constructs a XML builder.

Parameters:

serviceName - Name of the service.

model - Model for getting localized string and user locale.

attributeSchemas - List of attributeSchema.

Throws:

SMSException - if attribute schema cannot obtained.

SSOException - if single sign on token is invalid.

PropertyXMLBuilder

public PropertyXMLBuilder(ServiceSchema serviceSchema,
                          AMModel model,
                          Set attributeSchemas)
                   throws SMSException,
                          SSOException

Returns a XML for displaying attribute in property sheet.

Parameters:

serviceSchema - Service schemas.

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()
              throws SMSException,
                     SSOException,
                     AMConsoleException

Returns a XML for displaying attribute in property sheet.

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.

getXML

public String getXML(String realmName)
              throws SMSException,
                     SSOException,
                     AMConsoleException

Returns an XML string for displaying attributes in a property sheet for a specific realm. This will build a page whose values may be specific to the specified realm.

Parameters:

realmName - name of the realm to obtain values.

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.

getXML

public String getXML(boolean bPropertySheetElementNode)
              throws SMSException,
                     SSOException,
                     AMConsoleException

Returns a XML for displaying attribute in property sheet.

Parameters:

bPropertySheetElementNode - true to include <propertysheet> tag.

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.

getXML

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

Returns a XML for displaying attribute in property sheet.

Parameters:

readonly - Set of readonly attributes.

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.

getXML

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

Returns a XML for displaying attribute in property sheet.

Parameters:

readonly - Set of readonly attributes.

bPropertySheetElementNode - true to include <propertysheet> tag.

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.

onBeforeBuildingXML

protected void onBeforeBuildingXML(Map<SchemaType,Set<AttributeSchema>> map)

Extends this method to selective drop attribute schema that you do not want to display.

Parameters:

map - Map of schema type (com.sun.identity.sm.SchemaType) to a set of attribute schema (com.sun.identity.sm.AttributeSchema)

discardAttribute

public void discardAttribute(Set discard)

Discards attributes from the builder.

Parameters:

discard - Set of attribute names to be discarded.