Java Doc for SOAPFault.java in » Web-Services-AXIS2 » 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 » Web Services AXIS2 » saaj » javax.xml.soap

Source Cross Reference Class Diagram Java Document (Java Doc)

javax.xml.soap .SOAPFault

All known Subclasses:   org.apache.axis2.saaj .SOAPFaultImpl,
SOAPFault
public interface SOAPFault extends SOAPBodyElement(Code)
An element in the SOAPBody object that contains error and/or status information. This information may relate to errors in the SOAPMessage object or to problems that are not related to the content in the message itself. Problems not related to the message itself are generally errors in processing, such as the inability to communicate with an upstream server.
The SOAPFault interface provides methods for retrieving the information contained in a SOAPFault object and for setting the fault code, the fault actor, and a string describing the fault. A fault code is one of the codes defined in the SOAP 1.1 specification that describe the fault. An actor is an intermediate recipient to whom a message was routed. The message path may include one or more actors, or, if no actors are specified, the message goes only to the default actor, which is the final intended recipient.

Method Summary
abstract public Detail addDetail()
     Creates a Detail object and sets it as the Detail object for this SOAPFault object.

It is illegal to add a detail when the fault already contains a detail.
abstract public void addFaultReasonText(java.lang.String reasonText, java.util.Locale locale)

abstract public void appendFaultSubcode(javax.xml.namespace.QName qname)

abstract public Detail getDetail()
     Returns the detail element for this SOAPFault object.
abstract public String getFaultActor()
     Gets the fault actor for this SOAPFault object.
abstract public String getFaultCode()
     Gets the fault code for this SOAPFault object.
abstract public Name getFaultCodeAsName()
     Gets the mandatory SOAP 1.1 fault code for this SOAPFault object as a SAAJ Name object.
abstract public javax.xml.namespace.QName getFaultCodeAsQName()

abstract public java.lang.String getFaultNode()

abstract public java.util.Iterator getFaultReasonLocales()

abstract public java.lang.String getFaultReasonText(java.util.Locale locale)

abstract public java.util.Iterator getFaultReasonTexts()

abstract public java.lang.String getFaultRole()

abstract public String getFaultString()
     Gets the fault string for this SOAPFault object.
abstract public Locale getFaultStringLocale()
     Returns the optional detail element for this SOAPFault object.
abstract public java.util.Iterator getFaultSubcodes()

abstract public boolean hasDetail()

abstract public void removeAllFaultSubcodes()

abstract public void setFaultActor(String faultActor)
     Sets this SOAPFault object with the given fault actor.
abstract public void setFaultCode(String faultCode)
     Sets this SOAPFault object with the given fault code.
abstract public void setFaultCode(Name name)
     Sets this SOAPFault object with the given fault code.
Fault codes, which give information about the fault, are defined in the SOAP 1.1 specification.
abstract public void setFaultCode(javax.xml.namespace.QName qname)

abstract public void setFaultNode(java.lang.String s)

abstract public void setFaultRole(java.lang.String s)

abstract public void setFaultString(String faultString)
     Sets the fault string for this SOAPFault object to the given string.
abstract public void setFaultString(String faultString, Locale locale)
     Sets the fault string for this SOAPFault object to the given string and localized to the given locale.

Method Detail
addDetail
abstract public Detail addDetail() throws SOAPException(Code)
Creates a Detail object and sets it as the Detail object for this SOAPFault object.

It is illegal to add a detail when the fault already contains a detail. Therefore, this method should be called only after the existing detail has been removed.
the new Detail object
throws:
  SOAPException - if this SOAPFault object already contains a validDetail object

addFaultReasonText
abstract public void addFaultReasonText(java.lang.String reasonText, java.util.Locale locale) throws SOAPException(Code)

appendFaultSubcode
abstract public void appendFaultSubcode(javax.xml.namespace.QName qname) throws SOAPException(Code)

getDetail
abstract public Detail getDetail()(Code)
Returns the detail element for this SOAPFault object.

A Detail object carries application-specific error information related to SOAPBodyElement objects.
a Detail object with application-specific error information

getFaultActor
abstract public String getFaultActor()(Code)
Gets the fault actor for this SOAPFault object. a String giving the actor in the message path that caused thisSOAPFault object
See Also:   SOAPFault.setFaultActor(String)
See Also:    setFaultActor(java.lang.String)

getFaultCode
abstract public String getFaultCode()(Code)
Gets the fault code for this SOAPFault object. a String with the fault code
See Also:   SOAPFault.setFaultCode(String)
See Also:    setFaultCode(java.lang.String)

