jakarta.resource.spi.work.WorkCompletedException Maven / Gradle / Ivy
/*
* 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 Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.resource.spi.work;
/**
* This exception is thrown by a WorkManager to indicate that
* a submitted Work instance has completed with an exception.
*
* This could be thrown only after the execution of a
* Work instance has started (that is, after a thread has
* been allocated for Work execution). The allocated thread sets
* up an execution context (if it has been specified), and then calls
* Work.run().
*
*
Any exception thrown during execution context setup or during
* Work execution (that is, during Work.run()) is
* chained within this exception.
*
*
An associated error code indicates the nature of the error condition.
* Possible error codes are WorkException.TX_RECREATE_FAILED,
* WorkException.TX_CONCURRENT_WORK_DISALLOWED or
* WorkException.UNDEFINED.
*
* @version 1.0
* @author Ram Jeyaraman
*/
public class WorkCompletedException extends WorkException {
/**
* Constructs a new instance with null as its detail message.
*/
public WorkCompletedException() { super(); }
/**
* Constructs a new instance with the specified detail message.
*
* @param message the detail message.
*/
public WorkCompletedException(String message) {
super(message);
}
/**
* Constructs a new throwable with the specified cause.
*
* @param cause a chained exception of type
* Throwable.
*/
public WorkCompletedException(Throwable cause) {
super(cause);
}
/**
* Constructs a new throwable with the specified detail message and cause.
*
* @param message the detail message.
*
* @param cause a chained exception of type
* Throwable.
*/
public WorkCompletedException(String message, Throwable cause) {
super(message, cause);
}
/**
* Constructs a new throwable with the specified detail message and
* an error code.
*
* @param message a description of the exception.
* @param errorCode a string specifying the vendor specific error code.
*/
public WorkCompletedException(String message, String errorCode) {
super(message, errorCode);
}
}