/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2006, Red Hat Middleware LLC, 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.deployment;

import java.net.URL;

/**
 * The interface which a deployer must implement.
 *
 * <p>Clients should use the MainDeployer to deploy URLs.
 *
 * @jmx:mbean
 *
 * @version <tt>$Revision: 57205 $</tt>
 * @author  <a href="mailto:jason@planet57.com">Jason Dillon</a>
 */
public interface Deployer
{
   /**
    * Deploys a package identified by a URL
    *
    * @param url an <code>URL</code> value
    *
    * @throws DeploymentException    Failed to deploy URL.
    *
    * @jmx:managed-operation
    */
   void deploy(URL url) throws DeploymentException;

   /**
    * Undeploys a package identified by a URL
    *
    * @param url an <code>URL</code> value
    *
    * @throws DeploymentException    Failed to undeploy URL.
    *
    * @jmx:managed-operation
    */
   void undeploy(URL url) throws DeploymentException;

   /**
    * Tells you if a packaged identified by a URL is deployed.
    *
    * @param url an <code>URL</code> value
    * @return a <code>boolean</code> value
    *
    * @jmx:managed-operation
    */
   boolean isDeployed(URL url);
}