Package org.apache.derby.iapi.error

Class StandardException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    InterruptDetectedException, LongColumnException, NoSpaceOnPage
    public class StandardException
extends java.lang.Exception
    StandardException is the root of all exceptions that are handled in a standard fashion by the database code, mainly in the language code.

    This class is abstract to ensure that an implementation only throws a specific exception (e.g. TransactionException) which is a sub-class

    A method in an iterface in a protocol under com.ibm.db2j.protocol.Database must only throw a StandardException (if it needs to throw an exception). This indicates that the method can throw an exception and therefore its caller must ensure that any resources it allocates will be cleaned up in the event of an exception in the StandardException hierarchy.

    Implementations of methods that throw StandardException can have throws clause that are more specific than StandardException.

    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected StandardException​(java.lang.String messageID)  
      private StandardException​(java.lang.String sqlState, java.lang.String text)
      This constructor is used when we already have the message text.
      protected StandardException​(java.lang.String messageID, java.lang.Throwable t, java.lang.Object[] args)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static StandardException closeException()
      A special exception to close a session.
      static StandardException getArgumentFerry​(java.sql.SQLException se)
      Unpack the exception, looking for a StandardException, which carries the Derby messageID and arguments.
      java.lang.Object[] getArguments()  
      int getErrorCode()  
      java.lang.String getErrorProperty​(java.lang.String type)
      Get the error code for an error given a type.
      private static java.lang.String getErrorProperty​(java.lang.String messageId, java.lang.String type)  
      java.lang.String getMessage()
      The message stored in the super class Throwable must be set up object creation.
      java.lang.String getMessageId()
      Return the message identifier that is used to look up the error message text in the messages.properties file.
      java.sql.SQLException getNextException()
      Get the next SQLException that should be put into the parent exception when this instance is converted to an SQLException.
      int getSeverity()  
      static int getSeverityFromIdentifier​(java.lang.String messageID)
      Get the severity given a message identifier from org.apache.derby.iapi.reference.SQLState.
      java.lang.String getSQLState()
      Return the 5 character SQL State.
      static java.lang.String getSQLStateFromIdentifier​(java.lang.String messageID)
      Convert a message identifer from org.apache.derby.iapi.reference.SQLState to a SQLState five character string.
      static StandardException interrupt​(java.lang.InterruptedException ie)  
      boolean isLockTimeout()
      Is this a lock timeout exception.
      boolean isLockTimeoutOrDeadlock()
      Is this a lock timeout or lock deadlock exception.
      boolean isSelfDeadlock()
      Is this a self-deadlock exception caused by a nested transaction being blocked by its parent's locks.
      private static boolean isVacuousWrapper​(java.lang.Throwable t)
      Check if the top-level throwable is just a vacuous wrapper that does not carry any useful information except what's returned by the Throwable.getCause() method.
      (package private) void markAsPublicAPI()
      Mark this exception as one that is thrown by a public API method.
      static StandardException newException​(java.lang.String messageId, java.lang.Object... args)  
      static StandardException newException​(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2, java.lang.Throwable t)
      Dummy overload which should never be called.
      static StandardException newException​(java.lang.String messageID, java.lang.Object a1, java.lang.Throwable t)
      Dummy overload which should never be called.
      static StandardException newException​(java.lang.String messageId, java.lang.Throwable t, java.lang.Object... args)  
      static StandardException newPreLocalizedException​(java.lang.String MessageID, java.lang.Throwable t, java.lang.String localizedMessage)
      Creates a new StandardException using message text that has already been localized.
      static java.sql.SQLWarning newWarning​(java.lang.String messageId, java.lang.Object... oa)  
      static StandardException normalClose()  
      static StandardException plainWrapException​(java.lang.Throwable t)
      Similar to unexpectedUserException but makes no assumtion about when the execption is being called.
      int report()
      Yes, report me.
      void setReport​(int report)
      Set my report type.
      void setSeverity​(int severity)  
      java.lang.String toString()
      Don't print the class name in the toString() method.
      static StandardException unexpectedUserException​(java.lang.Throwable t)  

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • arguments

        private transient java.lang.Object[] arguments

      • severity

        private int severity

      • textMessage

        private java.lang.String textMessage

      • sqlState

        private java.lang.String sqlState

      • report

        private transient int report

      • isForPublicAPI

        private transient boolean isForPublicAPI

      • next

        private transient java.sql.SQLException next

    • Constructor Detail

      • StandardException

        protected StandardException​(java.lang.String messageID)

      • StandardException

        protected StandardException​(java.lang.String messageID,
                            java.lang.Throwable t,
                            java.lang.Object[] args)

      • StandardException

        private StandardException​(java.lang.String sqlState,
                          java.lang.String text)
        This constructor is used when we already have the message text.
        Parameters:
        sqlState - the sql state of the message
        text - the text of the message

    • Method Detail

      • getArguments

        public final java.lang.Object[] getArguments()

      • report

        public final int report()
        Yes, report me. Errors that need this method to return false are in the minority.

      • setReport

        public final void setReport​(int report)
        Set my report type.

      • setSeverity

        public final void setSeverity​(int severity)

      • getSeverity

        public final int getSeverity()

      • getErrorCode

        public final int getErrorCode()

      • getSQLState

        public final java.lang.String getSQLState()
        Return the 5 character SQL State. If you need teh identifier that was used to create the message, then use getMessageId(). getMessageId() will return the string that corresponds to the field in org.apache.derby.iapi.reference.SQLState.

      • getNextException

        public final java.sql.SQLException getNextException()
        Get the next SQLException that should be put into the parent exception when this instance is converted to an SQLException.
        Returns:
        the next exception

      • markAsPublicAPI

        final void markAsPublicAPI()
        Mark this exception as one that is thrown by a public API method. The purpose is to signal that this should be a top-level exception, so that it doesn't get wrapped inside multiple layers of other SQLExceptions or StandardExceptions as it travels up through the code layers.
        See Also:
        PublicAPI

      • getSQLStateFromIdentifier

        public static java.lang.String getSQLStateFromIdentifier​(java.lang.String messageID)
        Convert a message identifer from org.apache.derby.iapi.reference.SQLState to a SQLState five character string.
        Parameters:
        messageID - - the sql state id of the message from Derby
        Returns:
        String - the 5 character code of the SQLState ID to returned to the user

      • getSeverityFromIdentifier

        public static int getSeverityFromIdentifier​(java.lang.String messageID)
        Get the severity given a message identifier from org.apache.derby.iapi.reference.SQLState.

      • newException

        public static StandardException newException​(java.lang.String messageId,
                                             java.lang.Object... args)

      • newException

        public static StandardException newException​(java.lang.String messageId,
                                             java.lang.Throwable t,
                                             java.lang.Object... args)

      • newException

        public static StandardException newException​(java.lang.String messageID,
                                             java.lang.Object a1,
                                             java.lang.Object a2,
                                             java.lang.Throwable t)
                                      throws StandardException.BadMessageArgumentException
        Dummy overload which should never be called. Only used to detect incorrect usage, at compile time.
        Parameters:
        messageID - - the sql state id of the message
        a1 - - First message arg
        a2 - - Second message arg
        t - - Incorrectly placed exception to be nested
        Returns:
        nothing - always throws
        Throws:
        StandardException.BadMessageArgumentException - - always (dummy)

      • newPreLocalizedException

        public static StandardException newPreLocalizedException​(java.lang.String MessageID,
                                                         java.lang.Throwable t,
                                                         java.lang.String localizedMessage)
        Creates a new StandardException using message text that has already been localized.
        Parameters:
        MessageID - The SQLState and severity are derived from the ID. However the text message is not.
        t - The Throwable that caused this exception, null if this exception was not caused by another Throwable.
        localizedMessage - The message associated with this exception. It is the caller's responsibility to ensure that this message is properly localized. See org.apache.derby.iapi.tools.i18n.LocalizedResource

      • getArgumentFerry

        public static StandardException getArgumentFerry​(java.sql.SQLException se)
        Unpack the exception, looking for a StandardException, which carries the Derby messageID and arguments.
        See Also:
        SQLExceptionFactory, Util

      • isVacuousWrapper

        private static boolean isVacuousWrapper​(java.lang.Throwable t)
        Check if the top-level throwable is just a vacuous wrapper that does not carry any useful information except what's returned by the Throwable.getCause() method.
        Parameters:
        t - the throwable to check
        Returns:
        true if the throwable is a vacuous wrapper and the only useful piece of information is the cause, or false otherwise

      • unexpectedUserException

        public static StandardException unexpectedUserException​(java.lang.Throwable t)

      • plainWrapException

        public static StandardException plainWrapException​(java.lang.Throwable t)
        Similar to unexpectedUserException but makes no assumtion about when the execption is being called. The error is wrapped as simply as possible.

      • closeException

        public static StandardException closeException()
        A special exception to close a session.

      • getMessage

        public java.lang.String getMessage()
        The message stored in the super class Throwable must be set up object creation. At this time we cannot get any information about the object itself (ie. this) in order to determine the natural language message. Ie. we need to class of the objec in order to look up its message, but we can't get the class of the exception before calling the super class message.

        Thus the message stored by Throwable and obtained by the getMessage() of Throwable (ie. super.getMessage() in this class) is the message identifier. The actual text message is stored in this class at the first request.

        Overrides:
        getMessage in class java.lang.Throwable

      • getMessageId

        public final java.lang.String getMessageId()
        Return the message identifier that is used to look up the error message text in the messages.properties file.

      • getErrorProperty

        public java.lang.String getErrorProperty​(java.lang.String type)
        Get the error code for an error given a type. The value of the property messageId.type will be returned, e.g. deadlock.sqlstate.

      • toString

        public java.lang.String toString()
        Don't print the class name in the toString() method.
        Overrides:
        toString in class java.lang.Throwable

      • getErrorProperty

        private static java.lang.String getErrorProperty​(java.lang.String messageId,
                                                 java.lang.String type)

      • interrupt

        public static StandardException interrupt​(java.lang.InterruptedException ie)

      • newWarning

        public static java.sql.SQLWarning newWarning​(java.lang.String messageId,
                                             java.lang.Object... oa)

      • isLockTimeout

        public final boolean isLockTimeout()
        Is this a lock timeout exception.

        Returns:
        true if this exception is a lock timeout.

      • isSelfDeadlock

        public final boolean isSelfDeadlock()
        Is this a self-deadlock exception caused by a nested transaction being blocked by its parent's locks.

        Returns:
        true if this exception is a self-deadlock.

      • isLockTimeoutOrDeadlock

        public final boolean isLockTimeoutOrDeadlock()
        Is this a lock timeout or lock deadlock exception.

        Returns:
        true if this exception is a lock timeout or lock deadlock.