Package org.apache.tomcat.util.compat
Class JreCompat
- java.lang.Object
-
- org.apache.tomcat.util.compat.JreCompat
-
- Direct Known Subclasses:
Jre19Compat
public class JreCompat extends Object
This is the base implementation class for JRE compatibility and provides an implementation based on Java 8. Sub-classes may extend this class and provide alternative implementations for later JRE versions
-
-
Field Summary
Fields Modifier and Type Field Description protected static MethodgetApplicationProtocolMethodprotected static MethodsetApplicationProtocolsMethod
-
Constructor Summary
Constructors Constructor Description JreCompat()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddBootModulePath(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.booleancanAccess(Object base, AccessibleObject accessibleObject)Is the accessibleObject accessible (as a result of appropriate module exports) on the provided instance?voiddisableCachingForJarUrlConnections()Disables caching for JAR URL connections.StringgetApplicationProtocol(SSLEngine sslEngine)Get the application protocol that has been negotiated for connection associated with the given SSLEngine.ObjectgetExecutor(Thread thread)Obtains the executor, if any, used to create the provided thread.static JreCompatgetInstance()StringgetModuleName(Class<?> type)What is the module of the given class?SocketAddressgetUnixDomainSocketAddress(String path)Return Unix domain socket address for given path.static booleanisAlpnSupported()booleanisExported(Class<?> type)Is the given class in an exported package?static booleanisGraalAvailable()booleanisInstanceOfInaccessibleObjectException(Throwable t)Test if the provided exception is an instance of java.lang.reflect.InaccessibleObjectException.static booleanisJre11Available()static booleanisJre16Available()static booleanisJre19Available()static booleanisJre9Available()booleanjarFileIsMultiRelease(JarFile jarFile)Is this JarFile a multi-release JAR file.JarFilejarFileNewInstance(File f)Creates a new JarFile instance.JarFilejarFileNewInstance(String s)Creates a new JarFile instance.intjarFileRuntimeMajorVersion()ServerSocketChannelopenUnixDomainServerSocketChannel()Create server socket channel using the Unix domain socket ProtocolFamily.SocketChannelopenUnixDomainSocketChannel()Create socket channel using the Unix domain socket ProtocolFamily.voidsetApplicationProtocols(SSLParameters sslParameters, String[] protocols)Set the application protocols the server will accept for ALPN
-
-
-
Method Detail
-
getInstance
public static JreCompat getInstance()
-
isGraalAvailable
public static boolean isGraalAvailable()
-
isAlpnSupported
public static boolean isAlpnSupported()
-
isJre9Available
public static boolean isJre9Available()
-
isJre11Available
public static boolean isJre11Available()
-
isJre16Available
public static boolean isJre16Available()
-
isJre19Available
public static boolean isJre19Available()
-
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:
trueif the exception is an instance of InaccessibleObjectException, otherwisefalse
-
setApplicationProtocols
public void setApplicationProtocols(SSLParameters sslParameters, String[] protocols)
Set the application protocols the server will accept for ALPN- Parameters:
sslParameters- The SSL parameters for a connectionprotocols- The application protocols to be allowed for that connection
-
getApplicationProtocol
public String getApplicationProtocol(SSLEngine sslEngine)
Get the application protocol that has been negotiated for connection associated with the given SSLEngine.- Parameters:
sslEngine- The SSLEngine for which to obtain the negotiated protocol- Returns:
- The name of the negotiated protocol
-
disableCachingForJarUrlConnections
public void disableCachingForJarUrlConnections() throws IOExceptionDisables 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 final JarFile jarFileNewInstance(String s) throws IOException
Creates a new JarFile instance. When running on Java 9 and later, the JarFile will be multi-release JAR aware. While this isn't strictly required to be in this package, it is provided as a convenience method.- Parameters:
s- The JAR file to open- Returns:
- A JarFile instance based on the provided path
- Throws:
IOException- If an I/O error occurs creating the JarFile instance
-
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:
trueIf it is a multi-release JAR file and is configured to behave as such.
-
jarFileRuntimeMajorVersion
public int jarFileRuntimeMajorVersion()
-
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
truefor Java 8.trueif 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
truefor Java 8.trueif the enclosing package is exported for Java 9+
-
getUnixDomainSocketAddress
public SocketAddress getUnixDomainSocketAddress(String path)
Return Unix domain socket address for given path.- Parameters:
path- The path- Returns:
- the socket address
-
openUnixDomainServerSocketChannel
public ServerSocketChannel openUnixDomainServerSocketChannel()
Create server socket channel using the Unix domain socket ProtocolFamily.- Returns:
- the server socket channel
-
openUnixDomainSocketChannel
public SocketChannel openUnixDomainSocketChannel()
Create socket channel using the Unix domain socket ProtocolFamily.- Returns:
- the socket channel
-
getExecutor
public Object getExecutor(Thread thread) throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException
Obtains the executor, if any, used to create the provided thread.- Parameters:
thread- The thread to examine- Returns:
- The executor, if any, that created the provided thread
- Throws:
NoSuchFieldException- If a field used via reflection to obtain the executor cannot be foundSecurityException- If a security exception occurs while trying to identify the executorIllegalArgumentException- If the instance object does not match the class of the field when obtaining a field value via reflectionIllegalAccessException- If a field is not accessible due to access restrictions
-
-