public class SOAPHeaderEntryImpl extends HandleChain implements SOAPHeaderEntry, SOAPEntity
Modifier and Type | Field and Description |
---|---|
(package private) static java.lang.String |
ACTOR
Key identifying the ACTOR of this SOAP Header Entry, set at the DOM Node.
|
private character |
admData
Corresponds to ADM-DATA attribute.
|
private boolean |
deleted
Flag indicating if this resource was deleted or not.
|
private java.lang.Object |
headerKey
After it is attached to a SOAP Header parent, this will be the key to the DOM Node for this
header entry.
|
private static java.util.logging.Logger |
LOG
Logger
|
(package private) static java.lang.String |
MUST_UNDERSTAND
Key identifying the MUST-UNDERSTAND attribute of this SOAP Header Entry, set at the DOM
Node.
|
private SOAPHeaderImpl |
parent
The parent SOAP Header.
|
private integer |
uniqueID
Corresponds to UNIQUE-ID attribute.
|
name, nextSibling, prevSibling
instProc
Constructor and Description |
---|
SOAPHeaderEntryImpl()
Implicit c'tor.
|
Modifier and Type | Method and Description |
---|---|
logical |
deleteHeaderEntry()
Deletes the XML underlying a SOAP-HEADER-ENTRYREF object, without deleting the object.
|
character |
getActor()
Returns the value of the actor attribute for the SOAP-HEADER-ENTRYREF object as a URL.
|
character |
getADMData()
Get the value of the ADM-DATA attribute.
|
(package private) java.lang.Object |
getHeaderKey()
Get the
headerKey for this SOAP header entry. |
private org.w3c.dom.Node |
getHeaderNode()
Get the
DOM XML node associated with this SOAP Header entry. |
character |
getLocalName()
Get the value of the LOCAL-NAME attribute.
|
character |
getNamespaceURI()
Returns the value of the the NAMESPACE-URI attribute.
|
logical |
getNode(handle xNodeRef)
Gets the X-NODEREF object that refers to the XML underlying a SOAP-HEADER-ENTRYREF object or
SOAP-FAULT entry and sets it to the given handle..
|
longchar |
getSerialized()
Returns a LONGCHAR that contains the serialized form of the XML underlying the
SOAP-HEADER-ENTRYREF or SOAP-FAULT entry.
|
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.
|
logical |
isMustUnderstand()
Indicates whether a SOAP-HEADER-ENTRYREF object is mandatory (TRUE) or optional (FALSE) for
the recipient to process.
|
private boolean |
isPopulated(java.lang.String caller)
Check if this SOAP-HEADER-ENTRY is populated.
|
character |
name()
Get the
name attribute of handle. |
protected boolean |
resourceDelete()
Delete the resource.
|
logical |
setActor(character uri)
Sets the ACTOR attribute for this SOAP-HEADER-ENTRY.
|
logical |
setActor(java.lang.String uri)
Sets the ACTOR attribute for this SOAP-HEADER-ENTRY.
|
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.
|
logical |
setMustUnderstand(boolean val)
Sets the MUST-UNDERSTAND attribute for this SOAP-HEADER-ENTRY.
|
logical |
setMustUnderstand(logical val)
Sets the MUST-UNDERSTAND attribute for this SOAP-HEADER-ENTRY.
|
void |
setNamespaceURI(character uri)
Setter for NAMESPACE-URI attribute.
|
void |
setNamespaceURI(java.lang.String uri)
Setter for NAMESPACE-URI attribute.
|
logical |
setNode(handle xNoderef)
Replaces the underlying XML of a SOAP-HEADER-ENTRYREF object with the DOM XML sub-tree
rooted by the X-NODEREF object.
|
(package private) void |
setParent(SOAPHeaderImpl parent,
java.lang.Object headerKey)
Set the parent SOAP HEADER for this entry.
|
logical |
setSerialized(longchar payload)
Sets the SOAP-header-entryref object's underlying XML from serialized XML.
|
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, 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
getResourceType
id, id, unknown
static final java.lang.String ACTOR
static final java.lang.String MUST_UNDERSTAND
private static final java.util.logging.Logger LOG
private final character admData
private final integer uniqueID
private boolean deleted
private java.lang.Object headerKey
private SOAPHeaderImpl parent
public logical getNode(handle xNodeRef)
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.
getNode
in interface SOAPEntity
xNodeRef
- The handle where the resource will be set.true
if the operation was possible.public longchar getSerialized()
getSerialized
in interface SOAPEntity
public character getActor()
getActor
in interface SOAPHeaderEntry
public logical isMustUnderstand()
isMustUnderstand
in interface SOAPHeaderEntry
public logical deleteHeaderEntry()
deleteHeaderEntry
in interface SOAPHeaderEntry
true
if the operation was possible.public logical setActor(character uri)
setActor
in interface SOAPHeaderEntry
uri
- The URI of the SOAP actor.true
if the operation was possible.public logical setActor(java.lang.String uri)
This attribute is kept as a user-data at the DOM Node, to be shared by all resources referencing this SOAP Header Entry.
The mustUnderstand
and actor
attributes are not emitted by
getSerialized()
.
setActor
in interface SOAPHeaderEntry
uri
- The URI of the SOAP actor.true
if the operation was possible.public logical setMustUnderstand(logical val)
This attribute is kept as a user-data at the DOM Node, to be shared by all resources referencing this SOAP Header Entry.
The mustUnderstand
and actor
attributes are not emitted by
getSerialized()
.
setMustUnderstand
in interface SOAPHeaderEntry
val
- The new value of this attribute.true
if the operation was possible.public logical setMustUnderstand(boolean val)
setMustUnderstand
in interface SOAPHeaderEntry
val
- The new value of this attribute.true
if the operation was possible.public logical setNode(handle xNoderef)
setNode
in interface SOAPHeaderEntry
xNoderef
- A X-NODEREF variable that refers to the XML that will be set for the
SOAP-HEADER-ENTRYREF object.true
if the operation was possible.public logical setSerialized(longchar payload)
setSerialized
in interface SOAPHeaderEntry
payload
- A LONGCHAR variable that contains the XML that will become this
SOAP-HEADER-ENTRYREF object. This parameter can be only a longchar, 4GL doesn't
allow character variables.true
if the operation was possible.public boolean valid()
valid
in interface WrappedResource
true
if we are valid (can be used).public character getLocalName()
getLocalName
in interface LocalName
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
public character getNamespaceURI()
getNamespaceURI
in interface NamespaceURI
public void setNamespaceURI(java.lang.String uri)
HandleChain.readOnlyError(java.lang.String)
, as this attribute is r/o
for this resource.setNamespaceURI
in interface NamespaceURI
uri
- Not used.public void setNamespaceURI(character uri)
HandleChain.readOnlyError(java.lang.String)
, as this attribute is r/o
for this resource.setNamespaceURI
in interface NamespaceURI
uri
- Not used.public character name()
name
attribute of handle.name
in interface Nameable
name
in class HandleChain
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 setParent(SOAPHeaderImpl parent, java.lang.Object headerKey)
parent
- The parent SOAP Header.headerKey
- The key to the DOM XML Node referenced by this header entry.java.lang.Object getHeaderKey()
headerKey
for this SOAP header entry.private boolean isPopulated(java.lang.String caller)
caller
- The name of the caller of this method (will be shown in the error).private org.w3c.dom.Node getHeaderNode()
DOM XML node
associated with this SOAP Header entry.