public abstract class Request extends Message
xkms:RequestAbstractType
element.Modifier | Constructor and Description |
---|---|
protected |
Request(org.w3c.dom.Document owner, java.lang.String tagName)
Creates a new
Request instance. |
protected |
Request(org.w3c.dom.Document owner, java.lang.String tagName, java.lang.String systemId)
Creates a new
Request instance. |
protected |
Request(org.w3c.dom.Element element)
Creates a new
Request instance. |
Modifier and Type | Method and Description |
---|---|
void |
addRespondWith(java.lang.String responseID)
Adds type of data requested to be sent in the response, as a
RespondWith child element of this request. |
void |
addResponseMechanism(java.lang.String responseMech)
Add the type of data requested to be sent in the response, as a
ResponseMechanism child element of this request. |
java.lang.String |
getOriginalRequestID()
Returns the value of the
OriginalRequestId attribute for this message or null if none is set. |
java.lang.String |
getPendingNotificationIdentifier()
Returns the
Identifier URI attribute value of the PendingNotification element for this request message. |
java.lang.String |
getPendingNotificationMechanism()
Returns the
Mechanism URI attribute value of the PendingNotification element for this request message. |
java.util.List |
getRespondWiths()
Returns a list of any
RespondWith elements in this request message. |
java.math.BigInteger |
getResponseLimit()
Returns the value of the
ResponseLimit attribute for this message or null if none is set. |
java.util.List |
getResponseMechanisms()
Returns a list of any
ResponseMechanism elements in this request message. |
void |
setOriginalRequestID(java.lang.String origRequestID)
Sets the
OriginalRequestId attribute for this message. |
void |
setPendingNotification(java.lang.String mechanism, java.lang.String identifier)
Sets the pending response notification information in a
PendingNotification element. |
void |
setResponseLimit(java.math.BigInteger limit)
Sets the
ResponseLimit attribute for this message. |
addMessageExtension, clearSignature, getId, getMessageExtensions, getNonce, getOpaqueClientData, getService, getSignature, insertChild, insertChild, removeChildren, setId, setNonce, setOpaqueClientData, setService, setSignature
addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setDefaultNSPrefix
appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML
protected Request(org.w3c.dom.Element element) throws org.w3c.dom.DOMException
Request
instance.element
- An Element node in the XML document.org.w3c.dom.DOMException
protected Request(org.w3c.dom.Document owner, java.lang.String tagName) throws org.w3c.dom.DOMException
Request
instance.owner
- The owner document of the new Request
.tagName
- The name of the element to be created; for example, "LocateRequest" if this Request
is to be a X-KISS LocateRequest mesage.org.w3c.dom.DOMException
protected Request(org.w3c.dom.Document owner, java.lang.String tagName, java.lang.String systemId) throws org.w3c.dom.DOMException
Request
instance.owner
- The owner document of the new Request
.tagName
- The name of the element to be created; for example, "LocateRequest" if this Request
is to be a X-KISS LocateRequest mesage.systemId
- The URI string system ID for the Message
..org.w3c.dom.DOMException
public void setOriginalRequestID(java.lang.String origRequestID) throws org.w3c.dom.DOMException
OriginalRequestId
attribute for this message.origRequestID
- The identifier of the original request in the case of a represented or pending request.org.w3c.dom.DOMException
public java.lang.String getOriginalRequestID()
OriginalRequestId
attribute for this message or null
if none is set.org.w3c.dom.DOMException
public void setResponseLimit(java.math.BigInteger limit) throws org.w3c.dom.DOMException
ResponseLimit
attribute for this message.limit
- The maximum number of data items the requestor can accept in the case that the schema specifies an unbounded number of elements.org.w3c.dom.DOMException
public java.math.BigInteger getResponseLimit()
ResponseLimit
attribute for this message or null
if none is set.public void addResponseMechanism(java.lang.String responseMech) throws org.w3c.dom.DOMException
ResponseMechanism
child element of this request.responseMech
- A URI
identifying the XKMS response mechanism type.org.w3c.dom.DOMException
public java.util.List getResponseMechanisms()
ResponseMechanism
elements in this request message.Vector
of response mechanism URI strings.public void addRespondWith(java.lang.String responseID) throws org.w3c.dom.DOMException
RespondWith
child element of this request.responseID
- A URI
identifying the XKMS response data type.org.w3c.dom.DOMException
public java.util.List getRespondWiths()
RespondWith
elements in this request message.Vector
of response type URI strings.public void setPendingNotification(java.lang.String mechanism, java.lang.String identifier) throws org.w3c.dom.DOMException
PendingNotification
element.mechanism
- The URI string value of the Mechanism attribute that specifies the protocol by which the notification is delivered.identifier
- The URI string value of the Identifier attribute that specifies the address to which the notification is delivered.org.w3c.dom.DOMException
public java.lang.String getPendingNotificationMechanism()
Mechanism
URI attribute value of the PendingNotification
element for this request message.Mechanism
URI string, or null
if none is present.public java.lang.String getPendingNotificationIdentifier()
Identifier
URI attribute value of the PendingNotification
element for this request message.Identifier
URI string, or null
if none is present.