/*
 * Copyright (C) 2001-2004 Red Hat Inc. All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

package com.arsdigita.subsite;

import com.arsdigita.web.Application;
import com.arsdigita.persistence.OID;
import com.arsdigita.persistence.DataObject;
import com.arsdigita.domain.DataObjectNotFoundException;

import org.apache.log4j.Logger;

/**
 * Base class of the subsite application.
 * 
 */
public class Subsite extends Application {
    
    /** A logger instance to assist debugging.  */
    private static final Logger s_log = Logger.getLogger(Subsite.class);

    // pdl stuff (constants)
    public static final String BASE_DATA_OBJECT_TYPE 
                                              = "com.arsdigita.subsite.Subsite";
    
    public static final String SUBSITE_XML_NS = "http://ccm.redhat.com/subsite/1.0";
    
    public static final String SUBSITE_XML_PREFIX = "subsite:";

   /** Config object containing various parameter    */
    private static final SubsiteConfig s_config = SubsiteConfig.getConfig();
        
    private static final SubsiteContext s_context = new SubsiteContext();
    
    /**
     * Get the context record of the current thread.
     *
     * @post return != null
     */
    public static SubsiteContext getContext() {
        return s_context;
    }    

    /** Service method to provide clients access to configuration.            */
    public static SubsiteConfig getConfig() {
        return s_config;
    }


    
    /**
     * 
     * @param obj 
     */
    public Subsite(DataObject obj) {
        super(obj);
    }

    /**
     * Constructor retrieving subsite from the database usings its OID.
     *
     * @param oid the OID of the subsite
     * @throws DataObjectNotFoundException 
     */
    public Subsite(OID oid) 
        throws DataObjectNotFoundException {

        super(oid);
    }    

    //  /*
    //   * Application specific method only required if installed in its own
    //   * web application context
    //   */
    //  public String getContextPath() {
    //      return "/ccm-ldn-subsite";
    //  }

    /**
     * Returns the path name of the location of the applications servlet/JSP.
     *
     * The method overwrites the super class to provide an application specific
     * location for servlets/JSP. This is necessary if you whish to install the
     * module (application) along with others in one context. If you install the
     * module into its own context (no longer recommended for versions newer
     * than 1.0.4) you may use a standard location.
     *
     * Usually it is a symbolic name/path, which will be mapped in the web.xml
     * to the real location in the file system. Example:
     * <servlet>
     *   <servlet-name>subsite-files</servlet-name>
     *   <servlet-class>com.arsdigita.web.ApplicationFileServlet</servlet-class>
     *   <init-param>
     *     <param-name>template-path</param-name>
     *     <param-value>/templates/ccm-subsite</param-value>
     *   </init-param>
     * </servlet>
     *
     * <servlet-mapping>
     *   <servlet-name>subsite-files</servlet-name>
     *   <url-pattern>/ccm-subsite/files/*</url-pattern>
     * </servlet-mapping>
     *
     * @return path name to the applications servlet/JSP
     */
    @Override
    public String getServletPath() {
        // return "/files";
        return "/ccm-subsite/files";
    }

}