org.openliberty.xmltooling.wsa

Class RelatesTo

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.AbstractSignableXMLObject

org.openliberty.xmltooling.wsa.RelatesTo

All Implemented Interfaces:

org.opensaml.core.xml.AttributeExtensibleXMLObject, org.opensaml.core.xml.XMLObject, org.opensaml.xmlsec.signature.SignableXMLObject

public class RelatesTo
extends org.opensaml.xmlsec.signature.AbstractSignableXMLObject
implements org.opensaml.core.xml.AttributeExtensibleXMLObject

The <wsa:RelatesTo> header block is defined in [WSAv1.0-SOAP]. The value of this header block establishes a relationship between the message that contains it and some other message. The type of relationship is specified in the RelationshipType attribute.

Decided not to directly support RelationshipType other than through the unknownAttributes map. The default usage of RelatesTo Header is as a RelationshipType: http://www.w3.org/2005/03/addressing/reply

  <xs:element name="RelatesTo" type="tns:RelatesToType"/>
  <xs:complexType name="RelatesToType">
      <xs:simpleContent>
          <xs:extension base="xs:anyURI">
              <xs:attribute name="RelationshipType" type="tns:RelationshipTypeOpenEnum"
                  use="optional" default="&nsuri;/reply"/>
              <xs:anyAttribute namespace="##other" processContents="lax"/>
          </xs:extension>
      </xs:simpleContent>
  </xs:complexType>
  
  <xs:simpleType name="RelationshipTypeOpenEnum">
      <xs:union memberTypes="tns:RelationshipType xs:anyURI"/>
  </xs:simpleType>
  
  <xs:simpleType name="RelationshipType">
      <xs:restriction base="xs:anyURI">
          <xs:enumeration value="&nsuri;/reply"/>
      </xs:restriction>
  </xs:simpleType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelatesTo.Builder Internal Builder
static class	RelatesTo.Marshaller Internal Marshaller
static class	RelatesTo.Unmarshaller Internal Unmarshaller

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_RELATIONSHIP_TYPE &nsuri;/reply When the relationship is http://www.w3.org/2005/03/addressing/reply, the RelationshipType attribute may be omitted.
static String	LOCAL_NAME
private org.opensaml.core.xml.util.AttributeMap	otherAttributes Support for AttributeExtensibleXMLObject interface
private String	value

Constructor Summary

Constructors

Modifier	Constructor and Description
	RelatesTo()
protected	RelatesTo(String namespaceURI, String elementLocalName, String namespacePrefix)

Method Summary

Methods

Modifier and Type	Method and Description
List<org.opensaml.core.xml.XMLObject>	getOrderedChildren()
org.opensaml.core.xml.util.AttributeMap	getUnknownAttributes()
String	getValue()
void	setValue(String value)

Methods inherited from class org.opensaml.xmlsec.signature.AbstractSignableXMLObject

getSignature, isSigned, setSignature

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

detach, 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, 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 Detail

LOCAL_NAME

public static final String LOCAL_NAME

See Also:

Constant Field Values

value

private String value

otherAttributes

private org.opensaml.core.xml.util.AttributeMap otherAttributes

Support for AttributeExtensibleXMLObject interface

ATT_RELATIONSHIP_TYPE

public static final String ATT_RELATIONSHIP_TYPE

&nsuri;/reply When the relationship is http://www.w3.org/2005/03/addressing/reply, the RelationshipType attribute may be omitted.

See Also:

Constant Field Values

Constructor Detail

RelatesTo

public RelatesTo()

RelatesTo

protected RelatesTo(String namespaceURI,
         String elementLocalName,
         String namespacePrefix)

Method Detail

getValue

public String getValue()

setValue

public void setValue(String value)

getUnknownAttributes

public org.opensaml.core.xml.util.AttributeMap getUnknownAttributes()

Specified by:

getUnknownAttributes in interface org.opensaml.core.xml.AttributeExtensibleXMLObject

getOrderedChildren

public List<org.opensaml.core.xml.XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface org.opensaml.core.xml.XMLObject