Package org.opensaml.soap.common

Class AbstractExtensibleSOAPObject

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.soap.common.AbstractExtensibleSOAPObject

All Implemented Interfaces:

AttributeExtensibleXMLObject, ElementExtensibleXMLObject, XMLObject, SOAPObject

Direct Known Subclasses:

BodyImpl, DetailImpl, EnvelopeImpl, HeaderImpl

public abstract class AbstractExtensibleSOAPObject
extends AbstractXMLObject
implements SOAPObject, AttributeExtensibleXMLObject, ElementExtensibleXMLObject

Abstract class implementing element and attribute extensibility.

Field Summary

Fields

Modifier and Type	Field	Description
private final AttributeMap	attributes	Attributes of the proxied Element.
private final IndexedXMLObjectChildrenList<XMLObject>	unknownXMLObjects	"Any" type children.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractExtensibleSOAPObject(String namespaceURI, String elementLocalName, String namespacePrefix)	Constructor.

Method Summary

Modifier and Type	Method	Description
List<XMLObject>	getOrderedChildren()	Gets an unmodifiable list of child elements in the order that they will appear in the DOM.
AttributeMap	getUnknownAttributes()	Gets a mutable map of the attributes.
List<XMLObject>	getUnknownXMLObjects()	Gets the list of XMLObjects added to this XMLObject as part of the "any" content model.
List<XMLObject>	getUnknownXMLObjects(QName typeOrName)	Gets the list of XMLObjects added to this XMLObject as part of the "any" content model, and which match the specified QName.

Methods inherited from class org.opensaml.core.xml.AbstractXMLObject

detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Details

unknownXMLObjects

@Nonnull
private final IndexedXMLObjectChildrenList<XMLObject> unknownXMLObjects

"Any" type children.

attributes

@Nonnull
private final AttributeMap attributes

Attributes of the proxied Element.

Constructor Details

AbstractExtensibleSOAPObject

protected AbstractExtensibleSOAPObject(@Nullable
 String namespaceURI,
 @Nonnull
 String elementLocalName,
 @Nullable
 String namespacePrefix)

Constructor.

Parameters:

namespaceURI - namespace of the element

elementLocalName - name of the element

namespacePrefix - namespace prefix of the element

Method Details

getOrderedChildren

@Nullable
@Unmodifiable
@NotLive
public List<XMLObject> getOrderedChildren()

Gets an unmodifiable list of child elements in the order that they will appear in the DOM.

Specified by:

getOrderedChildren in interface XMLObject

Returns:

ordered list of child elements

getUnknownXMLObjects

@Nonnull
@Live
public List<XMLObject> getUnknownXMLObjects()

Gets the list of XMLObjects added to this XMLObject as part of the "any" content model.

Specified by:

getUnknownXMLObjects in interface ElementExtensibleXMLObject

Returns:

list of XMLObjects added to this XMLObject as part of the "any" content model

getUnknownXMLObjects

@Nonnull
public List<XMLObject> getUnknownXMLObjects(@Nonnull
 QName typeOrName)

Gets the list of XMLObjects added to this XMLObject as part of the "any" content model, and which match the specified QName.

Specified by:

getUnknownXMLObjects in interface ElementExtensibleXMLObject

Parameters:

typeOrName - the QName of the statements to return

Returns:

list of XMLObjects added to this XMLObject as part of the "any" content model TODO: think this should be typed List<? extends XMLObject>

getUnknownAttributes

@Nonnull
public AttributeMap getUnknownAttributes()

Gets a mutable map of the attributes. The map key is the namespace qualified name of the attribute, the map value is the value of the attribute.

Specified by:

getUnknownAttributes in interface AttributeExtensibleXMLObject

Returns:

a map of the attributes