Utils (Apache Tomcat 8.5.20 API Documentation)

org.apache.tomcat.dbcp.dbcp2

## Class Utils

- java.lang.Object
- - org.apache.tomcat.dbcp.dbcp2.Utils

-     public final class Utils
      extends Object

  Utility methods.
  Since:
    2.0

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `DISCONNECTION_SQL_CODE_PREFIX` Any SQL_STATE starting with this value is considered a fatal disconnect
    `static Set<String>` | `DISCONNECTION_SQL_CODES` SQL codes of fatal connection errors.
    `static boolean` | `IS_SECURITY_ENABLED`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static void` | `closeQuietly(Connection conn)` Closes the Connection (which may be null).
    `static void` | `closeQuietly(ResultSet rset)` Closes the ResultSet (which may be null).
    `static void` | `closeQuietly(Statement stmt)` Closes the Statement (which may be null).
    `static String` | `getMessage(String key)` Obtain the correct i18n message for the given key.
    `static String` | `getMessage(String key, Object... args)` Obtain the correct i18n message for the given key with placeholders replaced by the supplied arguments.

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### IS_SECURITY_ENABLED

          public static final boolean IS_SECURITY_ENABLED

    - #### DISCONNECTION_SQL_CODE_PREFIX

          public static final String DISCONNECTION_SQL_CODE_PREFIX

      Any SQL_STATE starting with this value is considered a fatal disconnect
      See Also:
        Constant Field Values

    - #### DISCONNECTION_SQL_CODES

          public static final Set<String> DISCONNECTION_SQL_CODES

      SQL codes of fatal connection errors.
      - 57P01 (ADMIN SHUTDOWN)
      - 57P02 (CRASH SHUTDOWN)
      - 57P03 (CANNOT CONNECT NOW)
      - 01002 (SQL92 disconnect error)
      - JZ0C0 (Sybase disconnect error)
      - JZ0C1 (Sybase disconnect error)

  - ### Method Detail

    - #### closeQuietly

          public static void closeQuietly(ResultSet rset)

      Closes the ResultSet (which may be null).
      Parameters:
        `rset` - a ResultSet, may be `null`

    - #### closeQuietly

          public static void closeQuietly(Connection conn)

      Closes the Connection (which may be null).
      Parameters:
        `conn` - a Connection, may be `null`

    - #### closeQuietly

          public static void closeQuietly(Statement stmt)

      Closes the Statement (which may be null).
      Parameters:
        `stmt` - a Statement, may be `null`

    - #### getMessage

          public static String getMessage(String key)

      Obtain the correct i18n message for the given key.
      Parameters:
        `key` - The message key
      Returns:
        the message

    - #### getMessage

          public static String getMessage(String key,
                          Object... args)

      Obtain the correct i18n message for the given key with placeholders replaced by the supplied arguments.
      Parameters:
        `key` - The message key
        `args` - The arguments
      Returns:
        the message

Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.