jakarta.ws.rs.Produces 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) 2010, 2019 Oracle and/or its affiliates. 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 jakarta.ws.rs;

import java.lang.annotation.Documented;
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;

/**
 * Defines the media type(s) that the methods of a resource class or {@link jakarta.ws.rs.ext.MessageBodyWriter} can
 * produce. If not specified then a container will assume that any type can be produced. Method level annotations
 * override a class level annotation. A container is responsible for ensuring that the method invoked is capable of
 * producing one of the media types requested in the HTTP request. If no such method is available the container must
 * respond with a HTTP "406 Not Acceptable" as specified by RFC 2616.
 *
 * 
 * A method for which there is a single-valued {@code @Produces} is not required to set the media type of
 * representations that it produces: the container will use the value of the {@code @Produces} when sending a response.
 * 
 *
 * @author Paul Sandoz
 * @author Marc Hadley
 * @see jakarta.ws.rs.ext.MessageBodyWriter
 * @since 1.0
 */
@Inherited
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Produces {

    /**
     * A list of media types. Each entry may specify a single type or consist of a comma separated list of types, with any
     * leading or trailing white-spaces in a single type entry being ignored. For example:
     *
     *      * { "image/jpeg, image/gif ", " image/png" }
     * 
     *
     * Use of the comma-separated form allows definition of a common string constant for use on multiple targets.
     *
     * @return media types to accept.
     */
    String[] value() default "*/*";
}