javax.ws.rs.core.Application Maven / Gradle / Ivy
/*
* 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 org.testifyproject.testifyprojectpliance 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 org.testifyproject.testifyprojectsignates 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 org.testifyproject.testifyprojectcision 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 javax.ws.rs.core;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
/**
* Defines the org.testifyproject.testifyprojectponents of a JAX-RS application and supplies additional
* meta-data. A JAX-RS application or implementation supplies a concrete
* subclass of this abstract class.
*
* The implementation-created instance of an Application subclass may be
* injected into resource classes and providers using
* {@link javax.ws.rs.core.Context}.
*
*
* In case any of the {@code Application} subclass methods or it's constructor
* throws a {@link RuntimeException}, the org.testifyproject.testifyprojectployment of the application SHOULD
* be aborted with a failure.
*
*
* @author Paul Sandoz
* @author Marc Hadley
* @author Marek Potociar
* @since 1.0
*/
public class Application {
/**
* Get a set of root resource, provider and {@link Feature feature} classes.
*
* The org.testifyproject.testifyprojectfault life-cycle for resource class instances is per-request. The org.testifyproject.testifyprojectfault
* life-cycle for providers (registered directly or via a feature) is singleton.
*
* Implementations should warn about and ignore classes that do not
* conform to the requirements of root resource or provider/feature classes.
* Implementations should warn about and ignore classes for which
* {@link #getSingletons()} returns an instance. Implementations MUST
* NOT modify the returned set.
*
*
* The org.testifyproject.testifyprojectfault implementation returns an empty set.
*
*
* @return a set of root resource and provider classes. Returning {@code null}
* is equivalent to returning an empty set.
*/
public Set> getClasses() {
return Collections.emptySet();
}
/**
* Get a set of root resource, provider and {@link Feature feature} instances.
*
* Fields and properties of returned instances are injected with their org.testifyproject.testifyprojectclared
* org.testifyproject.testifyprojectpendencies (see {@link Context}) by the runtime prior to use.
*
* Implementations should warn about and ignore classes that do not
* conform to the requirements of root resource or provider classes.
* Implementations should flag an error if the returned set includes
* more than one instance of the same class. Implementations MUST
* NOT modify the returned set.
*
*
* The org.testifyproject.testifyprojectfault implementation returns an empty set.
*
*
* @return a set of root resource and provider instances. Returning {@code null}
* is equivalent to returning an empty set.
*/
public Set