/*
 * 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.
 */

/*
 * ConfigEnvironment.java
 *
 * Created on January 9, 2004, 11:41 AM
 */

package com.sun.enterprise.config.pluggable;

/**
 * ConfigEnvironment is used by ConfigFactory to 
 * create a configContext. 
 *
 * @author  sridatta
 */
public interface ConfigEnvironment {
    
    /**
     * get the root class for this execution
     * cannot be null.
     */
    String getRootClass();
    void setRootClass(String rootClass);
    
    String getUrl();
    void setUrl(String url);
    
    /**
     * Get the handler required for this execution
     * can return null.
     */
    String getHandler();
    void setHandler(String handler);
    
    /**
     * interceptor for the configbean
     * can return null
     */
    ConfigBeanInterceptor getConfigBeanInterceptor();
    void setConfigBeanInterceptor(ConfigBeanInterceptor cbInterceptor);
    
    
    boolean isReadOnly();
    void setReadOnly(boolean readOnly);
    
    boolean isAutoCommitOn();
    void setAutoCommitOn(boolean value);
    
    
    //ConfigFactoryEnvironment:
    
    /**
     * only used by ConfigFactory to decide whether
     * to cache the ConfigContext or not.
     */
    boolean isCachingEnabled();        
    void setCachingEnabled(boolean value);
    
    
    //ConfigBeanEnvironment
    
    /**
     * gets ConfigBeansSettings for this execution
     */
    ConfigBeansSettings getConfigBeansSettings();
    
}