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.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-Set 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 current thread's blocker field.
 104      */
 105     void blockedOn(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 Thread with the given Runnable and an
 128      * inherited AccessControlContext.
 129      */
 130     Thread newThreadWithAcc(Runnable target, AccessControlContext acc);
 131 
 132     /**
 133      * Invokes the finalize method of the given object.
 134      */
 135     void invokeFinalize(Object o) throws Throwable;
 136 
 137     /**
 138      * Returns the ConcurrentHashMap used as a storage for ClassLoaderValue(s)
 139      * associated with the given class loader, creating it if it doesn't already exist.
 140      */
 141     ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl);
 142 
 143     /**
 144      * Defines a class with the given name to a class loader.
 145      */
 146     Class<?> defineClass(ClassLoader cl, String name, byte[] b, ProtectionDomain pd, String source);
 147 
 148     /**
 149      * Returns a class loaded by the bootstrap class loader.
 150      */
 151     Class<?> findBootstrapClassOrNull(ClassLoader cl, String name);
 152 
 153     /**
 154      * Define a Package of the given name and module by the given class loader.
 155      */
 156     Package definePackage(ClassLoader cl, String name, Module module);
 157 
 158     /**
 159      * Invokes Long.fastUUID
 160      */
 161     String fastUUID(long lsb, long msb);
 162 
 163     /**
 164      * Record the non-exported packages of the modules in the given layer
 165      */
 166     void addNonExportedPackages(ModuleLayer layer);
 167 
 168     /**
 169      * Invalidate package access cache
 170      */
 171     void invalidatePackageAccessCache();
 172 
 173     /**
 174      * Defines a new module to the Java virtual machine. The module
 175      * is defined to the given class loader.
 176      *
 177      * The URI is for information purposes only, it can be {@code null}.
 178      */
 179     Module defineModule(ClassLoader loader, ModuleDescriptor descriptor, URI uri);
 180 
 181     /**
 182      * Defines the unnamed module for the given class loader.
 183      */
 184     Module defineUnnamedModule(ClassLoader loader);
 185 
 186     /**
 187      * Updates the readability so that module m1 reads m2. The new read edge
 188      * does not result in a strong reference to m2 (m2 can be GC'ed).
 189      *
 190      * This method is the same as m1.addReads(m2) but without a permission check.
 191      */
 192     void addReads(Module m1, Module m2);
 193 
 194     /**
 195      * Updates module m to read all unnamed modules.
 196      */
 197     void addReadsAllUnnamed(Module m);
 198 
 199     /**
 200      * Updates module m1 to export a package to module m2. The export does
 201      * not result in a strong reference to m2 (m2 can be GC'ed).
 202      */
 203     void addExports(Module m1, String pkg, Module m2);
 204 
 205     /**
 206      * Updates a module m to export a package to all unnamed modules.
 207      */
 208     void addExportsToAllUnnamed(Module m, String pkg);
 209 
 210     /**
 211      * Updates module m1 to open a package to module m2. Opening the
 212      * package does not result in a strong reference to m2 (m2 can be GC'ed).
 213      */
 214     void addOpens(Module m1, String pkg, Module m2);
 215 
 216     /**
 217      * Updates module m to open a package to all unnamed modules.
 218      */
 219     void addOpensToAllUnnamed(Module m, String pkg);
 220 
 221     /**
 222      * Updates module m to open all packages returned by the given iterator.
 223      */
 224     void addOpensToAllUnnamed(Module m, Iterator<String> packages);
 225 
 226     /**
 227      * Updates module m to use a service.
 228      */
 229     void addUses(Module m, Class<?> service);
 230 
 231     /**
 232      * Returns true if module m reflectively exports a package to other
 233      */
 234     boolean isReflectivelyExported(Module module, String pn, Module other);
 235 
 236     /**
 237      * Returns true if module m reflectively opens a package to other
 238      */
 239     boolean isReflectivelyOpened(Module module, String pn, Module other);
 240 
 241     /**
 242      * Returns the ServicesCatalog for the given Layer.
 243      */
 244     ServicesCatalog getServicesCatalog(ModuleLayer layer);
 245 
 246     /**
 247      * Returns an ordered stream of layers. The first element is the
 248      * given layer, the remaining elements are its parents, in DFS order.
 249      */
 250     Stream<ModuleLayer> layers(ModuleLayer layer);
 251 
 252     /**
 253      * Returns a stream of the layers that have modules defined to the
 254      * given class loader.
 255      */
 256     Stream<ModuleLayer> layers(ClassLoader loader);
 257 
 258     /**
 259      * Returns a new string by decoding from the given utf8 bytes array.
 260      *
 261      * @param off the index of the first byte to decode
 262      * @param len the number of bytes to decode
 263      * @return the newly created string
 264      * @throws IllegalArgumentException for malformed or unmappable bytes.
 265      */
 266     String newStringUTF8NoRepl(byte[] bytes, int off, int len);
 267 
 268     /**
 269      * Encode the given string into a sequence of bytes using utf8.
 270      *
 271      * @param s the string to encode
 272      * @return the encoded bytes in utf8
 273      * @throws IllegalArgumentException for malformed surrogates
 274      */
 275     byte[] getBytesUTF8NoRepl(String s);
 276 }