org.glassfish.jersey.server.mvc.Template Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-mvc Show documentation
Jersey extension module providing support for MVC.
There is a newer version: 4.0.0-M1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 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 org.glassfish.jersey.server.mvc;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Used to annotate JAX-RS resources and resource methods to provide reference to a template for MVC support.
 * 
 * In case a resource class is annotated with {@link Template} annotation then an instance of this class is considered to be
 * the model. Producible {@link javax.ws.rs.core.MediaType media types} are determined from the resource classes
 * {@link javax.ws.rs.Produces} annotation.
 * 

 * In case a resource method is annotated with {@link Template} annotation then the return value of the method is the model.
 * Otherwise the processing of such a method is the same as if the  return type of the method was {@link Viewable} class.
 * If a method is annotated with {@link Template} and also returning a {@link Viewable} instance then the values
 * (resolvingClass) from the {@link Viewable viewable} take precedence over those defined by the annotation.
 * Producible {@link javax.ws.rs.core.MediaType media types} are determined from the method's {@link javax.ws.rs.Produces}
 * annotation.
 * 

 * To see how templates are being resolved, see {@link Viewable viewable}.
 *
 * @author Michal Gajdos (michal.gajdos at oracle.com)
 * @see Viewable
 */
@Inherited
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Template {

    /**
     * The template name that should be used to output the entity. The template name may be declared as absolute template name
     * if the name begins with a '/', otherwise the template name is declared as a relative template name.
     */
    String name() default "";

    /**
     * The class to be used to resolve the template name if the template name is not absolute.
     * If the value is {@code Object.class} then the resolving class will be obtained from the last matched resource.
     * 
     * Defaults to {@link Object}.
     *
     * @deprecated This attribute is obsolete and will be removed in the future releases. There is no replacement.
     */
    @Deprecated
    Class resolvingClass() default Object.class;
}