org.jboss.ws.metadata.wsdl

Class WSDLSOAPHeader

java.lang.Object

org.jboss.ws.metadata.wsdl.WSDLSOAPHeader

All Implemented Interfaces:

Serializable

public class WSDLSOAPHeader
extends Object
implements Serializable

Represents a WSDL 2.0 SOAP Header Block. The presence of the SOAP Header Block component indicates that the service supports headers and MAY require a web service consumer/client to use the header. It may appear up to one time in the message.

Author:

Jason T. Greene

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WSDLSOAPHeader(QName element, String partName)

Method Summary

Methods

Modifier and Type	Method and Description
QName	getElement() Returns the name of the header schema element that describes the header's contents.
String	getPartName() Returns the name of the WSDL 1.1 part, if the output is WSDL 1.1
boolean	isIncludeInSignature() Indicates the resulting WSDL should include this header as part of the interface message.
boolean	isMustUnderstand() Indicates whether the resulting SOAP header has a mustUnderstand attribute set to true.
boolean	isRequired() Indicates whether the resulting SOAP header must be present in the message.
void	setIncludeInSignature(boolean includeInSignature) Speficies the resulting WSDL should include this header as part of the interface message.
void	setMustUnderstand(boolean mustUnderstand) Specifies whether the resulting SOAP Header has a mustUnderstand attribute set to true.
void	setRequired(boolean required) Specifies whether the resulting SOAP header is required to be present on the message.

Methods inherited from class java.lang.Object

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

Constructor Detail

WSDLSOAPHeader

public WSDLSOAPHeader(QName element,
              String partName)

Method Detail

getElement

public QName getElement()

Returns the name of the header schema element that describes the header's contents.

Returns:

the name of the header schema element

getPartName

public String getPartName()

Returns the name of the WSDL 1.1 part, if the output is WSDL 1.1

Returns:

the name of the part

isMustUnderstand

public boolean isMustUnderstand()

Indicates whether the resulting SOAP header has a mustUnderstand attribute set to true.

Returns:

the value of the SOAP mustUnderstand attribute

setMustUnderstand

public void setMustUnderstand(boolean mustUnderstand)

Specifies whether the resulting SOAP Header has a mustUnderstand attribute set to true.

Parameters:

mustUnderstand - the value of the SOAP mustUnderstand attribute

isRequired

public boolean isRequired()

Indicates whether the resulting SOAP header must be present in the message.

Returns:

true if the header must be present, otherwise false

setRequired

public void setRequired(boolean required)

Specifies whether the resulting SOAP header is required to be present on the message.

Parameters:

required - true if the header must be present, otherwise false

isIncludeInSignature

public boolean isIncludeInSignature()

Indicates the resulting WSDL should include this header as part of the interface message. This is currently only valid for WSDL 1.1, as WSDL 2.0 does not have an equivalent way to specify this. This serves as a hint to binding tools that the header should be mapped to a Java parameter.

Returns:

whether the header should be part of the interface message

setIncludeInSignature

public void setIncludeInSignature(boolean includeInSignature)

Speficies the resulting WSDL should include this header as part of the interface message. This is currently only valid for WSDL 1.1, as WSDL 2.0 does not have an equivalent way to specify this. This serves as a hint to binding tools that the header should be mapped to a Java parameter.

Parameters:

includeInSignature - whether the header should be part of the interface message