trunk/pluto-util/src/main/java/org/apache/pluto/util/assemble/Assembler.java

/*
 * Copyright 2004 The Apache Software Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.pluto.util.assemble;

import org.apache.pluto.util.UtilityException;

/**
 * The pluto assembler is used to assemble a portlet application which is
 * deployable to pluto.
 *
 * @author <a href="mailto:ddewolf@apache.org">David H. DeWolf</a>
 * @version 1.0
 * @since Oct 15, 2004
 */
public interface Assembler {

    public static final String PORTLET_XML = "WEB-INF/portlet.xml";

    public static final String SERVLET_XML = "WEB-INF/web.xml";
    
    public static final String DISPATCH_SERVLET_CLASS =
        	"org.apache.pluto.core.PortletServlet";

    /**
     * Assemble a web applicaiton into a portlet web application which is
     * deployable into the pluto-1.1 portlet container. The specified web
     * application will be overwritten with the new application.
     */
    public void assemble(AssemblerConfig config) throws UtilityException;

}