org.apache.ode.bpel.common.FaultException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ode-bpel-api Show documentation
The newest version!
/*
 * 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 org.apache.ode.bpel.common;

import javax.xml.namespace.QName;


/**
 * Encapsulates an exception that should result in a known named fault being thrown
 * within a BPEL process.
 * As per BPEL specification, appendix A.
 */
public class FaultException extends Exception {
    private static final long serialVersionUID = 389190682205802035L;
    private QName _qname;

    /**
     * Create a new instance.
     *
     * @param qname   the QName of the fault
     * @param message a descriptive message for the exception
     */
    public FaultException(QName qname, String message) {
        this(qname, message, null);
    }

    public FaultException(QName qname) {
        this(qname, null, null);
    }

    public FaultException(QName qname, String message, Throwable cause) {
        super(qname.toString() + ": " + message, cause);
        this._qname = qname;
    }

    public FaultException(QName qname, Throwable cause) {
        this(qname, null, cause);
    }

    /**
     * Get the (official) QName of this fault.
     *
     * @return the QName of the fault
     */
    public QName getQName() {
        return _qname;
  }
}