javax.xml.ws.spi.WebServiceFeatureAnnotation Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2017 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
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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.xml.ws.spi;
import java.lang.annotation.Documented;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import javax.xml.ws.WebServiceFeature;
import javax.xml.ws.WebServiceRef;
import javax.xml.ws.RespectBinding;
import javax.xml.ws.soap.Addressing;
import javax.xml.ws.soap.MTOM;
/**
* Annotation used to identify other annotations
* as a {@code WebServiceFeature}.
*
* Each {@code WebServiceFeature} annotation annotated with
* this annotation MUST contain an
* {@code enabled} property of type
* {@code boolean} with a default value of {@code true}.
*
* JAX-WS defines the following
* {@code WebServiceFeature} annotations ({@code Addressing},
* {@code MTOM}, {@code RespectBinding}), however, an implementation
* may define vendors specific annotations for other features.
*
* Annotations annotated with {@code WebServiceFeatureAnnotation} MUST
* have the same @Target of {@link WebServiceRef} annotation, so that the resulting
* feature annotation can be used in conjunction with the {@link WebServiceRef}
* annotation if necessary.
*
* If a JAX-WS implementation encounters an annotation annotated
* with the {@code WebServiceFeatureAnnotation} that it does not
* recognize/support an error MUST be given.
*
* @see Addressing
* @see MTOM
* @see RespectBinding
*
* @since 1.6, JAX-WS 2.1
*/
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebServiceFeatureAnnotation {
/**
* Unique identifier for the WebServiceFeature. This
* identifier MUST be unique across all implementations
* of JAX-WS.
* @return unique identifier for the WebServiceFeature
*/
String id();
/**
* The {@code WebServiceFeature} bean that is associated
* with the {@code WebServiceFeature} annotation
* @return the {@code WebServiceFeature} bean
*/
Class bean();
}