base/model/AMResourceBundleCache.java

/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: AMResourceBundleCache.java,v 1.2 2008/06/25 05:42:50 qcheng Exp $
 *
 */

package com.sun.identity.console.base.model;

import com.sun.identity.shared.debug.Debug;
import com.iplanet.sso.SSOToken;
import com.iplanet.sso.SSOException;
import com.sun.identity.common.ISResourceBundle;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.ResourceBundle;

/* - NEED NOT LOG - */

/**
 * A singleton class that cache resource bundle object
 */
public class AMResourceBundleCache {
    private static AMResourceBundleCache instance = new AMResourceBundleCache();
    private Map mapBundles = new HashMap(30);
    private Debug debug = null;

    private AMResourceBundleCache() {
        debug = Debug.getInstance(AMAdminConstants.AMSDK_DEBUG_FILENAME);
    }

    /**
     * Gets instance of <code>AMResourceBundleCache</code>
     *
     * @return  instance of <code>AMResourceBundleCache</code>
     */
    public static AMResourceBundleCache getInstance() {
        return instance;
    }

    /**
     * Gets resource bundle from cache
     *
     * @param name of bundle
     * @param locale of bundle
     * @return resource bundle
     */
    public ResourceBundle getResBundle(String name, Locale locale) {
        ResourceBundle resBundle = null;
        Map map = (Map) mapBundles.get(name);

        if (map != null){
            resBundle = (ResourceBundle)map.get(locale);
        }

        if (resBundle == null)  {
            try {
                resBundle = ResourceBundle.getBundle(name, locale);
            } catch (MissingResourceException mre) {
                resBundle = getResourceFromDS(name, locale);
            }

            synchronized(mapBundles) {
                if (map == null) {
                    map = new HashMap(5);
                    mapBundles.put(name, map);
                }
                map.put(locale, resBundle);
            }
        }

        return resBundle;
    }

    private ResourceBundle getResourceFromDS(String name, Locale locale) {
        ResourceBundle resBundle = null;

        try {
            SSOToken adminToken = (SSOToken)AccessController.doPrivileged(
                new PrivilegedAction() {
                    public Object run() {
                        try {
                            return AMAdminUtils.getSuperAdminSSOToken();
                        } catch (SecurityException e) {
                            debug.error(
                                "AMResourceBundleCache.getResBundle", e);
                            return null;
                        }
                    }
                });

            if (adminToken != null) {
                resBundle = ISResourceBundle.getResourceBundle(adminToken, name,
                    locale);
            }
        } catch (SSOException ssoe) {
            debug.error("AMResourceBundleCache.getResourceFromDS", ssoe);
        } catch (MissingResourceException mre) {
            debug.error("AMResourceBundleCache.getResourceFromDS", mre);
        }

        return resBundle;
    }

    /** clears all resource bundle objects */
    public void clear() {
        synchronized(mapBundles) {
            mapBundles.clear();
        }
    }
}