WOFramework.java

/* ====================================================================
 *
 * The ObjectStyle Group Software License, Version 1.0
 *
 * Copyright (c) 2002, 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.woproject.ant;

import java.io.File;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.types.FileSet;

/**
 * Ant task to build WebObjects framework. For detailed instructions go to the
 * <a href="../../../../../ant/woframework.html">manual page</a> .
 *
 * @ant.task category="packaging"
 */
public class WOFramework extends WOTask {

	protected String eoAdaptorClassName;

	@Override
	public void addLib(FileSet set) {
		lib.addElement(set);
	}

	@Override
	public void execute() throws BuildException {
		validateAttributes();

		log("Installing " + name + " in " + destDir);
		createDirectories();

		if (hasClasses()) {
			jarClasses();
		}

		if (hasSources()) {
			jarSources();
		}

		if (hasLib()) {
			copyLibs();
		}

		if (hasResources()) {
			copyResources();
		}

		if (hasWs()) {
			copyWsresources();
		}

		new FrameworkFormat(this).processTemplates();
	}

	/**
	 * location where WOTask is being built up: ie the .woa dir or the
	 * .framework dir. In this case, the .framework dir.
	 */
	@Override
	protected File taskDir() {
		return getProject().resolveFile(destDir + File.separator + name + ".framework");
	}

	@Override
	protected File resourcesDir() {
		return new File(taskDir(), "Resources");
	}

	@Override
	protected File wsresourcesDir() {
		return new File(taskDir(), "WebServerResources");
	}

	@Override
	protected File wsresourcesDestDir() {
		File woLocation = new File(webServerDir(), "WebObjects");
		File frameworksLocation = new File(woLocation, "Frameworks");
		File frameworkLocation = new File(frameworksLocation, name + ".framework");
		return new File(frameworkLocation, "WebServerResources");
	}

	/**
	 * Do any clean up necessary to allow this instance to be used again.
	 */
	protected void cleanUp() {
		classes.clear();
		lib.clear();
		resources.clear();
		wsresources.clear();
		sources.clear();
	}

	public String getEOAdaptorClassName() {
		return eoAdaptorClassName;
	}

	public void setEOAdaptorClassName(String eoAdaptorClassName) {
		this.eoAdaptorClassName = eoAdaptorClassName;
	}
	
	@Override
	public String getCustomInfoPListContent() {
		if (eoAdaptorClassName == null || eoAdaptorClassName.trim().equals("")) {
			return super.getCustomInfoPListContent();
		}
		
		StringBuilder sb = new StringBuilder();
		sb.append("<key>EOAdaptorClassName</key><string>").append(eoAdaptorClassName).append("</string>\n");
		sb.append(super.getCustomInfoPListContent());
		return sb.toString();
	}
}