Java Doc for SOAPHeaderElement.java in » 6.0-JDK-Modules » saaj » javax » xml » soap » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » 6.0 JDK Modules » saaj » javax.xml.soap

Source Cross Reference Class Diagram Java Document (Java Doc)

javax.xml.soap .SOAPHeaderElement

All known Subclasses:   com.sun.xml.messaging.saaj.soap.impl .HeaderElementImpl,
SOAPHeaderElement
public interface SOAPHeaderElement extends SOAPElement(Code)
An object representing the contents in the SOAP header part of the SOAP envelope. The immediate children of a SOAPHeader object can be represented only as SOAPHeaderElement objects.
A SOAPHeaderElement object can have other SOAPElement objects as its children.

Method Summary
public String getActor()
     Returns the uri of the actor attribute of this SOAPHeaderElement.
public boolean getMustUnderstand()
     Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement.
public boolean getRelay()
     Returns the boolean value of the relay attribute for this SOAPHeaderElement true if the relay attribute is turned on; false otherwise
exception:
  UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Relay attribute.
public String getRole()
     Returns the value of the Role attribute of this SOAPHeaderElement. a String giving the URI of the Role
exception:
  UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.
public void setActor(String actorURI)
     Sets the actor associated with this SOAPHeaderElement object to the specified actor.
public void setMustUnderstand(boolean mustUnderstand)
     Sets the mustUnderstand attribute for this SOAPHeaderElement object to be either true or false.
If the mustUnderstand attribute is on, the actor who receives the SOAPHeaderElement must process it correctly.
public void setRelay(boolean relay)
     Sets the relay attribute for this SOAPHeaderElement to be either true or false.
The SOAP relay attribute is set to true to indicate that the SOAP header block must be relayed by any node that is targeted by the header block but not actually process it.
public void setRole(String uri)
     Sets the Role associated with this SOAPHeaderElement object to the specified Role.
Parameters:
  uri - - the URI of the Role
throws:
  SOAPException - if there is an error in setting the role
exception:
  UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.

Method Detail
getActor
public String getActor()(Code)
Returns the uri of the actor attribute of this SOAPHeaderElement.
If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to SOAPHeaderElement.getRole() a String giving the URI of the actor
See Also:   SOAPHeaderElement.setActor

getMustUnderstand
public boolean getMustUnderstand()(Code)
Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement. true if the mustUnderstand attribute of thisSOAPHeaderElement object is turned on; falseotherwise

getRelay
public boolean getRelay()(Code)
Returns the boolean value of the relay attribute for this SOAPHeaderElement true if the relay attribute is turned on; false otherwise
exception:
  UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Relay attribute.
See Also:   SOAPHeaderElement.getMustUnderstand
See Also:
See Also:   SOAPHeaderElement.setRelay
since:
   SAAJ 1.3

getRole
public String getRole()(Code)
Returns the value of the Role attribute of this SOAPHeaderElement. a String giving the URI of the Role
exception:
  UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.
since:
   SAAJ 1.3

setActor
public void setActor(String actorURI)(Code)
Sets the actor associated with this SOAPHeaderElement object to the specified actor. The default value of an actor is: SOAPConstants.URI_SOAP_ACTOR_NEXT
If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to SOAPHeaderElement.setRole(String)
Parameters:
  actorURI - a String giving the URI of the actorto set
exception:
  IllegalArgumentException - if there is a problem insetting the actor.
See Also:   SOAPHeaderElement.getActor

setMustUnderstand
public void setMustUnderstand(boolean mustUnderstand)(Code)
Sets the mustUnderstand attribute for this SOAPHeaderElement object to be either true or false.
If the mustUnderstand attribute is on, the actor who receives the SOAPHeaderElement must process it correctly. This ensures, for example, that if the SOAPHeaderElement object modifies the message, that the message is being modified correctly.
Parameters:
  mustUnderstand - true to set the mustUnderstandattribute to true; false to set it to false
exception:
  IllegalArgumentException - if there is a problem insetting the mustUnderstand attribute
See Also:   SOAPHeaderElement.getMustUnderstand
See Also:
See Also:   SOAPHeaderElement.setRelay

setRelay
public void setRelay(boolean relay) throws SOAPException(Code)
Sets the relay attribute for this SOAPHeaderElement to be either true or false.
The SOAP relay attribute is set to true to indicate that the SOAP header block must be relayed by any node that is targeted by the header block but not actually process it. This attribute is ignored on header blocks whose mustUnderstand attribute is set to true or that are targeted at the ultimate reciever (which is the default). The default value of this attribute is false.
Parameters:
  relay - the new value of the relay attribute
exception:
  SOAPException - if there is a problem in setting the relay attribute.
exception:
  UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Relay attribute.
See Also:   SOAPHeaderElement.setMustUnderstand
See Also:
See Also:   SOAPHeaderElement.getRelay
since:
   SAAJ 1.3

setRole
public void setRole(String uri) throws SOAPException(Code)
Sets the Role associated with this SOAPHeaderElement object to the specified Role.
Parameters:
  uri - - the URI of the Role
throws:
  SOAPException - if there is an error in setting the role
exception:
  UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.
since:
   SAAJ 1.3

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.