AbstractJarFramework.java

/* ====================================================================
 * 
 * The ObjectStyle Group Software License, Version 1.0 
 *
 * Copyright (c) 2004 The ObjectStyle Group 
 * and individual authors of the software.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:  
 *       "This product includes software developed by the 
 *        ObjectStyle Group (http://objectstyle.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "ObjectStyle Group" and "Cayenne" 
 *    must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written 
 *    permission, please contact andrus@objectstyle.org.
 *
 * 5. Products derived from this software may not be called "ObjectStyle"
 *    nor may "ObjectStyle" appear in their names without prior written
 *    permission of the ObjectStyle Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the ObjectStyle Group.  For more
 * information on the ObjectStyle Group, please see
 * <http://objectstyle.org/>.
 *
 */
package org.objectstyle.woenvironment.frameworks;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

import org.objectstyle.woenvironment.plist.SimpleParserDataStructureFactory;
import org.objectstyle.woenvironment.plist.WOLXMLPropertyListSerialization;

public abstract class AbstractJarFramework extends Framework {
	private File jarFile;

	private boolean isValid;

	private Map<String, Object> infoPList;

	public AbstractJarFramework(Root<?> root, File jarFile) {
		super(root, null);
		this.jarFile = jarFile;
		Map<String, Object> infoPList = getInfoPlist();
		if (infoPList != null) {
			setName((String) infoPList.get("NSExecutable"));
			isValid = true;
		}
		else {
			setName("Unknown: " + this.jarFile);
			isValid = false;
		}
	}

	public boolean isValid() {
		return isValid;
	}

	public File getJarFile() {
		return this.jarFile;
	}

	@SuppressWarnings("unchecked")
	public synchronized Map<String, Object> getInfoPlist() {
		if (infoPList == null) {
			try {
				JarFile jarFileObj = new JarFile(jarFile);
				JarEntry infoPListEntry = jarFileObj.getJarEntry("Resources/Info.plist");
				if (infoPListEntry != null) {
					InputStream infoPListStream = jarFileObj.getInputStream(infoPListEntry);
			    	try {
			    		infoPList = (Map<String, Object>) WOLXMLPropertyListSerialization.propertyListWithContentsOfInputStream(infoPListStream, new SimpleParserDataStructureFactory());
			    	}
			    	catch (Throwable t) {
			    		throw new RuntimeException("Failed to parse an XML plist from '" + jarFile.getAbsolutePath() + "'.", t);
					}
					finally {
						infoPListStream.close();
					}
				}
			}
			catch (IOException e) {
				throw new RuntimeException("Failed to load a framework from the jar '" + jarFile.getAbsolutePath() + "'.", e);
			}
		}
		return infoPList;
	}

	public List<FrameworkLibrary> getFrameworkLibraries() {
		List<FrameworkLibrary> libraries = new LinkedList<FrameworkLibrary>();
		libraries.add(new FrameworkLibrary(this.jarFile, null, null, null, null));
		return libraries;
	}

	public IFramework resolveFramework() {
		return this;
	}

	public boolean isResolved() {
		return true;
	}

	@Override
	public String toString() {
		return "[Framework: name = " + getName() + "; jar file = " + getJarFile() + "]";
	}
}