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