159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2012 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.asset; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.ArrayList; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.HashMap; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.Iterator; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.logging.Level; 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.logging.Logger; 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>ImplHandler</code> manages the asset loader and asset locator 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * implementations in a thread safe way. This allows implementations 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * which store local persistent data to operate with a multi-threaded system. 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * This is done by keeping an instance of each asset loader and asset 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * locator object in a thread local. 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class ImplHandler { 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private static final Logger logger = Logger.getLogger(ImplHandler.class.getName()); 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private final AssetManager owner; 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private final ThreadLocal<AssetKey> parentAssetKey 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta = new ThreadLocal<AssetKey>(); 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private final ArrayList<ImplThreadLocal> genericLocators = 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta new ArrayList<ImplThreadLocal>(); 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private final HashMap<String, ImplThreadLocal> loaders = 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta new HashMap<String, ImplThreadLocal>(); 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public ImplHandler(AssetManager owner){ 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.owner = owner; 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected class ImplThreadLocal extends ThreadLocal { 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private final Class<?> type; 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private final String path; 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public ImplThreadLocal(Class<?> type){ 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.type = type; 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta path = null; 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public ImplThreadLocal(Class<?> type, String path){ 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.type = type; 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.path = path; 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public String getPath() { 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return path; 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Class<?> getTypeClass(){ 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return type; 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected Object initialValue(){ 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta try { 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return type.newInstance(); 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } catch (InstantiationException ex) { 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta logger.log(Level.SEVERE,"Cannot create locator of type {0}, does" 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta + " the class have an empty and publically accessible"+ 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta " constructor?", type.getName()); 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta logger.throwing(type.getName(), "<init>", ex); 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } catch (IllegalAccessException ex) { 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta logger.log(Level.SEVERE,"Cannot create locator of type {0}, " 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta + "does the class have an empty and publically " 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta + "accessible constructor?", type.getName()); 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta logger.throwing(type.getName(), "<init>", ex); 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return null; 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Establishes the asset key that is used for tracking dependent assets 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * that have failed to load. When set, the {@link DesktopAssetManager} 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * gets a hint that it should suppress {@link AssetNotFoundException}s 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * and instead call the listener callback (if set). 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param parentKey The parent key 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void establishParentKey(AssetKey parentKey){ 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (parentAssetKey.get() == null){ 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta parentAssetKey.set(parentKey); 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void releaseParentKey(AssetKey parentKey){ 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (parentAssetKey.get() == parentKey){ 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta parentAssetKey.set(null); 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public AssetKey getParentKey(){ 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return parentAssetKey.get(); 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Attempts to locate the given resource name. 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param key The full name of the resource. 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return The AssetInfo containing resource information required for 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * access, or null if not found. 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public AssetInfo tryLocate(AssetKey key){ 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta synchronized (genericLocators){ 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (genericLocators.isEmpty()) 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return null; 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta for (ImplThreadLocal local : genericLocators){ 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta AssetLocator locator = (AssetLocator) local.get(); 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (local.getPath() != null){ 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta locator.setRootPath((String) local.getPath()); 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta AssetInfo info = locator.locate(owner, key); 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (info != null) 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return info; 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return null; 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int getLocatorCount(){ 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta synchronized (genericLocators){ 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return genericLocators.size(); 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns the AssetLoader registered for the given extension 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * of the current thread. 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return AssetLoader registered with addLoader. 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public AssetLoader aquireLoader(AssetKey key){ 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta synchronized (loaders){ 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta ImplThreadLocal local = loaders.get(key.getExtension()); 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (local != null){ 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta AssetLoader loader = (AssetLoader) local.get(); 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return loader; 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return null; 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void addLoader(final Class<?> loaderType, String ... extensions){ 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta ImplThreadLocal local = new ImplThreadLocal(loaderType); 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta for (String extension : extensions){ 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta extension = extension.toLowerCase(); 18359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta synchronized (loaders){ 18459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta loaders.put(extension, local); 18559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void addLocator(final Class<?> locatorType, String rootPath){ 19059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta ImplThreadLocal local = new ImplThreadLocal(locatorType, rootPath); 19159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta synchronized (genericLocators){ 19259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta genericLocators.add(local); 19359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void removeLocator(final Class<?> locatorType, String rootPath){ 19759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta synchronized (genericLocators){ 19859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Iterator<ImplThreadLocal> it = genericLocators.iterator(); 19959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta while (it.hasNext()){ 20059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta ImplThreadLocal locator = it.next(); 20159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (locator.getPath().equals(rootPath) && 20259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta locator.getTypeClass().equals(locatorType)){ 20359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta it.remove(); 20459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 20959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 210