javax.resource.spi.work.WorkCompletedException Maven / Gradle / Ivy
Show all versions of ironjacamar-spec-api Show documentation
/*
* IronJacamar, a Java EE Connector Architecture implementation
* Copyright 2008-2009, Red Hat Inc, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.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
{
/** Serial version uid */
private static final long serialVersionUID = -229158982387790244L;
/**
* 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);
}
}