1 /* 2 * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package jdk.internal.access; 27 28 import java.lang.annotation.Annotation; 29 import java.lang.invoke.MethodHandle; 30 import java.lang.invoke.MethodHandles; 31 import java.lang.invoke.MethodType; 32 import java.lang.module.ModuleDescriptor; 33 import java.lang.reflect.Executable; 34 import java.lang.reflect.Method; 35 import java.net.URI; 36 import java.nio.charset.CharacterCodingException; 37 import java.nio.charset.Charset; 38 import java.security.AccessControlContext; 39 import java.security.ProtectionDomain; 40 import java.util.List; 41 import java.util.Map; 42 import java.util.Set; 43 import java.util.concurrent.ConcurrentHashMap; 44 import java.util.stream.Stream; 45 46 import jdk.internal.module.ServicesCatalog; 47 import jdk.internal.reflect.ConstantPool; 48 import sun.reflect.annotation.AnnotationType; 49 import sun.nio.ch.Interruptible; 50 51 public interface JavaLangAccess { 52 53 /** 54 * Returns the list of {@code Method} objects for the declared public 55 * methods of this class or interface that have the specified method name 56 * and parameter types. 57 */ 58 List<Method> getDeclaredPublicMethods(Class<?> klass, String name, Class<?>... parameterTypes); 59 60 /** 61 * Return the constant pool for a class. 62 */ 63 ConstantPool getConstantPool(Class<?> klass); 64 65 /** 66 * Compare-And-Set the AnnotationType instance corresponding to this class. 67 * (This method only applies to annotation types.) 68 */ 69 boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType); 70 71 /** 72 * Get the AnnotationType instance corresponding to this class. 73 * (This method only applies to annotation types.) 74 */ 75 AnnotationType getAnnotationType(Class<?> klass); 76 77 /** 78 * Get the declared annotations for a given class, indexed by their types. 79 */ 80 Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass); 81 82 /** 83 * Get the array of bytes that is the class-file representation 84 * of this Class' annotations. 85 */ 86 byte[] getRawClassAnnotations(Class<?> klass); 87 88 /** 89 * Get the array of bytes that is the class-file representation 90 * of this Class' type annotations. 91 */ 92 byte[] getRawClassTypeAnnotations(Class<?> klass); 93 94 /** 95 * Get the array of bytes that is the class-file representation 96 * of this Executable's type annotations. 97 */ 98 byte[] getRawExecutableTypeAnnotations(Executable executable); 99 100 /** 101 * Returns the elements of an enum class or null if the 102 * Class object does not represent an enum type; 103 * the result is uncloned, cached, and shared by all callers. 104 */ 105 <E extends Enum<E>> E[] getEnumConstantsShared(Class<E> klass); 106 107 /** 108 * Set current thread's blocker field. 109 */ 110 void blockedOn(Interruptible b); 111 112 /** 113 * Registers a shutdown hook. 114 * 115 * It is expected that this method with registerShutdownInProgress=true 116 * is only used to register DeleteOnExitHook since the first file 117 * may be added to the delete on exit list by the application shutdown 118 * hooks. 119 * 120 * @param slot the slot in the shutdown hook array, whose element 121 * will be invoked in order during shutdown 122 * @param registerShutdownInProgress true to allow the hook 123 * to be registered even if the shutdown is in progress. 124 * @param hook the hook to be registered 125 * 126 * @throws IllegalStateException if shutdown is in progress and 127 * the slot is not valid to register. 128 */ 129 void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook); 130 131 /** 132 * Returns a new Thread with the given Runnable and an 133 * inherited AccessControlContext. 134 */ 135 Thread newThreadWithAcc(Runnable target, AccessControlContext acc); 136 137 /** 138 * Invokes the finalize method of the given object. 139 */ 140 void invokeFinalize(Object o) throws Throwable; 141 142 /** 143 * Returns the ConcurrentHashMap used as a storage for ClassLoaderValue(s) 144 * associated with the given class loader, creating it if it doesn't already exist. 145 */ 146 ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl); 147 148 /** 149 * Defines a class with the given name to a class loader. 150 */ 151 Class<?> defineClass(ClassLoader cl, String name, byte[] b, ProtectionDomain pd, String source); 152 153 /** 154 * Defines a class with the given name to a class loader with 155 * the given flags and class data. 156 * 157 * @see java.lang.invoke.MethodHandles.Lookup#defineClass 158 */ 159 Class<?> defineClass(ClassLoader cl, Class<?> lookup, String name, byte[] b, ProtectionDomain pd, boolean initialize, int flags, Object classData); 160 161 /** 162 * Returns a class loaded by the bootstrap class loader. 163 */ 164 Class<?> findBootstrapClassOrNull(ClassLoader cl, String name); 165 166 /** 167 * Define a Package of the given name and module by the given class loader. 168 */ 169 Package definePackage(ClassLoader cl, String name, Module module); 170 171 /** 172 * Invokes Long.fastUUID 173 */ 174 String fastUUID(long lsb, long msb); 175 176 /** 177 * Record the non-exported packages of the modules in the given layer 178 */ 179 void addNonExportedPackages(ModuleLayer layer); 180 181 /** 182 * Invalidate package access cache 183 */ 184 void invalidatePackageAccessCache(); 185 186 /** 187 * Defines a new module to the Java virtual machine. The module 188 * is defined to the given class loader. 189 * 190 * The URI is for information purposes only, it can be {@code null}. 191 */ 192 Module defineModule(ClassLoader loader, ModuleDescriptor descriptor, URI uri); 193 194 /** 195 * Defines the unnamed module for the given class loader. 196 */ 197 Module defineUnnamedModule(ClassLoader loader); 198 199 /** 200 * Updates the readability so that module m1 reads m2. The new read edge 201 * does not result in a strong reference to m2 (m2 can be GC'ed). 202 * 203 * This method is the same as m1.addReads(m2) but without a permission check. 204 */ 205 void addReads(Module m1, Module m2); 206 207 /** 208 * Updates module m to read all unnamed modules. 209 */ 210 void addReadsAllUnnamed(Module m); 211 212 /** 213 * Updates module m1 to export a package to module m2. The export does 214 * not result in a strong reference to m2 (m2 can be GC'ed). 215 */ 216 void addExports(Module m1, String pkg, Module m2); 217 218 /** 219 * Updates a module m to export a package to all unnamed modules. 220 */ 221 void addExportsToAllUnnamed(Module m, String pkg); 222 223 /** 224 * Updates module m1 to open a package to module m2. Opening the 225 * package does not result in a strong reference to m2 (m2 can be GC'ed). 226 */ 227 void addOpens(Module m1, String pkg, Module m2); 228 229 /** 230 * Updates module m to open a package to all unnamed modules. 231 */ 232 void addOpensToAllUnnamed(Module m, String pkg); 233 234 /** 235 * Updates module m to open all packages in the given sets. 236 */ 237 void addOpensToAllUnnamed(Module m, Set<String> concealedPkgs, Set<String> exportedPkgs); 238 239 /** 240 * Updates module m to use a service. 241 */ 242 void addUses(Module m, Class<?> service); 243 244 /** 245 * Returns true if module m reflectively exports a package to other 246 */ 247 boolean isReflectivelyExported(Module module, String pn, Module other); 248 249 /** 250 * Returns true if module m reflectively opens a package to other 251 */ 252 boolean isReflectivelyOpened(Module module, String pn, Module other); 253 254 /** 255 * Returns the ServicesCatalog for the given Layer. 256 */ 257 ServicesCatalog getServicesCatalog(ModuleLayer layer); 258 259 /** 260 * Returns an ordered stream of layers. The first element is the 261 * given layer, the remaining elements are its parents, in DFS order. 262 */ 263 Stream<ModuleLayer> layers(ModuleLayer layer); 264 265 /** 266 * Returns a stream of the layers that have modules defined to the 267 * given class loader. 268 */ 269 Stream<ModuleLayer> layers(ClassLoader loader); 270 271 /** 272 * Constructs a new {@code String} by decoding the specified subarray of 273 * bytes using the specified {@linkplain java.nio.charset.Charset charset}. 274 * 275 * The caller of this method shall relinquish and transfer the ownership of 276 * the byte array to the callee since the later will not make a copy. 277 * 278 * @param bytes the byte array source 279 * @param cs the Charset 280 * @return the newly created string 281 * @throws CharacterCodingException for malformed or unmappable bytes 282 */ 283 String newStringNoRepl(byte[] bytes, Charset cs) throws CharacterCodingException; 284 285 /** 286 * Encode the given string into a sequence of bytes using the specified Charset. 287 * 288 * This method avoids copying the String's internal representation if the input 289 * is ASCII. 290 * 291 * This method throws CharacterCodingException instead of replacing when 292 * malformed input or unmappable characters are encountered. 293 * 294 * @param s the string to encode 295 * @param cs the charset 296 * @return the encoded bytes 297 * @throws CharacterCodingException for malformed input or unmappable characters 298 */ 299 byte[] getBytesNoRepl(String s, Charset cs) throws CharacterCodingException; 300 301 /** 302 * Returns a new string by decoding from the given utf8 bytes array. 303 * 304 * @param off the index of the first byte to decode 305 * @param len the number of bytes to decode 306 * @return the newly created string 307 * @throws IllegalArgumentException for malformed or unmappable bytes. 308 */ 309 String newStringUTF8NoRepl(byte[] bytes, int off, int len); 310 311 /** 312 * Encode the given string into a sequence of bytes using utf8. 313 * 314 * @param s the string to encode 315 * @return the encoded bytes in utf8 316 * @throws IllegalArgumentException for malformed surrogates 317 */ 318 byte[] getBytesUTF8NoRepl(String s); 319 320 /** 321 * Set the cause of Throwable 322 * @param cause set t's cause to new value 323 */ 324 void setCause(Throwable t, Throwable cause); 325 326 /** 327 * Get protection domain of the given Class 328 */ 329 ProtectionDomain protectionDomain(Class<?> c); 330 331 /** 332 * Get a method handle of string concat helper method 333 */ 334 MethodHandle stringConcatHelper(String name, MethodType methodType); 335 336 /* 337 * Get the class data associated with the given class. 338 * @param c the class 339 * @see java.lang.invoke.MethodHandles.Lookup#defineHiddenClass(byte[], boolean, MethodHandles.Lookup.ClassOption...) 340 */ 341 Object classData(Class<?> c); 342 }