1 /* 2 * Copyright (c) 2003, 2017, 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.misc; 27 28 import java.lang.annotation.Annotation; 29 import java.lang.module.ModuleDescriptor; 30 import java.lang.reflect.Executable; 31 import java.lang.reflect.Method; 32 import java.net.URI; 33 import java.security.AccessControlContext; 34 import java.security.ProtectionDomain; 35 import java.util.Iterator; 36 import java.util.List; 37 import java.util.Map; 38 import java.util.concurrent.ConcurrentHashMap; 39 import java.util.stream.Stream; 40 41 import jdk.internal.module.ServicesCatalog; 42 import jdk.internal.reflect.ConstantPool; 43 import sun.reflect.annotation.AnnotationType; 44 import sun.nio.ch.Interruptible; 45 46 public interface JavaLangAccess { 47 48 /** 49 * Returns the list of {@code Method} objects for the declared public 50 * methods of this class or interface that have the specified method name 51 * and parameter types. 52 */ 53 List<Method> getDeclaredPublicMethods(Class<?> klass, String name, Class<?>... parameterTypes); 54 55 /** 56 * Return the constant pool for a class. 57 */ 58 ConstantPool getConstantPool(Class<?> klass); 59 60 /** 61 * Compare-And-Swap the AnnotationType instance corresponding to this class. 62 * (This method only applies to annotation types.) 63 */ 64 boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType); 65 66 /** 67 * Get the AnnotationType instance corresponding to this class. 68 * (This method only applies to annotation types.) 69 */ 70 AnnotationType getAnnotationType(Class<?> klass); 71 72 /** 73 * Get the declared annotations for a given class, indexed by their types. 74 */ 75 Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass); 76 77 /** 78 * Get the array of bytes that is the class-file representation 79 * of this Class' annotations. 80 */ 81 byte[] getRawClassAnnotations(Class<?> klass); 82 83 /** 84 * Get the array of bytes that is the class-file representation 85 * of this Class' type annotations. 86 */ 87 byte[] getRawClassTypeAnnotations(Class<?> klass); 88 89 /** 90 * Get the array of bytes that is the class-file representation 91 * of this Executable's type annotations. 92 */ 93 byte[] getRawExecutableTypeAnnotations(Executable executable); 94 95 /** 96 * Returns the elements of an enum class or null if the 97 * Class object does not represent an enum type; 98 * the result is uncloned, cached, and shared by all callers. 99 */ 100 <E extends Enum<E>> E[] getEnumConstantsShared(Class<E> klass); 101 102 /** 103 * Set thread's blocker field. 104 */ 105 void blockedOn(Thread t, Interruptible b); 106 107 /** 108 * Registers a shutdown hook. 109 * 110 * It is expected that this method with registerShutdownInProgress=true 111 * is only used to register DeleteOnExitHook since the first file 112 * may be added to the delete on exit list by the application shutdown 113 * hooks. 114 * 115 * @param slot the slot in the shutdown hook array, whose element 116 * will be invoked in order during shutdown 117 * @param registerShutdownInProgress true to allow the hook 118 * to be registered even if the shutdown is in progress. 119 * @param hook the hook to be registered 120 * 121 * @throws IllegalStateException if shutdown is in progress and 122 * the slot is not valid to register. 123 */ 124 void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook); 125 126 /** 127 * Returns a new string backed by the provided character array. The 128 * character array is not copied and must never be modified after the 129 * String is created, in order to fulfill String's contract. 130 * 131 * @param chars the character array to back the string 132 * @return a newly created string whose content is the character array 133 */ 134 String newStringUnsafe(char[] chars); 135 136 /** 137 * Returns a new Thread with the given Runnable and an 138 * inherited AccessControlContext. 139 */ 140 Thread newThreadWithAcc(Runnable target, AccessControlContext acc); 141 142 /** 143 * Invokes the finalize method of the given object. 144 */ 145 void invokeFinalize(Object o) throws Throwable; 146 147 /** 148 * Returns the ConcurrentHashMap used as a storage for ClassLoaderValue(s) 149 * associated with the given class loader, creating it if it doesn't already exist. 150 */ 151 ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl); 152 153 /** 154 * Defines a class with the given name to a class loader. 155 */ 156 Class<?> defineClass(ClassLoader cl, String name, byte[] b, ProtectionDomain pd, String source); 157 158 /** 159 * Returns a class loaded by the bootstrap class loader. 160 */ 161 Class<?> findBootstrapClassOrNull(ClassLoader cl, String name); 162 163 /** 164 * Define a Package of the given name and module by the given class loader. 165 */ 166 Package definePackage(ClassLoader cl, String name, Module module); 167 168 /** 169 * Invokes Long.fastUUID 170 */ 171 String fastUUID(long lsb, long msb); 172 173 /** 174 * Record the non-exported packages of the modules in the given layer 175 */ 176 void addNonExportedPackages(ModuleLayer layer); 177 178 /** 179 * Invalidate package access cache 180 */ 181 void invalidatePackageAccessCache(); 182 183 /** 184 * Defines a new module to the Java virtual machine. The module 185 * is defined to the given class loader. 186 * 187 * The URI is for information purposes only, it can be {@code null}. 188 */ 189 Module defineModule(ClassLoader loader, ModuleDescriptor descriptor, URI uri); 190 191 /** 192 * Defines the unnamed module for the given class loader. 193 */ 194 Module defineUnnamedModule(ClassLoader loader); 195 196 /** 197 * Updates the readability so that module m1 reads m2. The new read edge 198 * does not result in a strong reference to m2 (m2 can be GC'ed). 199 * 200 * This method is the same as m1.addReads(m2) but without a permission check. 201 */ 202 void addReads(Module m1, Module m2); 203 204 /** 205 * Updates module m to read all unnamed modules. 206 */ 207 void addReadsAllUnnamed(Module m); 208 209 /** 210 * Updates module m1 to export a package to module m2. The export does 211 * not result in a strong reference to m2 (m2 can be GC'ed). 212 */ 213 void addExports(Module m1, String pkg, Module m2); 214 215 /** 216 * Updates a module m to export a package to all unnamed modules. 217 */ 218 void addExportsToAllUnnamed(Module m, String pkg); 219 220 /** 221 * Updates module m1 to open a package to module m2. Opening the 222 * package does not result in a strong reference to m2 (m2 can be GC'ed). 223 */ 224 void addOpens(Module m1, String pkg, Module m2); 225 226 /** 227 * Updates module m to open a package to all unnamed modules. 228 */ 229 void addOpensToAllUnnamed(Module m, String pkg); 230 231 /** 232 * Updates module m to open all packages returned by the given iterator. 233 */ 234 void addOpensToAllUnnamed(Module m, Iterator<String> packages); 235 236 /** 237 * Updates module m to use a service. 238 */ 239 void addUses(Module m, Class<?> service); 240 241 /** 242 * Returns true if module m reflectively exports a package to other 243 */ 244 boolean isReflectivelyExported(Module module, String pn, Module other); 245 246 /** 247 * Returns true if module m reflectively opens a package to other 248 */ 249 boolean isReflectivelyOpened(Module module, String pn, Module other); 250 251 /** 252 * Returns the ServicesCatalog for the given Layer. 253 */ 254 ServicesCatalog getServicesCatalog(ModuleLayer layer); 255 256 /** 257 * Returns an ordered stream of layers. The first element is is the 258 * given layer, the remaining elements are its parents, in DFS order. 259 */ 260 Stream<ModuleLayer> layers(ModuleLayer layer); 261 262 /** 263 * Returns a stream of the layers that have modules defined to the 264 * given class loader. 265 */ 266 Stream<ModuleLayer> layers(ClassLoader loader); 267 }