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