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

/**
 * Interface for creating the various J2EEResource object types.
 *
 * @author Kenneth Saks
 */ 
public interface J2EEResourceFactory {

    /**
     * Load a J2EE Resource Collection from the local
     * j2ee installation.
     * @throws J2EEResourceException 
     */
    J2EEResourceCollection loadDefaultResourceCollection()
        throws J2EEResourceException;

    /**
     * Load a collection of resources from the data store 
     * represented by the given URL.
     * @throws J2EEResourceException 
     */
    J2EEResourceCollection loadResourceCollection(String resourcesURL) 
        throws J2EEResourceException;

    /**
     * Store a resource collection to the local j2ee installation.
     * @throws J2EEResourceException 
     */
    void storeDefaultResourceCollection(J2EEResourceCollection resources)
        throws J2EEResourceException;
    
    /**
     * Store a resource collection to the given URL
     * @throws J2EEResourceException 
     */
    void storeResourceCollection(J2EEResourceCollection resources, 
                                 String resourcesURL) 
        throws J2EEResourceException;

    /**
     * Create a resource of the given type and name.
     */
    J2EEResource createResource(int type, String name);

    /**
     * Create a new resource property.
     */
    ResourceProperty createProperty(String name);

}