/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This 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 software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.as.server.moduleservice;

import org.jboss.as.server.deployment.module.ExtensionInfo;
import org.jboss.modules.ModuleIdentifier;

/**
 * An index of available extensions.
 *
 * @author <a href="mailto:david.lloyd@redhat.com">David M. Lloyd</a>
 */
public interface ExtensionIndex {

    /**
     * Find an extension, returning {@code null} if no matching extension is available.
     *
     * @param name the extension name
     * @param minSpecVersion the minimum spec version to match, or {@code null} to match any
     * @param minImplVersion the minimum implementation version to match, or {@code null} to match any
     * @param requiredVendorId the vendor ID to require, or {@code null} to match any
     * @return the resource root of the first matched extension
     */
    ModuleIdentifier findExtension(String name, String minSpecVersion, String minImplVersion, String requiredVendorId);

    /**
     * Adds an extension that has been deployed to the server
     *
     * @param identifier The module identifier of the extension
     * @param extensionInfo The extension data
     */
    void addDeployedExtension(ModuleIdentifier identifier, ExtensionInfo extensionInfo);

    /**
     * Removes extension information that has been deployed to the server
     *
     * @param name The extension name
     * @param identifier The extension Identifier
     * @return true if the extension was found and removed
     */
    boolean removeDeployedExtension(String name, ModuleIdentifier identifier);
}
