org.openliberty.xmltooling.soapbinding

Class UsageDirective

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.soap.common.AbstractExtensibleSOAPObject

org.openliberty.xmltooling.soapbinding.UsageDirective

All Implemented Interfaces:

org.opensaml.core.xml.AttributeExtensibleXMLObject, org.opensaml.core.xml.ElementExtensibleXMLObject, org.opensaml.core.xml.XMLObject, org.opensaml.soap.common.SOAPObject

public class UsageDirective
extends org.opensaml.soap.common.AbstractExtensibleSOAPObject

Participants in the ID-WSF framework may need to indicate the privacy policy associated with a message. To facilitate this, senders, acting as either a client or a server, may add one or more <UsageDirective> header blocks to the SOAP Header of the message being sent. A <UsageDirective> appearing in a SOAP-based ID-* request message expresses intended usage. A <UsageDirective> appearing in a response expresses how the receiver of the response is to use the response data. A <UsageDirective> in a response message containing no ID-WSF response message data, a fault response for example, may be used to express policies acceptable to the responder.

   <xs:complexType name="UsageDirectiveType">
     <xs:sequence>
       <xs:any namespace="##other" processContents="lax" 
         maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="ref" type="xs:IDREF" use="required"/>
     <xs:anyAttribute namespace="##other" processContents="lax"/>
   </xs:complexType>
 
   <xs:element name="UsageDirective" type="UsageDirectiveType"/>
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_REF
static String	LOCAL_NAME
private String	ref An attribute referring to an element of the SOAP-based ID-* message to which the usage directive applies.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getRef()
void	setRef(String ref)

Methods inherited from class org.opensaml.soap.common.AbstractExtensibleSOAPObject

getOrderedChildren, getUnknownAttributes, getUnknownXMLObjects, getUnknownXMLObjects

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

ref

private String ref

An attribute referring to an element of the SOAP-based ID-* message to which the usage directive applies.

ATT_REF

public static final String ATT_REF

See Also:

Constant Field Values

Constructor Detail

UsageDirective

public UsageDirective()

UsageDirective

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

Method Detail

getRef

public String getRef()

setRef

public void setRef(String ref)