com.goldencode.p2j.util

Class SOAPHeaderImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.util.SOAPHeaderImpl

All Implemented Interfaces:

ADMData, CommonHandle, CommonHandleChain, Deletable, InstantiatingProcedure, Nameable, SOAPHeader, UniqueID, WrappedResource, Printable

public class SOAPHeaderImpl
extends HandleChain
implements SOAPHeader, CommonHandleChain

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

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	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 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
SOAPHeaderImpl() Implicit c'tor.

Method Summary

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

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

_name, delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasParent, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, 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.CommonHandleChain

getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData

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

readOnlyError, readOnlyError, resourceType

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

id, id, unknown

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

name, name, name

Methods inherited from interface com.goldencode.util.Printable

print

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

allowDelete

Field Detail

admData

private java.lang.String admData

Corresponds to ADM-DATA attribute.

uniqueID

private java.lang.Long uniqueID

Corresponds to UNIQUE-ID attribute.

headers

private final java.util.Set<SOAPHeaderEntryImpl> headers

All SOAP Header Entries linked with this SOAP Header.

entries

private final java.util.Map<java.lang.Object,org.w3c.dom.Node> entries

Mapping of each key of a header entry to a DOM XML Node. This is needed because, when a SOAP Header Entry resource changes its inner DOM XML node, all linked SOAP Header Entries change it too.

entryKeys

private final java.util.List<java.lang.Object> entryKeys

List allowing fast indexed access to the header entry keys.

deleted

private boolean deleted

Flag indicating if this resource was deleted or not.

Constructor Detail

SOAPHeaderImpl

public SOAPHeaderImpl()

Implicit c'tor.

Method Detail

getNumHeaderEntries

public integer getNumHeaderEntries()

Returns the number of SOAP-HEADER-ENTRYREF object entries attached to the SOAP-HEADER object.

Specified by:

getNumHeaderEntries in interface SOAPHeader

Returns:

See above.

addHeaderEntry

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

Specified by:

addHeaderEntry in interface SOAPHeader

Parameters:

entryRef - The SOAP Header Entry.

Returns:

true if the operation was possible.

getHeaderEntry

public logical getHeaderEntry(handle target,
                              long idx)

Get the header entry at the given index and assign 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:

getHeaderEntry in interface SOAPHeader

Parameters:

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.

Returns:

true if the operation was possible.

getHeaderEntry

public logical getHeaderEntry(handle target,
                              integer idx)

Get the header entry at the given index and assign 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:

getHeaderEntry in interface SOAPHeader

Parameters:

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.

Returns:

true if the operation was possible.

getHeaderEntry

public logical getHeaderEntry(handle target,
                              int64 idx)

Get the header entry at the given index and assign 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:

getHeaderEntry in interface SOAPHeader

Parameters:

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.

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

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.

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.

removeHeaderEntry

void removeHeaderEntry(SOAPHeaderEntryImpl entry,
                       java.lang.Object key)

Removes the specified SOAP-Header object from the list of header entries.

Parameters:

entry - The SOAP Header Entry.

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

addHeaderEntry

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.

Parameters:

entry - The SOAP Header Entry.

asString

public java.lang.String asString()

Get the string representation of the XML payload associated with this soap header.

If there are no header entries, return null.

Specified by:

asString in interface Printable

Returns:

See above.

getHeaderNode

org.w3c.dom.Node getHeaderNode(java.lang.Object key)

Get the DOM XML node associated with the given key.

Parameters:

key - The key to an entry in the entries map.

Returns:

The DOM XML node for the given key.

Throws:

java.lang.IllegalArgumentException - If the received key is null or is not part of the entries map's keys.

setHeaderNode

void setHeaderNode(java.lang.Object key,
                   org.w3c.dom.Node node)

Associated a new DOM XML node with the given header entry key.

Parameters:

key - The key to an entry in the entries map.

node - The new DOM XML node for the given key.

Throws:

java.lang.IllegalArgumentException - If the received key is null or is not part of the entries map's keys.