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