All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.jersey.spi.container.WebApplication Maven / Gradle / Ivy

Go to download

A bundle containing code of all jar-based modules that provide JAX-RS and Jersey-related features. Such a bundle is *only intended* for developers that do not use Maven's dependency system. The bundle does not include code for contributes, tests and samples.

The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2013 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
 * http://glassfish.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.jersey.spi.container;


import java.io.IOException;

import javax.ws.rs.ext.Providers;

import com.sun.jersey.api.container.ContainerException;
import com.sun.jersey.api.core.HttpContext;
import com.sun.jersey.api.core.ResourceConfig;
import com.sun.jersey.api.core.ResourceContext;
import com.sun.jersey.api.core.Traceable;
import com.sun.jersey.core.spi.component.ioc.IoCComponentProviderFactory;
import com.sun.jersey.core.util.FeaturesAndProperties;
import com.sun.jersey.server.impl.inject.ServerInjectableProviderFactory;
import com.sun.jersey.spi.MessageBodyWorkers;
import com.sun.jersey.spi.monitoring.DispatchingListener;
import com.sun.jersey.spi.monitoring.RequestListener;
import com.sun.jersey.spi.monitoring.ResponseListener;

/**
 * A Web application that manages a set of resource classes.
 * 

* The web application will dispatch HTTP requests to the matching resource * method on the matching resource class. * * @author [email protected] */ public interface WebApplication extends Traceable { /** * * @return true if th web application is initiated, otherwise false. */ boolean isInitiated(); /** * Initiate the Web application. *

* This method can only be called once. Further calls will result in an * exception. * * @param resourceConfig the resource configuration containing the set * of Web resources to be managed by the Web application. * @throws IllegalArgumentException if resourceConfig is null. * @throws ContainerException if a second or further call to the method * is invoked. */ void initiate(ResourceConfig resourceConfig) throws IllegalArgumentException, ContainerException; /** * Initiate the Web application. *

* This method can only be called once. Further calls will result in an * exception. * * @param resourceConfig the resource configuration containing the set * of Web resources to be managed by the Web application. * @param provider the IoC component provider factory to use, if null the default * component provider factory will be used. * @throws IllegalArgumentException if resourceConfig is null. * @throws ContainerException if a second or further call to the method * is invoked. */ void initiate(ResourceConfig resourceConfig, IoCComponentProviderFactory provider) throws IllegalArgumentException, ContainerException; /** * Clone the WebApplication instance. *

* A new WebApplication instance will be created that is initiated with * the {@link ResourceConfig} and {@link IoCComponentProviderFactory} instances * that were used to initiate this WebApplication instance. * * @return the cloned instance. */ WebApplication clone(); /** * Get the features and properties. * * @return the features and properties. */ FeaturesAndProperties getFeaturesAndProperties(); /** * Get the providers. * * @return the providers. * @since 1.3 */ Providers getProviders(); /** * Get the ResourceContext * @return ResourceContext * @since 1.13 */ ResourceContext getResourceContext(); /** * Get the message body workers that can be used for getting * message body readers and writers. * * @return the message body workers. The return value is * undefined before the web application is initialized. */ MessageBodyWorkers getMessageBodyWorkers(); /** * Get the exception mapper context that can be used to map exceptions * to responses. * * @return the exception mapper context. */ ExceptionMapperContext getExceptionMapperContext(); /** * Get an instance of {@link HttpContext} that is a proxy to * a thread local instance of {@link HttpContext}. * * @return the thread local instance of HttpContext. */ HttpContext getThreadLocalHttpContext(); /** * Get the server injectable provider factory. * * @return the server injectable provider factory */ ServerInjectableProviderFactory getServerInjectableProviderFactory(); /** * Get an instance of {@link RequestListener} that should be * used to monitor request processing. * * @return the actual request listener */ RequestListener getRequestListener(); /** * Get an instance of {@link DispatchingListener} that should be * used to monitor request processing. * * @return the actual dispatching listener */ DispatchingListener getDispatchingListener(); /** * Get an instance of {@link ResponseListener} that should be * used to monitor request processing. * * @return the actual response listener */ ResponseListener getResponseListener(); /** * Handle an HTTP request by dispatching the request to the appropriate * matching Web resource that produces the response or otherwise producing * the appropriate HTTP error response. *

* @param request the HTTP container request. * @param responseWriter the HTTP container response writer. * @throws IOException if there is an IO error handling the request. */ void handleRequest(ContainerRequest request, ContainerResponseWriter responseWriter) throws IOException; /** * Handle an HTTP request by dispatching the request to the appropriate * matching Web resource that produces the response or otherwise producing * the appropriate HTTP error response. *

* @param request the HTTP container request. * @param response the HTTP container response. * @throws IOException if there is an IO error handling the request. */ void handleRequest(ContainerRequest request, ContainerResponse response) throws IOException; /** * Destroy the Web application. *

* This method MUST only be called only once. Calls to handlerRequest * MUST not occur while and after this method has been called. */ void destroy(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy