JreCompat (Apache Tomcat 7.0.108 API Documentation)

org.apache.tomcat.util.compat

## Class JreCompat

- java.lang.Object
- - org.apache.tomcat.util.compat.JreCompat

-     public class JreCompat
      extends Object

  This is the base implementation class for JRE compatibility and provides an implementation based on Java 6. Sub-classes may extend this class and provide alternative implementations for later JRE versions

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `JreCompat()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `abort(Connection connection, Executor executor)`
    `void` | `addBootModulePath(Deque<URL> classPathUrlsToProcess)` Obtains the URls for all the JARs on the module path when the JVM starts and adds them to the provided Deque.
    `boolean` | `canAccess(Object base, AccessibleObject accessibleObject)` Is the accessibleObject accessible (as a result of appropriate module exports) on the provided instance?
    `void` | `closeOnCompletion(Statement statement)`
    `void` | `disableCachingForJarUrlConnections()` Disables caching for JAR URL connections.
    `Locale` | `forLanguageTag(String languageTag)`
    `boolean` | `generatedKeyAlwaysReturned(DatabaseMetaData databaseMetaData)`
    `GZIPOutputStream` | `getFlushableGZipOutputStream(OutputStream os)`
    `static JreCompat` | `getInstance()`
    `InetAddress` | `getLoopbackAddress()`
    `String` | `getModuleName(Class<?> type)` What is the module of the given class?
    `int` | `getNetworkTimeout(Connection connection)`
    `<T> T` | `getObject(CallableStatement callableStatement, int parameterIndex, Class<T> type)`
    `<T> T` | `getObject(CallableStatement callableStatement, String parameterName, Class<T> type)`
    `<T> T` | `getObject(ResultSet resultSet, int parameterIndex, Class<T> type)`
    `<T> T` | `getObject(ResultSet resultSet, String parameterName, Class<T> type)`
    `ResultSet` | `getPseudoColumns(DatabaseMetaData databaseMetaData, String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)`
    `String` | `getSchema(Connection connection)`
    `boolean` | `isCloseOnCompletion(Statement statement)`
    `boolean` | `isCommonsAnnotations1_1Available()`
    `boolean` | `isExported(Class<?> type)` Is the given class in an exported package?
    `boolean` | `isInstanceOfInaccessibleObjectException(Throwable t)` Test if the provided exception is an instance of java.lang.reflect.InaccessibleObjectException.
    `static boolean` | `isJre7Available()`
    `static boolean` | `isJre8Available()`
    `static boolean` | `isJre9Available()`
    `boolean` | `jarFileIsMultiRelease(JarFile jarFile)` Is this JarFile a multi-release JAR file.
    `JarFile` | `jarFileNewInstance(File f)` Creates a new JarFile instance.
    `int` | `jarFileRuntimeMajorVersion()`
    `void` | `setNetworkTimeout(Connection connection, Executor executor, int milliseconds)`
    `void` | `setSchema(Connection connection, String schema)`
    `void` | `setUseServerCipherSuitesOrder(SSLEngine engine, boolean useCipherSuitesOrder)`
    `void` | `setUseServerCipherSuitesOrder(SSLServerSocket socket, boolean useCipherSuitesOrder)`

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

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

- - ### Constructor Detail

    - #### JreCompat

          public JreCompat()

  - ### Method Detail

    - #### getInstance

          public static JreCompat getInstance()

    - #### isJre7Available

          public static boolean isJre7Available()

    - #### forLanguageTag

          public Locale forLanguageTag(String languageTag)

    - #### getFlushableGZipOutputStream

          public GZIPOutputStream getFlushableGZipOutputStream(OutputStream os)

    - #### getObject

          public <T> T getObject(CallableStatement callableStatement,
                        int parameterIndex,
                        Class<T> type)
                      throws SQLException

      Throws:
        `SQLException`

    - #### getObject

          public <T> T getObject(CallableStatement callableStatement,
                        String parameterName,
                        Class<T> type)
                      throws SQLException

      Throws:
        `SQLException`

    - #### setSchema

          public void setSchema(Connection connection,
                       String schema)
                         throws SQLException

      Throws:
        `SQLException`

    - #### getSchema

          public String getSchema(Connection connection)
                           throws SQLException

      Throws:
        `SQLException`

    - #### abort

          public void abort(Connection connection,
                   Executor executor)
                     throws SQLException

      Throws:
        `SQLException`

    - #### setNetworkTimeout

          public void setNetworkTimeout(Connection connection,
                               Executor executor,
                               int milliseconds)
                                 throws SQLException

      Throws:
        `SQLException`

    - #### getNetworkTimeout

          public int getNetworkTimeout(Connection connection)
                                throws SQLException

      Throws:
        `SQLException`

    - #### getPseudoColumns

          public ResultSet getPseudoColumns(DatabaseMetaData databaseMetaData,
                                   String catalog,
                                   String schemaPattern,
                                   String tableNamePattern,
                                   String columnNamePattern)
                                     throws SQLException

      Throws:
        `SQLException`

    - #### generatedKeyAlwaysReturned

          public boolean generatedKeyAlwaysReturned(DatabaseMetaData databaseMetaData)
                                             throws SQLException

      Throws:
        `SQLException`

    - #### getObject

          public <T> T getObject(ResultSet resultSet,
                        int parameterIndex,
                        Class<T> type)
                      throws SQLException

      Throws:
        `SQLException`

    - #### getObject

          public <T> T getObject(ResultSet resultSet,
                        String parameterName,
                        Class<T> type)
                      throws SQLException

      Throws:
        `SQLException`

    - #### closeOnCompletion

          public void closeOnCompletion(Statement statement)
                                 throws SQLException

      Throws:
        `SQLException`

    - #### isCloseOnCompletion

          public boolean isCloseOnCompletion(Statement statement)
                                      throws SQLException

      Throws:
        `SQLException`

    - #### getLoopbackAddress

          public InetAddress getLoopbackAddress()

    - #### isJre8Available

          public static boolean isJre8Available()

    - #### setUseServerCipherSuitesOrder

          public void setUseServerCipherSuitesOrder(SSLServerSocket socket,
                                           boolean useCipherSuitesOrder)

    - #### setUseServerCipherSuitesOrder

          public void setUseServerCipherSuitesOrder(SSLEngine engine,
                                           boolean useCipherSuitesOrder)

    - #### isJre9Available

          public static boolean isJre9Available()

    - #### isInstanceOfInaccessibleObjectException

          public boolean isInstanceOfInaccessibleObjectException(Throwable t)

      Test if the provided exception is an instance of java.lang.reflect.InaccessibleObjectException.
      Parameters:
        `t` - The exception to test
      Returns:
        `true` if the exception is an instance of InaccessibleObjectException, otherwise `false`

    - #### disableCachingForJarUrlConnections

          public void disableCachingForJarUrlConnections()
                                                  throws IOException

      Disables caching for JAR URL connections. For Java 8 and earlier, this also disables caching for ALL URL connections.
      Throws:
        `IOException` - If a dummy JAR URLConnection can not be created

    - #### addBootModulePath

          public void addBootModulePath(Deque<URL> classPathUrlsToProcess)

      Obtains the URls for all the JARs on the module path when the JVM starts and adds them to the provided Deque.
      Parameters:
        `classPathUrlsToProcess` - The Deque to which the modules should be added

    - #### jarFileNewInstance

          public JarFile jarFileNewInstance(File f)
                                     throws IOException

      Creates a new JarFile instance. When running on Java 9 and later, the JarFile will be multi-release JAR aware.
      Parameters:
        `f` - The JAR file to open
      Returns:
        A JarFile instance based on the provided file
      Throws:
        `IOException` - If an I/O error occurs creating the JarFile instance

    - #### jarFileIsMultiRelease

          public boolean jarFileIsMultiRelease(JarFile jarFile)

      Is this JarFile a multi-release JAR file.
      Parameters:
        `jarFile` - The JarFile to test
      Returns:
        `true` If it is a multi-release JAR file and is configured to behave as such.

    - #### jarFileRuntimeMajorVersion

          public int jarFileRuntimeMajorVersion()

    - #### isCommonsAnnotations1_1Available

          public boolean isCommonsAnnotations1_1Available()

    - #### canAccess

          public boolean canAccess(Object base,
                          AccessibleObject accessibleObject)

      Is the accessibleObject accessible (as a result of appropriate module exports) on the provided instance?
      Parameters:
        `base` - The specific instance to be tested.
        `accessibleObject` - The method/field/constructor to be tested.
      Returns:
        {code true} if the AccessibleObject can be accessed otherwise {code false}

    - #### isExported

          public boolean isExported(Class<?> type)

      Is the given class in an exported package?
      Parameters:
        `type` - The class to test
      Returns:
        Always `true` for Java 8. `true` if the enclosing package is exported for Java 9+

    - #### getModuleName

          public String getModuleName(Class<?> type)

      What is the module of the given class?
      Parameters:
        `type` - The class to test
      Returns:
        Always `true` for Java 8. `true` if the enclosing package is exported for Java 9+

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