org.apache.pulsar.shade.javax.ws.rs.Produces Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2015 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.apache.pulsar.shade.javax.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 org.apache.pulsar.shade.javax.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 javax.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.
*/
String[] value() default "*/*";
}