/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2004 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.modules.web.spi.webmodule;

import org.openide.filesystems.FileObject;

/**
 * SPI interface for {@link org.netbeans.modules.web.api.webmodule.WebModule}.
 * @see WebModuleFactory
 */
public interface WebModuleImplementation {

    /** Folder that contains sources of the static documents for 
     * the web module (html, JSPs, etc.).
     */
    FileObject getDocumentBase ();
    
    /** Context path of the web module.
     */
    String getContextPath ();
    
    /** J2EE platform version - one of the constants 
     * {@link org.netbeans.modules.web.api.webmodule.WebModule#J2EE_13_LEVEL}, 
     * {@link org.netbeans.modules.web.api.webmodule.WebModule#J2EE_14_LEVEL}.
     * @return J2EE platform version
     */
    String getJ2eePlatformVersion ();
    
    /** WEB-INF folder for the web module.
     * 

     * The WEB-INF folder would typically be a child of the folder returned 
     * by {@link #getDocumentBase} but does not need to be.
     * 
     */
    FileObject getWebInf ();

    /** Deployment descriptor (web.xml file) of the web module.
     * 

     * The web.xml file would typically be a child of the folder returned 
     * by {@link #getWebInf} but does not need to be.
     * 
     */
    FileObject getDeploymentDescriptor ();
}