jdk/src/java.base/share/classes/sun/util/locale/provider/ResourceBundleProviderSupport.java
author alanb
Thu, 17 Mar 2016 19:04:16 +0000
changeset 36511 9d0388c6b336
permissions -rw-r--r--
8142968: Module System implementation Summary: Initial integration of JEP 200, JEP 260, JEP 261, and JEP 282 Reviewed-by: alanb, mchung, naoto, rriggs, psandoz, plevart, mullan, ascarpino, vinnie, prr, sherman, dfuchs, mhaupt Contributed-by: alan.bateman@oracle.com, alex.buckley@oracle.com, jonathan.gibbons@oracle.com, karen.kinnear@oracle.com, mandy.chung@oracle.com, mark.reinhold@oracle.com, chris.hegarty@oracle.com, alexandr.scherbatiy@oracle.com, amy.lu@oracle.com, calvin.cheung@oracle.com, daniel.fuchs@oracle.com, erik.joelsson@oracle.com, harold.seigel@oracle.com, jaroslav.bachorik@oracle.com, jean-francois.denise@oracle.com, jan.lahoda@oracle.com, james.laskey@oracle.com, lois.foltan@oracle.com, miroslav.kos@oracle.com, huaming.li@oracle.com, sean.mullan@oracle.com, naoto.sato@oracle.com, masayoshi.okutsu@oracle.com, peter.levart@gmail.com, philip.race@oracle.com, claes.redestad@oracle.com, sergey.bylokhov@oracle.com, alexandre.iline@oracle.com, volker.simonis@gmail.com, staffan.larsen@oracle.com, stuart.marks@oracle.com, semyon.sadetsky@oracle.com, serguei.spitsyn@oracle.com, sundararajan.athijegannathan@oracle.com, valerie.peng@oracle.com, vincent.x.ryan@oracle.com, weijun.wang@oracle.com, yuri.nesterenko@oracle.com, yekaterina.kantserova@oracle.com, alexander.kulyakhtin@oracle.com, felix.yang@oracle.com, andrei.eremeev@oracle.com, frank.yuan@oracle.com, sergei.pikalev@oracle.com, sibabrata.sahoo@oracle.com, tiantian.du@oracle.com, sha.jiang@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     1
/*
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     2
 * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     4
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    10
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    15
 * accompanied this code).
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    16
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    20
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    23
 * questions.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    24
 */
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    25
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    26
package sun.util.locale.provider;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    27
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    28
import java.io.IOException;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    29
import java.io.InputStream;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    30
import java.io.UncheckedIOException;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    31
import java.lang.reflect.Constructor;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    32
import java.lang.reflect.InvocationTargetException;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    33
import java.lang.reflect.Modifier;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    34
import java.lang.reflect.Module;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    35
import java.security.AccessController;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    36
import java.security.PrivilegedAction;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    37
import java.util.PropertyResourceBundle;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    38
import java.util.ResourceBundle;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    39
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    40
/**
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    41
 * ResourceBundleProviderSupport provides convenience methods for loading
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    42
 * resource bundles.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    43
 */
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    44
public class ResourceBundleProviderSupport {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    45
    /**
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    46
     * Loads a {@code ResourceBundle} of the given {@code bundleName} local to
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    47
     * the given {@code module}.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    48
     *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    49
     * @apiNote
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    50
     * {@link Class#forName(Module, String)} does a stack-based permission check.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    51
     * Caller of this method is responsible for doing an appropriate permission
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    52
     * on behalf of the caller before calling this method.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    53
     *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    54
     * @param module     the module from which the {@code ResourceBundle} is loaded
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    55
     * @param bundleName the bundle name for the {@code ResourceBundle} class,
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    56
     *                   such as "com.example.app.MyResources_fr"
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    57
     * @return the {@code ResourceBundle}, or null if no {@code ResourceBundle} is found
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    58
     * @throws SecurityException
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    59
     *         if a security manager exists, it denies loading the class given by
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    60
     *         {@code bundleName} from the given {@code module}.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    61
     *         If the given module is "java.base", this method will not do security check.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    62
     * @throws NullPointerException
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    63
     *         if {@code module} or {@code bundleName) is null
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    64
     * @see Class#forName(Module, String)
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    65
     */
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    66
    public static ResourceBundle loadResourceBundle(Module module, String bundleName)
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    67
    {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    68
        Class<?> c = Class.forName(module, bundleName);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    69
        if (c != null && ResourceBundle.class.isAssignableFrom(c)) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    70
            try {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    71
                @SuppressWarnings("unchecked")
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    72
                Class<ResourceBundle> bundleClass = (Class<ResourceBundle>) c;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    73
                Constructor<ResourceBundle> ctor = bundleClass.getConstructor();
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    74
                if (!Modifier.isPublic(ctor.getModifiers())) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    75
                    return null;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    76
                }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    77
                // java.base may not be able to read the bundleClass's module.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    78
                PrivilegedAction<Void> pa1 = () -> { ctor.setAccessible(true); return null; };
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    79
                AccessController.doPrivileged(pa1);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    80
                try {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    81
                    return ctor.newInstance((Object[]) null);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    82
                } catch (InvocationTargetException e) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    83
                    uncheckedThrow(e);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    84
                } catch (InstantiationException | IllegalAccessException e) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    85
                    throw new InternalError(e);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    86
                }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    87
            } catch (NoSuchMethodException e) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    88
            }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    89
        }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    90
        return null;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    91
    }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    92
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    93
    @SuppressWarnings("unchecked")
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    94
    private static <T extends Throwable> void uncheckedThrow(Throwable t) throws T {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    95
       if (t != null)
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    96
            throw (T)t;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    97
       else
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    98
            throw new Error("Unknown Exception");
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    99
    }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   100
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   101
    /**
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   102
     * Loads properties of the given {@code bundleName} local to the given
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   103
     * {@code module} and returns a {@code ResourceBundle} produced from the
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   104
     * loaded properties.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   105
     *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   106
     * @apiNote This method is intended for internal use.  Need to refactor.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   107
     *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   108
     * @param module     the module from which the properties are loaded
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   109
     * @param bundleName the bundle name of the properties,
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   110
     *                   such as "com.example.app.MyResources_de"
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   111
     * @return the {@code ResourceBundle} produced from the loaded properties,
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   112
     *         or null if no properties are found
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   113
     * @see PropertyResourceBundle
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   114
     */
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   115
    public static ResourceBundle loadPropertyResourceBundle(Module module, String bundleName)
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   116
            throws IOException
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   117
    {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   118
        String resourceName = toResourceName(bundleName, "properties");
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   119
        if (resourceName == null) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   120
            return null;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   121
        }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   122
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   123
        PrivilegedAction<InputStream> pa = () -> {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   124
            try {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   125
                return module.getResourceAsStream(resourceName);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   126
            } catch (IOException e) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   127
                throw new UncheckedIOException(e);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   128
            }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   129
        };
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   130
        try (InputStream stream = AccessController.doPrivileged(pa)) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   131
            if (stream != null) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   132
                return new PropertyResourceBundle(stream);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   133
            } else {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   134
                return null;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   135
            }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   136
        } catch (UncheckedIOException e) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   137
            throw e.getCause();
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   138
        }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   139
    }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   140
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   141
    private static String toResourceName(String bundleName, String suffix) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   142
        if (bundleName.contains("://")) {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   143
            return null;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   144
        }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   145
        StringBuilder sb = new StringBuilder(bundleName.length() + 1 + suffix.length());
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   146
        sb.append(bundleName.replace('.', '/')).append('.').append(suffix);
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   147
        return sb.toString();
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   148
    }
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   149
}