alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Axis 2 example source code file (SOAPFault.java)

This example Axis 2 source code file (SOAPFault.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Axis 2 tags/keywords

detail, detail, locale, locale, name, soapbodyelement, soapexception, soapexception, soapfault, string, string, util

The Axis 2 SOAPFault.java source code

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package javax.xml.soap;

import java.util.Locale;

/**
 * An element in the <CODE>SOAPBody object that contains error and/or status information.
 * This information may relate to errors in the <CODE>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.
 * <p/>
 * The <CODE>SOAPFault interface provides methods for retrieving the information contained in
 * a <CODE> 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.
 */
public interface SOAPFault extends SOAPBodyElement {

    /**
     * Sets this <CODE>SOAPFault object with the given fault code.
     * <p/>
     * <P>Fault codes, which given information about the fault, are defined in the SOAP 1.1
     * specification.</P>
     *
     * @param faultCode a <CODE>String giving the fault code to be set; must be one of the
     *                  fault codes defined in the SOAP 1.1 specification
     * @throws SOAPException if there was an error in adding the <CODE>faultCode to the
     *                       underlying XML tree.
     * @see #getFaultCode() getFaultCode()
     */
    public abstract void setFaultCode(String faultCode) throws SOAPException;

    /**
     * Gets the fault code for this <CODE>SOAPFault object.
     *
     * @return a <CODE>String with the fault code
     * @see #setFaultCode(String) setFaultCode(java.lang.String)
     */
    public abstract String getFaultCode();

    /**
     * Sets this <CODE>SOAPFault object with the given fault actor.
     * <p/>
     * <P>The fault actor is the recipient in the message path who caused the fault to happen.

* * @param faultActor a <CODE>String identifying the actor that caused this * SOAPFault</CODE> object * @throws SOAPException if there was an error in adding the <CODE>faultActor to the * underlying XML tree. * @see #getFaultActor() getFaultActor() */ public abstract void setFaultActor(String faultActor) throws SOAPException; /** * Gets the fault actor for this <CODE>SOAPFault object. * * @return a <CODE>String giving the actor in the message path that caused this * <CODE>SOAPFault object * @see #setFaultActor(String) setFaultActor(java.lang.String) */ public abstract String getFaultActor(); /** * Sets the fault string for this <CODE>SOAPFault object to the given string. * * @param faultString a <CODE>String giving an explanation of the fault * @throws SOAPException if there was an error in adding the <CODE>faultString to the * underlying XML tree. * @see #getFaultString() getFaultString() */ public abstract void setFaultString(String faultString) throws SOAPException; /** * Gets the fault string for this <CODE>SOAPFault object. * * @return a <CODE>String giving an explanation of the fault */ public abstract String getFaultString(); /** * Returns the detail element for this <CODE>SOAPFault object. * <p/> * <P>A Detail object carries application-specific error information related to * <CODE> SOAPBodyElement objects.

* * @return a <CODE>Detail object with application-specific error information */ public abstract Detail getDetail(); /** * Creates a <CODE>Detail object and sets it as the Detail object for this * <CODE>SOAPFault object. * <p/> * <P>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.</P> * * @return the new <CODE>Detail object * @throws SOAPException if this <CODE>SOAPFault object already contains a valid * <CODE>Detail object */ public abstract Detail addDetail() throws SOAPException; /** * Sets this <code>SOAPFault object with the given fault code. * <p/> * 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 <code>QName. This method * provides a convenient way to set a fault code. For example, * <p/> * <pre> * 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); * <p/> * It is preferable to use this method over setFaultCode(String). * * @param name a <code>Name object giving the fault code to be set. It must be namespace * qualified. * @throws SOAPException if there was an error in adding the <code>faultcode element to * the underlying XML tree */ public abstract void setFaultCode(Name name) throws SOAPException; /** * Gets the mandatory SOAP 1.1 fault code for this <code>SOAPFault object as a SAAJ * <code>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 <code>Name object. This method should be used instead of the * <code>getFaultCode() method since it allows applications to easily access the * namespace name without additional parsing. * <p/> * In the future, a QName object version of this method may also be added. * * @return a <code>Name representing the faultcode */ public abstract Name getFaultCodeAsName(); /** * Sets the fault string for this <code>SOAPFault object to the given string and * localized to the given locale. * * @param faultString a <code>String giving an explanation of the fault * @param locale a <code>Locale object indicating the native language of the * <code>faultString * @throws SOAPException if there was an error in adding the <code>faultString to the * underlying XML tree */ public abstract void setFaultString(String faultString, Locale locale) throws SOAPException; /** * Returns the optional detail element for this <code>SOAPFault object. * * @return a <code>Locale object indicating the native language of the fault string or * <code>null if no locale was specified */ public abstract Locale getFaultStringLocale(); public abstract void addFaultReasonText(java.lang.String reasonText, java.util.Locale locale) throws SOAPException; public abstract void appendFaultSubcode(javax.xml.namespace.QName qname) throws SOAPException; public abstract javax.xml.namespace.QName getFaultCodeAsQName(); public abstract java.lang.String getFaultNode(); public abstract java.util.Iterator getFaultReasonLocales() throws SOAPException; public abstract java.lang.String getFaultReasonText(java.util.Locale locale) throws SOAPException; public abstract java.util.Iterator getFaultReasonTexts() throws SOAPException; public abstract java.lang.String getFaultRole(); public abstract java.util.Iterator getFaultSubcodes(); public abstract boolean hasDetail(); public abstract void removeAllFaultSubcodes(); public abstract void setFaultCode(javax.xml.namespace.QName qname) throws SOAPException; public abstract void setFaultNode(java.lang.String s) throws SOAPException; public abstract void setFaultRole(java.lang.String s) throws SOAPException; }

Other Axis 2 examples (source code examples)

Here is a short list of links related to this Axis 2 SOAPFault.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.