getFaultCodeAsName
abstract public Name getFaultCodeAsName()(Code)
Gets the mandatory SOAP 1.1 fault code for this SOAPFault object as a SAAJ Name object. The SOAP 1.1 specification requires the value of the "faultcode" element to be of type QName. This method returns the content of the element as a QName in the form of a SAAJ Name object. This method should be used instead of the getFaultCode() method since it allows applications to easily access the namespace name without additional parsing.
In the future, a QName object version of this method may also be added. a Name representing the faultcode

getFaultCodeAsQName
abstract public javax.xml.namespace.QName getFaultCodeAsQName()(Code)

getFaultNode
abstract public java.lang.String getFaultNode()(Code)

getFaultReasonLocales
abstract public java.util.Iterator getFaultReasonLocales() throws SOAPException(Code)

getFaultReasonText
abstract public java.lang.String getFaultReasonText(java.util.Locale locale) throws SOAPException(Code)

getFaultReasonTexts
abstract public java.util.Iterator getFaultReasonTexts() throws SOAPException(Code)

getFaultRole
abstract public java.lang.String getFaultRole()(Code)

getFaultString
abstract public String getFaultString()(Code)
Gets the fault string for this SOAPFault object. a String giving an explanation of the fault

getFaultStringLocale
abstract public Locale getFaultStringLocale()(Code)
Returns the optional detail element for this SOAPFault object. a Locale object indicating the native language of the fault string ornull if no locale was specified

getFaultSubcodes
abstract public java.util.Iterator getFaultSubcodes()(Code)

hasDetail
abstract public boolean hasDetail()(Code)

removeAllFaultSubcodes
abstract public void removeAllFaultSubcodes()(Code)

setFaultActor
abstract public void setFaultActor(String faultActor) throws SOAPException(Code)
Sets this SOAPFault object with the given fault actor.

The fault actor is the recipient in the message path who caused the fault to happen.

Parameters:
  faultActor - a String identifying the actor that caused this SOAPFault object
throws:
  SOAPException - if there was an error in adding the faultActor to theunderlying XML tree.
See Also:   SOAPFault.getFaultActor()
See Also:    getFaultActor()

setFaultCode
abstract public void setFaultCode(String faultCode) throws SOAPException(Code)
Sets this SOAPFault object with the given fault code.

Fault codes, which given information about the fault, are defined in the SOAP 1.1 specification.

Parameters:
  faultCode - a String giving the fault code to be set; must be one of thefault codes defined in the SOAP 1.1 specification
throws:
  SOAPException - if there was an error in adding the faultCode to theunderlying XML tree.
See Also:   SOAPFault.getFaultCode()
See Also:    getFaultCode()

setFaultCode
abstract public void setFaultCode(Name name) throws SOAPException(Code)
Sets this SOAPFault object with the given fault code.
Fault codes, which give information about the fault, are defined in the SOAP 1.1 specification. A fault code is mandatory and must be of type QName. This method provides a convenient way to set a fault code. For example,

SOAPEnvelope se = ...; // Create a qualified name in the SOAP namespace with a localName // of "Client". Note that prefix parameter is optional and is null // here which causes the implementation to use an appropriate prefix. Name qname = se.createName("Client", null, SOAPConstants.URI_NS_SOAP_ENVELOPE); SOAPFault fault = ...; fault.setFaultCode(qname);
It is preferable to use this method over setFaultCode(String).
Parameters:
  name - a Name object giving the fault code to be set. It must be namespacequalified.
throws:
  SOAPException - if there was an error in adding the faultcode element tothe underlying XML tree

setFaultCode
abstract public void setFaultCode(javax.xml.namespace.QName qname) throws SOAPException(Code)

setFaultNode
abstract public void setFaultNode(java.lang.String s) throws SOAPException(Code)

setFaultRole
abstract public void setFaultRole(java.lang.String s) throws SOAPException(Code)

setFaultString
abstract public void setFaultString(String faultString) throws SOAPException(Code)
Sets the fault string for this SOAPFault object to the given string.
Parameters:
  faultString - a String giving an explanation of the fault
throws:
  SOAPException - if there was an error in adding the faultString to theunderlying XML tree.
See Also:   SOAPFault.getFaultString()
See Also:    getFaultString()

setFaultString
abstract public void setFaultString(String faultString, Locale locale) throws SOAPException(Code)
Sets the fault string for this SOAPFault object to the given string and localized to the given locale.
Parameters:
  faultString - a String giving an explanation of the fault
Parameters:
  locale - a Locale object indicating the native language of thefaultString
throws:
  SOAPException - if there was an error in adding the faultString to theunderlying XML tree

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.