FromURIDeployer.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2009-2010 Oracle and/or its affiliates. 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_1_1.html
 * or packager/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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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.grizzly.http.deployer;

import com.sun.grizzly.http.embed.GrizzlyWebServer;

import java.net.URI;

/**
 * Deployer abstraction supporting deployment from {@link URI} .
 *
 * @author Hubert Iwaniuk
 * @param <V> Type of object deployed by this deployer.
 * @param <T> Type of deployer configuration.
 * @since Sep 18, 2009
 */
public abstract class FromURIDeployer<V extends Deployable, T extends DeploymentConfiguration> extends Deployer<V, T> {

    /**
     * Deploy deployable to gws.
     *
     * @param gws           Grizzly to deploy to.
     * @param deployFrom    URI ofr deployable to be deployed.
     * @param configuration Configuration of deployment.
     * @return Deployment identification.
     * @throws DeployException Error in deployment.
     */
    public final DeploymentID deploy(GrizzlyWebServer gws, URI deployFrom, T configuration)
            throws DeployException {
        return super.deploy(gws, fromURI(deployFrom, configuration), configuration);
    }

    /**
     * Create object to deploy from uri.
     *
     * @param uri           of deployable object.
     * @param configuration Configuration of deployment.
     * @return Deployable object.
     * @throws DeployException If loading Deployable from uri failed.
     */
    protected abstract V fromURI(URI uri, T configuration) throws DeployException;
}