/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.enterprise.deployment.interfaces;

import com.sun.enterprise.deployment.deploy.shared.AbstractArchive;
import com.sun.enterprise.deployment.RootDeploymentDescriptor;
import com.sun.enterprise.util.zip.ZipItem;

import java.io.IOException;
import java.util.Properties;

/**
 * This interface defines behaviour necessary for creating a appclient container
 * compliant jar file.
 * 
 * @author Jerome Dochez
 */
public interface ClientJarMaker {

	/**
 	* creates the appclient container jar file 
 	* @param descriptor is the loaded module's deployment descriptor
 	* @param source is the abstract archive for the source module deployed
 	* @param target is the abstract archive for the desired appclient container jar file
 	* @param stubs are the stubs generated by the deployment codegen 
 	* @param props is a properties collection to pass implementation parameters
 	* 
 	* @throws IOException when the jar file creation fail
 	*/
	public void create(RootDeploymentDescriptor descriptor, AbstractArchive source, 
			AbstractArchive target, ZipItem[] stubs, Properties props)
		throws IOException; 

        /**
        * creates the appclient container jar file
        * @param descriptor is the loaded module's deployment descriptor
        * @param source is the abstract archive for the source module deployed
        * @param source2 is the abstract archive for the generated xml directory
        * @param target is the abstract archive for the desired appclient container jar file
        * @param stubs are the stubs generated by the deployment codegen
        * @param props is a properties collection to pass implementation parameters
        *
        * @throws IOException when the jar file creation fail
        */
        public void create(RootDeploymentDescriptor descriptor, AbstractArchive source, AbstractArchive source2, AbstractArchive target, ZipItem[] stubs, Properties props)
                throws IOException;

}