org.glassfish.jersey.server.WebServerFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.9

Show newest version

/*
 * Copyright (c) 2021, 2022 Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2018 Markus KARG. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.jersey.server;

import jakarta.ws.rs.ProcessingException;
import jakarta.ws.rs.SeBootstrap;
import jakarta.ws.rs.core.Application;

import org.glassfish.jersey.internal.ServiceFinder;
import org.glassfish.jersey.server.spi.WebServer;
import org.glassfish.jersey.server.spi.WebServerProvider;

/**
 * Factory for creating specific HTTP servers.
 *
 * @author Markus KARG ([email protected])
 * @since 3.1.0
 */
public final class WebServerFactory {

    /**
     * Prevents instantiation.
     */
    private WebServerFactory() {
    }

    /**
     * Creates a server of a given type which runs the given application using the
     * given bootstrap configuration.
     * 
     * The list of service-providers supporting the {@link WebServerProvider}
     * service-provider will be iterated over until one returns a non-null server
     * instance.
     * 

     *
     * @param 
     *            the type of the server.
     * @param type
     *            the type of the server. Providers SHOULD support at least
     *            {@link WebServer}.
     * @param application
     *            The application to host.
     * @param configuration
     *            The configuration (host, port, etc.) to be used for bootstrapping.
     * @return the created server.
     * @throws ProcessingException
     *             if there is an error creating the server.
     * @throws IllegalArgumentException
     *             if no server provider supports the type.
     */
    public static  T createServer(final Class type, final Application application,
                                                       final SeBootstrap.Configuration configuration) {
        for (final WebServerProvider webServerProvider : ServiceFinder.find(WebServerProvider.class)) {
            final T server = webServerProvider.createServer(type, application, configuration);
            if (server != null) {
                return server;
            }
        }

        throw new IllegalArgumentException("No server provider supports the type " + type);
    }

    /**
     * Creates a server of a given type which runs the given application using the
     * given bootstrap configuration.
     * 

     * The list of service-providers supporting the {@link WebServerProvider}
     * service-provider will be iterated over until one returns a non-null server
     * instance.
     * 
     *
     * @param 
     *            the type of the server.
     * @param type
     *            the type of the server. Providers SHOULD support at least
     *            {@link WebServer}.
     * @param application
     *            The application to host.
     * @param configuration
     *            The configuration (host, port, etc.) to be used for bootstrapping.
     * @return the created server.
     * @throws ProcessingException
     *             if there is an error creating the server.
     * @throws IllegalArgumentException
     *             if no server provider supports the type.
     */
    public static  T createServer(final Class type, final Class application,
                                                       final SeBootstrap.Configuration configuration) {
        for (final WebServerProvider webServerProvider : ServiceFinder.find(WebServerProvider.class)) {
            final T server = webServerProvider.createServer(type, application, configuration);
            if (server != null) {
                return server;
            }
        }

        throw new IllegalArgumentException("No server provider supports the type " + type);
    }

}