src/jsr311-api/src/javax/ws/rs/core/Application.java

/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the "License").  You may not use this file except
 * in compliance with the License.
 * 
 * You can obtain a copy of the license at
 * http://www.opensource.org/licenses/cddl1.php
 * See the License for the specific language governing
 * permissions and limitations under the License.
 */

package javax.ws.rs.core;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

/**
 * Defines the components of a JAX-RS application and supplies additional
 * metadata. A JAX-RS application or implementation supplies a concrete
 * subclass of this abstract class.
 * 
 */
public abstract class Application {
    private static final Set<Object> emptySet = Collections.emptySet();
    private static final Map<String, MediaType> emptyMediaMap = Collections.emptyMap();
    private static final Map<String, String> emptyLanguageMap = Collections.emptyMap();
    
    /**
     * Get a set of root resource and provider classes. The default lifecycle
     * for resource class instances is per-request. The default lifecycle for
     * providers is singleton.
     * 
     * <p>Implementations should warn about and ignore classes that do not 
     * conform to the requirements of root resource or provider classes.
     * Implementations should warn about and ignore classes for which
     * {@link #getSingletons()} returns an instance.</p>
     * 
     * @return a set of root resource and provider classes.
     */
    public abstract Set<Class<?>> getClasses();
    
    /**
     * Get a set of root resource and provider instances. Fields and properties
     * of returned instances are injected with their declared dependencies
     * (see {@link Context}) prior to use.
     * 
     * <p>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.</p>
     * 
     * <p>The default implementation returns an empty set.</p>
     * 
     * @return a set of root resource and provider instances.
     */
    public Set<Object> getSingletons() {
        return emptySet;
    }
    
    /**
     * Get a map of file extension to media type. This is used to drive 
     * URI-based content negotiation such that, e.g.:
     * <pre>GET /resource.atom</pre>
     * <p>is equivalent to:</p>
     * <pre>GET /resource
     *Accept: application/atom+xml</pre>
     * <p>The default implementation returns an empty map.</p>
     * 
     * @return a map of file extension to media type
     */
    public Map<String, MediaType> getMediaTypeMappings() {
        return emptyMediaMap;
    }

    /**
     * Get a map of file extension to language. This is used to drive 
     * URI-based content negotiation such that, e.g.:
     * <pre>GET /resource.english</pre>
     * <p>is equivalent to:</p>
     * <pre>GET /resource
     *Accept-Language: en</pre>
     * <p>The default implementation returns an empty map.</p>
     * 
     * @return a map of file extension to language
     */
    public Map<String, String> getLanguageMappings() {
        return emptyLanguageMap;
    }
}