javax.resource.ResourceException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2008-2009, Red Hat Middleware LLC, 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;

import java.security.AccessController;
import java.security.PrivilegedAction;

/**
 * This is the root interface of the exception hierarchy defined
 * for the Connector architecture.
 * 
 * The ResourceException provides the following information:
 * 
 *    A resource adapter vendor specific string describing the error.
 *        This string is a standard Java exception message and is available
 *        through getMessage() method.
 *    resource adapter vendor specific error code.
 *    reference to another exception. Often a resource exception
 *        will be result of a lower level problem. If appropriate, this
 *        lower level exception can be linked to the ResourceException.
 *        Note, this has been deprecated in favor of J2SE release 1.4 exception
 *        chaining facility.
 * 
 *
 * @version 1.0
 * @author Rahul Sharma
 * @author Ram Jeyaraman
 */

public class ResourceException extends Exception 
{
   /** Serial version UID */
   private static final long serialVersionUID;

   static
   {
      Boolean legacy = (Boolean)AccessController.doPrivileged(new PrivilegedAction()
      {
         public Boolean run()
         {
            try
            {
               if (System.getProperty("org.jboss.j2ee.LegacySerialization") != null)
                  return Boolean.TRUE;
            }
            catch (Throwable ignored)
            {
               // Ignore
            }
            return Boolean.FALSE;
         }
      });

      if (Boolean.TRUE.equals(legacy))
      {
         serialVersionUID = 4770679801401540475L;
      }
      else
      {
         serialVersionUID = 547071213627824490L;
      }
   }

   /** Vendor specific error code */
   private String errorCode;
   
   /** reference to another exception */
   private Exception linkedException;
   
   /**
    * Constructs a new instance with null as its detail message.
    */
   public ResourceException()
   { 
      super();
   }
   
   /**
    * Constructs a new instance with the specified detail message.
    *
    * @param message the detail message.
    */
   public ResourceException(String message)
   {
      super(message);
   }
   
   /**
    * Constructs a new throwable with the specified cause.
    *
    * @param cause a chained exception of type Throwable.
    */
   public ResourceException(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 ResourceException(String message, Throwable cause) 
   {
      super(message, cause);
   }
   
   /**
    * Create a new throwable with the specified message and error code.
    *
    * @param message a description of the exception.
    * @param errorCode a string specifying the vendor specific error code.
    */
   public ResourceException(String message, String errorCode) 
   {
      super(message);
      this.errorCode = errorCode;
   }    
   
   /**
    * Set the error code.
    *
    * @param errorCode the error code.
    */
   public void setErrorCode(String errorCode) 
   {
      this.errorCode = errorCode;
   }
   
   /**
    * Get the error code.
    *
    * @return the error code.
    */
   public String getErrorCode() 
   {
      return this.errorCode;
   }
   
   /**
    * Get the exception linked to this ResourceException
    *
    * @return         linked Exception, null if none
    *
    * @deprecated J2SE release 1.4 supports a chained exception facility 
    * that allows any throwable to know about another throwable, if any,
    * that caused it to get thrown. Refer to getCause and 
    * initCause methods of the 
    * java.lang.Throwable class..
    */
   public Exception getLinkedException() 
   {
      return linkedException;
   }
   
   /**
    * Add a linked Exception to this ResourceException.
    *
    * @param ex       linked Exception
    *
    * @deprecated J2SE release 1.4 supports a chained exception facility 
    * that allows any throwable to know about another throwable, if any,
    * that caused it to get thrown. Refer to getCause and 
    * initCause methods of the 
    * java.lang.Throwable class.
    */
   public void setLinkedException(Exception ex) 
   {
      linkedException = ex;
   }
   
   /**
    * Returns a detailed message string describing this exception.
    *
    * @return a detailed message string.
    */
   public String getMessage() 
   {
      String msg = super.getMessage();
      String ec = getErrorCode();
      if ((msg == null) && (ec == null)) 
      {
         return null;
      }
      if ((msg != null) && (ec != null)) 
      {
         return (msg + ", error code: " + ec);
      }
      return ((msg != null) ? msg : ("error code: " + ec));
   }
}