javax.ws.rs.NameBinding Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-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 javax.ws.rs;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Meta-annotation used to create name binding annotations for filters
* and interceptors.
*
* Name binding via annotations is only supported as part of the Server API.
* In name binding, a name-binding annotation is first defined using the
* {@code @NameBinding} meta-annotation:
*
*
* @Target({ ElementType.TYPE, ElementType.METHOD })
* @Retention(value = RetentionPolicy.RUNTIME)
* @NameBinding
* public @interface Logged { }
*
*
* The defined name-binding annotation is then used to decorate a filter or interceptor
* class (more than one filter or interceptor may be decorated with the same name-binding
* annotation):
*
*
* @Logged
* public class LoggingFilter
* implements ContainerRequestFilter, ContainerResponseFilter {
* ...
* }
*
*
* At last, the name-binding annotation is applied to the resource method(s) to which the
* name-bound JAX-RS provider(s) should be bound to:
*
*
* @Path("/")
* public class MyResourceClass {
* @GET
* @Produces("text/plain")
* @Path("{name}")
* @Logged
* public String hello(@PathParam("name") String name) {
* return "Hello " + name;
* }
* }
*
*
* A name-binding annotation may also be attached to a custom JAX-RS
* {@link javax.ws.rs.core.Application} subclass. In such case a name-bound JAX-RS provider
* bound by the annotation will be applied to all {@link HttpMethod resource and sub-resource
* methods} in the JAX-RS application:
*
*
* @Logged
* @ApplicationPath("myApp")
* public class MyApplication extends javax.ws.rs.core.Application {
* ...
* }
*
*
*
* @author Santiago Pericas-Geertsen
* @author Marek Potociar
* @since 2.0
*/
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NameBinding {
}