public class SOAPHeaderImpl extends HandleChain implements SOAPHeader, CommonHandleChain
Modifier and Type | Field and Description |
---|---|
private character |
admData
Corresponds to ADM-DATA attribute.
|
private boolean |
deleted
Flag indicating if this resource was deleted or not.
|
private java.util.Map<java.lang.Object,org.w3c.dom.Node> |
entries
Mapping of each key of a header entry to a DOM XML Node.
|
private java.util.List<java.lang.Object> |
entryKeys
List allowing fast indexed access to the header entry keys.
|
private java.util.Set<SOAPHeaderEntryImpl> |
headers
All SOAP Header Entries linked with this SOAP Header.
|
private integer |
uniqueID
Corresponds to UNIQUE-ID attribute.
|
name, nextSibling, prevSibling
instProc
Constructor and Description |
---|
SOAPHeaderImpl()
Implicit c'tor.
|
Modifier and Type | Method and Description |
---|---|
logical |
addHeaderEntry(handle entryRef)
Creates a new entry in a SOAP-header object's list of entries and associates the new entry
with the given SOAP-HEADER-ENTRY-REF object.
|
(package private) void |
addHeaderEntry(SOAPHeaderEntryImpl entry)
Creates a new entry in a SOAP-header object's list of entries and associates the new entry
with the given SOAP-HEADER-ENTRY-REF object.
|
(package private) java.lang.String |
asString()
Get the string representation of the XML payload associated with this soap header.
|
character |
getADMData()
Get the value of the ADM-DATA attribute.
|
logical |
getHeaderEntry(handle target,
int64 idx)
Get the header entry at the given index and assign it to the given handle.
|
logical |
getHeaderEntry(handle target,
integer idx)
Get the header entry at the given index and assign it to the given handle.
|
logical |
getHeaderEntry(handle target,
long idx)
Get the header entry at the given index and assign it to the given handle.
|
(package private) org.w3c.dom.Node |
getHeaderNode(java.lang.Object key)
Get the DOM XML node associated with the given key.
|
integer |
getNumHeaderEntries()
Returns the number of SOAP-HEADER-ENTRYREF object entries attached to the SOAP-HEADER
object.
|
integer |
getUniqueID()
Gets the the unique ID number associated to this object by the underlying system.
|
protected boolean |
hasNameReadOnly()
Check if this resource supports the NAME attribute in read-only mode.
|
protected boolean |
hasNextSibling()
Check if this resource supports the NEXT-SIBLING attribute.
|
protected boolean |
hasPrevSibling()
Check if this resource supports the PREV-SIBLING attribute.
|
(package private) void |
removeHeaderEntry(SOAPHeaderEntryImpl entry,
java.lang.Object key)
Removes the specified SOAP-Header object from the list of header entries.
|
protected boolean |
resourceDelete()
Delete the resource.
|
void |
setADMData(character value)
Set the value of the ADM-DATA attribute.
|
void |
setADMData(java.lang.String value)
Set the value of the ADM-DATA attribute.
|
(package private) void |
setHeaderNode(java.lang.Object key,
org.w3c.dom.Node node)
Associated a new DOM XML node with the given header entry key.
|
boolean |
valid()
Reports if this object is valid for use.
|
delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasParent, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, name, readOnlyError, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData
getResourceType, id, id, implicitDeletion, instantiatingProcedure, invalidAttribute, setInstantiatingProcedure, type, unknown
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData
getResourceType, readOnlyError
id, id, unknown
private final character admData
private final integer uniqueID
private final java.util.Set<SOAPHeaderEntryImpl> headers
private final java.util.Map<java.lang.Object,org.w3c.dom.Node> entries
private final java.util.List<java.lang.Object> entryKeys
private boolean deleted
public integer getNumHeaderEntries()
getNumHeaderEntries
in interface SOAPHeader
public logical addHeaderEntry(handle entryRef)
addHeaderEntry
in interface SOAPHeader
entryRef
- The SOAP Header Entry.true
if the operation was possible.public logical getHeaderEntry(handle target, long idx)
This method returns a logical even though the Progress 4GL documentation explicitly states otherwise. Actual working code has proven that the original documentation is incorrect. This implementation matches the actual runtime behavior of the 4GL.
getHeaderEntry
in interface SOAPHeader
target
- The handle where the SOAP-HEADER-ENTRY instance will be saved.idx
- The index of the SOAP-HEADER-ENTRY instance to retrieve. 4GL allows only integer
and int64 values to be passed to this parameter.true
if the operation was possible.public logical getHeaderEntry(handle target, integer idx)
This method returns a logical even though the Progress 4GL documentation explicitly states otherwise. Actual working code has proven that the original documentation is incorrect. This implementation matches the actual runtime behavior of the 4GL.
getHeaderEntry
in interface SOAPHeader
target
- The handle where the SOAP-HEADER-ENTRY instance will be saved.idx
- The index of the SOAP-HEADER-ENTRY instance to retrieve. 4GL allows only integer
and int64 values to be passed to this parameter.true
if the operation was possible.public logical getHeaderEntry(handle target, int64 idx)
This method returns a logical even though the Progress 4GL documentation explicitly states otherwise. Actual working code has proven that the original documentation is incorrect. This implementation matches the actual runtime behavior of the 4GL.
getHeaderEntry
in interface SOAPHeader
target
- The handle where the SOAP-HEADER-ENTRY instance will be saved.idx
- The index of the SOAP-HEADER-ENTRY instance to retrieve. 4GL allows only integer
and int64 values to be passed to this parameter.true
if the operation was possible.public boolean valid()
valid
in interface WrappedResource
true
if we are valid (can be used).public character getADMData()
getADMData
in interface ADMData
public void setADMData(java.lang.String value)
setADMData
in interface ADMData
value
- The new value.public void setADMData(character value)
setADMData
in interface ADMData
value
- The new value.public integer getUniqueID()
getUniqueID
in interface UniqueID
protected boolean resourceDelete()
resourceDelete
in class HandleChain
true
if the resource was deleted.protected boolean hasNextSibling()
hasNextSibling
in class HandleChain
false
.protected boolean hasPrevSibling()
hasPrevSibling
in class HandleChain
false
.protected boolean hasNameReadOnly()
hasNameReadOnly
in class HandleChain
true
.void removeHeaderEntry(SOAPHeaderEntryImpl entry, java.lang.Object key)
entry
- The SOAP Header Entry.key
- The key to the DOM XML Node referenced by this header entry.void addHeaderEntry(SOAPHeaderEntryImpl entry)
entry
- The SOAP Header Entry.java.lang.String asString()
If there are no header entries, return null
.
org.w3c.dom.Node getHeaderNode(java.lang.Object key)
void setHeaderNode(java.lang.Object key, org.w3c.dom.Node node)