com.sun.xml.wss.impl.WssSoapFaultException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of webservices-osgi Show documentation
Metro Web Services Runtime OSGi Bundle
There is a newer version: 4.0.3
/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.wss.impl;

import javax.xml.namespace.QName;
import jakarta.xml.soap.Detail;
import com.sun.xml.wss.*;

/** The WssSoapFaultException exception represents a 
 *  SOAP fault.
 *
 *  The message part in the SOAP fault maps to the contents of
 *  faultdetail element accessible through the 
 *  getDetail method on the WssSoapFaultException.
 *  The method createDetail on the 
 *  jakarta.xml.soap.SOAPFactory creates an instance
 *  of the jakarta.xml.soap.Detail.
 *
 *  
The faultstring provides a human-readable 
 *  description of the SOAP fault. The faultcode 
 *  element provides an algorithmic mapping of the SOAP fault.
 * 
 *  Refer to SOAP 1.1 and WSDL 1.1 specifications for more
 *  details of the SOAP faults. 
 *
 *  @see jakarta.xml.soap.Detail
 *  @see jakarta.xml.soap.SOAPFactory#createDetail
**/

public class WssSoapFaultException extends java.lang.RuntimeException  {
  
  private QName faultcode;
  private String faultstring;
  private String faultactor;
  private Detail detail;

  /** Constructor for the SOAPFaultException
   *  @param faultcode   QName for the SOAP faultcode
   *  @param faultstring faultstring element of SOAP fault 
   *  @param faultactor  faultactor element of SOAP fault
   *  @param faultdetail faultdetail element of SOAP fault 
   *
   *  @see jakarta.xml.soap.SOAPFactory#createDetail
   */
  public WssSoapFaultException(QName faultcode,
		   String faultstring,
		   String faultactor,
		   jakarta.xml.soap.Detail faultdetail) {
    super(faultstring);
    this.faultcode = faultcode;
    this.faultstring = faultstring;
    this.faultactor = faultactor;
    this.detail = faultdetail;
  }

  /** Gets the faultcode element. The faultcode
   *  element provides an algorithmic mechanism for identifying the
   *  fault. SOAP defines a small set of SOAP fault codes covering 
   *  basic SOAP faults.
   *
   *  @return QName of the faultcode element
   */
  public QName getFaultCode() {
    return this.faultcode;
  }

  /** Gets the faultstring element. The faultstring
   *  provides a human-readable description of the SOAP fault and 
   *  is not intended for algorithmic processing.
   *
   *  @return faultstring element of the SOAP fault
   */
  public String getFaultString() {
    return this.faultstring;
  }

  /** Gets the faultactor element. The faultactor
   *  element provides information about which SOAP node on the 
   *  SOAP message path caused the fault to happen. It indicates 
   *  the source of the fault.
   * 
   *  @return faultactor element of the SOAP fault 
   */
  public String getFaultActor() {
    return this.faultactor;
  }

  /** Gets the detail element. The detail element is intended for
   *  carrying application specific error information related to
   *  the SOAP Body.
   *
   *  @return detail element of the SOAP fault
   *  @see jakarta.xml.soap.Detail
   */
  public Detail getDetail() {
    return this.detail;
  }
}