com.goldencode.p2j.util

Class SOAPHeaderEntryImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.util.SOAPHeaderEntryImpl

All Implemented Interfaces:

ADMData, CommonHandle, CommonHandleChain, Deletable, InstantiatingProcedure, LocalName, Nameable, NamespaceURI, SOAPEntity, SOAPHeaderEntry, UniqueID, WrappedResource, Printable

public class SOAPHeaderEntryImpl
extends HandleChain
implements SOAPHeaderEntry, SOAPEntity

A class for implementing the SOAP-HEADER-ENTRYREF methods and attributes.

Field Summary

Fields

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 java.lang.String	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 CentralLogger	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 java.lang.Long	uniqueID Corresponds to UNIQUE-ID attribute.

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
SOAPHeaderEntryImpl() Implicit c'tor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	_name() Get the name attribute of handle as a string.
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.
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.
character	namespaceURI() Returns the value of the the NAMESPACE-URI attribute.
void	namespaceURI(character uri) Setter for NAMESPACE-URI attribute.
void	namespaceURI(java.lang.String uri) Setter for NAMESPACE-URI attribute.
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.
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.

Methods inherited from class com.goldencode.p2j.util.HandleChain

delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasParent, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.NamespaceURI

namespacePrefix, namespacePrefix, namespacePrefix

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

ACTOR

static final java.lang.String ACTOR

Key identifying the ACTOR of this SOAP Header Entry, set at the DOM Node.

See Also:

Constant Field Values

MUST_UNDERSTAND

static final java.lang.String MUST_UNDERSTAND

Key identifying the MUST-UNDERSTAND attribute of this SOAP Header Entry, set at the DOM Node.

See Also:

Constant Field Values

LOG

private static final CentralLogger LOG

Logger

admData

private java.lang.String admData

Corresponds to ADM-DATA attribute.

uniqueID

private java.lang.Long uniqueID

Corresponds to UNIQUE-ID attribute.

deleted

private boolean deleted

Flag indicating if this resource was deleted or not.

headerKey

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.

parent

private SOAPHeaderImpl parent

The parent SOAP Header.

Constructor Detail

SOAPHeaderEntryImpl

public SOAPHeaderEntryImpl()

Implicit c'tor.

Method Detail

getNode

public 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..

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.

Specified by:

getNode in interface SOAPEntity

Parameters:

xNodeRef - The handle where the resource will be set.

Returns:

true if the operation was possible.

getSerialized

public longchar getSerialized()

Returns a LONGCHAR that contains the serialized form of the XML underlying the SOAP-HEADER-ENTRYREF or SOAP-FAULT entry.

Specified by:

getSerialized in interface SOAPEntity

Returns:

See above.

getActor

public character getActor()

Returns the value of the actor attribute for the SOAP-HEADER-ENTRYREF object as a URL. Identifies the recipient of a header element.

Specified by:

getActor in interface SOAPHeaderEntry

Returns:

See above.

isMustUnderstand

public logical isMustUnderstand()

Indicates whether a SOAP-HEADER-ENTRYREF object is mandatory (TRUE) or optional (FALSE) for the recipient to process.

Specified by:

isMustUnderstand in interface SOAPHeaderEntry

Returns:

See above.

deleteHeaderEntry

public logical deleteHeaderEntry()

Deletes the XML underlying a SOAP-HEADER-ENTRYREF object, without deleting the object.

Specified by:

deleteHeaderEntry in interface SOAPHeaderEntry

Returns:

true if the operation was possible.

setActor

public logical setActor(character uri)

Sets the ACTOR attribute for this SOAP-HEADER-ENTRY.

Specified by:

setActor in interface SOAPHeaderEntry

Parameters:

uri - The URI of the SOAP actor.

Returns:

true if the operation was possible.

setActor

public logical setActor(java.lang.String uri)

Sets the ACTOR attribute for this SOAP-HEADER-ENTRY.

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().

Specified by:

setActor in interface SOAPHeaderEntry

Parameters:

uri - The URI of the SOAP actor.

Returns:

true if the operation was possible.

setMustUnderstand

public logical setMustUnderstand(logical val)

Sets the MUST-UNDERSTAND attribute for this SOAP-HEADER-ENTRY.

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().

Specified by:

setMustUnderstand in interface SOAPHeaderEntry

Parameters:

val - The new value of this attribute.

Returns:

true if the operation was possible.

setMustUnderstand

