/*
 *                 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-2001 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.api.mdr;

import org.openide.util.Lookup;

/** Entry point to the metadata repositories.
 * Use {@link #getDefault} method to obtain the default instance.
 * @author Martin Matula
 * @version 0.1
 */
public abstract class MDRManager {
    /** Returns the default metadata repository.
     * @return default metadata repository or null if there is no default metadata repository.
     */
    public abstract MDRepository getDefaultRepository();

    /** Returns metadata repository of a given name.
     * @param name name of metadata repository
     * @return metadata repository of a given name or null if the repository of the given name does not exist.
     */
    public abstract MDRepository getRepository(String name);

    /** Returns list of names of all available metadata repositories.
     * @return list of names of all available metadata repositories
     */
    public abstract String[] getRepositoryNames();
    
    /** Should be called at the end of the MDR session. Does all the needed clean-up
     * by calling {@link MDRepository#shutdown} method on each of the repositories.
     */
    public void shutdownAll() {
        String names[] = getRepositoryNames();
        for (int i = 0; i < names.length; i++) {
            getRepository(names[i]).shutdown();
        }
    }

    /** Returns the default instance of MDRManager.
     * @return Default MDR manager.
     */    
    public static MDRManager getDefault() {
        return (MDRManager) Lookup.getDefault().lookup(MDRManager.class);
    }
}