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