public logical setMustUnderstand(boolean val)

Sets the MUST-UNDERSTAND attribute for this SOAP-HEADER-ENTRY.

Specified by:

setMustUnderstand in interface SOAPHeaderEntry

Parameters:

val - The new value of this attribute.

Returns:

true if the operation was possible.

setNode

public 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.

Specified by:

setNode in interface SOAPHeaderEntry

Parameters:

xNoderef - A X-NODEREF variable that refers to the XML that will be set for the SOAP-HEADER-ENTRYREF object.

Returns:

true if the operation was possible.

setSerialized

public logical setSerialized(longchar payload)

Sets the SOAP-header-entryref object's underlying XML from serialized XML.

Specified by:

setSerialized in interface SOAPHeaderEntry

Parameters:

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.

Returns:

true if the operation was possible.

valid

public boolean valid()

Reports if this object is valid for use.

Specified by:

valid in interface WrappedResource

Returns:

true if we are valid (can be used).

getLocalName

public character getLocalName()

Get the value of the LOCAL-NAME attribute.

Specified by:

getLocalName in interface LocalName

Returns:

See above.

getADMData

public character getADMData()

Get the value of the ADM-DATA attribute.

Specified by:

getADMData in interface ADMData

Returns:

See above.

setADMData

public void setADMData(java.lang.String value)

Set the value of the ADM-DATA attribute.

Specified by:

setADMData in interface ADMData

Parameters:

value - The new value.

setADMData

public void setADMData(character value)

Set the value of the ADM-DATA attribute.

Specified by:

setADMData in interface ADMData

Parameters:

value - The new value.

getUniqueID

public integer getUniqueID()

Gets the the unique ID number associated to this object by the underlying system. Not the same as the handle value itself.

Specified by:

getUniqueID in interface UniqueID

Returns:

The integer number of the children.

namespaceURI

public character namespaceURI()

Returns the value of the the NAMESPACE-URI attribute.

Specified by:

namespaceURI in interface NamespaceURI

Returns:

See above.

namespaceURI

public void namespaceURI(java.lang.String uri)

Setter for NAMESPACE-URI attribute. Calls HandleChain.readOnlyError(java.lang.String), as this attribute is r/o for this resource.

Specified by:

namespaceURI in interface NamespaceURI

Parameters:

uri - Not used.

namespaceURI

public void namespaceURI(character uri)

Setter for NAMESPACE-URI attribute. Calls HandleChain.readOnlyError(java.lang.String), as this attribute is r/o for this resource.

Specified by:

namespaceURI in interface NamespaceURI

Parameters:

uri - Not used.

name

public character name()

Get the name attribute of handle.

Specified by:

name in interface Nameable

Overrides:

name in class HandleChain

Returns:

See above.

_name

public java.lang.String _name()

Get the name attribute of handle as a string.

Overrides:

_name in class HandleChain

Returns:

See above.

resourceDelete

protected boolean resourceDelete()

Delete the resource.

Overrides:

resourceDelete in class HandleResource

Returns:

true if the resource was deleted.

hasNextSibling

protected boolean hasNextSibling()

Check if this resource supports the NEXT-SIBLING attribute.

Overrides:

hasNextSibling in class HandleChain

Returns:

Always false.

hasPrevSibling

protected boolean hasPrevSibling()

Check if this resource supports the PREV-SIBLING attribute.

Overrides:

hasPrevSibling in class HandleChain

Returns:

Always false.

hasNameReadOnly

protected boolean hasNameReadOnly()

Check if this resource supports the NAME attribute in read-only mode.

Overrides:

hasNameReadOnly in class HandleChain

Returns:

Always true.

setParent

void setParent(SOAPHeaderImpl parent,
               java.lang.Object headerKey)

Set the parent SOAP HEADER for this entry.

Parameters:

parent - The parent SOAP Header.

headerKey - The key to the DOM XML Node referenced by this header entry.

getHeaderKey

java.lang.Object getHeaderKey()

Get the headerKey for this SOAP header entry.

Returns:

See above.

isPopulated

private boolean isPopulated(java.lang.String caller)

Check if this SOAP-HEADER-ENTRY is populated. If not, show an appropriate error.

Parameters:

caller - The name of the caller of this method (will be shown in the error).

Returns:

See above.

getHeaderNode

private org.w3c.dom.Node getHeaderNode()

Get the DOM XML node associated with this SOAP Header entry.

Returns:

See above.