oracle.wsdl.extension.soap
Class SOAPHeader

java.lang.Object
  |
  +--oracle.wsdl.common.WSDLElementImpl
        |
        +--oracle.wsdl.extension.soap.SOAPHeader

All Implemented Interfaces:

ExtensibilityElement, java.io.Serializable, WSDLElement

public class SOAPHeader

extends oracle.wsdl.common.WSDLElementImpl

implements ExtensibilityElement

SOAPHeader represents soap:header element that allows header to be defined that are transmitted inside the Header element of the SOAP envelope. It is patterned after the soap:body element.

See Also:

Serialized Form

Constructor Summary

SOAPHeader(QName message, java.lang.String part, int use)
Initialize with message, part and use value.

Method Summary

Type	Method
void	addSOAPHeaderFault(SOAPHeaderFault soapHeaderFault) add a SOAP headerfault
java.lang.String	getElementName() Get element name which is soap:header
SOAPEncodingStyle	getEncodingStyle() Get encodingStyle
QName	getMessage() Get message
java.lang.String	getNamespaceURI() Get namspace URI
java.lang.String	getPart() Get part
java.util.List	getSOAPHeaderFaults() Get SOAP headerfault element which appear inside this element
int	getUse() Get the use value
void	serialize(java.io.PrintWriter writer, boolean indent, int indentLevel) Serialize this WSDL element
void	setEncodingStyle(SOAPEncodingStyle encodingStyle) Set encodingStyle
void	setMessage(QName message) Set message
void	setNamespaceURI(java.lang.String namespaceURI) Set namespace URI
void	setPart(java.lang.String part) Set part
void	setUse(int use) Set the use value

Methods inherited from class oracle.wsdl.common.WSDLElementImpl

getChildWSDLElements, getOwnerDefinitions, getParent, setParent, validateExtensionsRecursively

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.wsdl.internal.WSDLElement

getOwnerDefinitions, getParent

Constructor Detail

SOAPHeader

public SOAPHeader(QName message,
                  java.lang.String part,
                  int use)

Initialize with message, part and use value. The message and part reference the message part that defines the header type.

Parameters:

message - the qname of message

part - the name of part of the message

use - SOAPConstants.USE_LITERAL for literal, or SOAPConstants.USE_ENCODED for encoded.

Method Detail

getElementName

public java.lang.String getElementName()

Get element name which is soap:header

Specified by:

getElementName in interface ExtensibilityElement

Returns:

soap:header

getMessage

public QName getMessage()

Get message

Returns:

the qname of message

setMessage

public void setMessage(QName message)

Set message

Parameters:

message - the qname of message

getPart

public java.lang.String getPart()

Get part

Returns:

the name of part

setPart

public void setPart(java.lang.String part)

Set part

Parameters:

the - name of part

getUse

public int getUse()

Get the use value

Returns:

SOAPConstants.USE_LITERAL for literal, or SOAPConstants.USE_ENCODED for encoded

setUse

public void setUse(int use)

Set the use value

Parameters:

use - SOAPConstants.USE_LITERAL for literal, or SOAPConstants.USE_ENCODED for encoded

getEncodingStyle

public SOAPEncodingStyle getEncodingStyle()

Get encodingStyle

Returns:

encodingStyle that consists of a list of URIs; return null if not exist.

setEncodingStyle

public void setEncodingStyle(SOAPEncodingStyle encodingStyle)

Set encodingStyle

Parameters:

encodingStyle - a list of URIs

getNamespaceURI

public java.lang.String getNamespaceURI()

Get namspace URI

Returns:

namespace URI

setNamespaceURI

public void setNamespaceURI(java.lang.String namespaceURI)

Set namespace URI

Parameters:

namespaceURI - the namespace to set

getSOAPHeaderFaults

public java.util.List getSOAPHeaderFaults()

Get SOAP headerfault element which appear inside this element

Returns:

headerfault element; return null if not exist.

addSOAPHeaderFault

public void addSOAPHeaderFault(SOAPHeaderFault soapHeaderFault)

add a SOAP headerfault

Parameters:

soapHeaderFault - the SOAP headerfault element to add

serialize

public void serialize(java.io.PrintWriter writer,
                      boolean indent,
                      int indentLevel)

Description copied from interface: WSDLElement

Serialize this WSDL element

Specified by:

serialize in interface WSDLElement

Following copied from interface: oracle.wsdl.internal.WSDLElement

Parameters:

writer - a print writer as a sink

indent - indicates whether indentation will be applied to serialization

indentLevel - the levels of indentation starting from 0.