All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.xml.ws.soap.Addressing Maven / Gradle / Ivy

The newest version!
/*
 * 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.soap;

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.WebServiceRef;
import javax.xml.ws.WebServiceProvider;
import javax.xml.ws.soap.AddressingFeature.Responses;
import javax.xml.ws.spi.WebServiceFeatureAnnotation;

/**
 * This annotation represents the use of WS-Addressing with either
 * the SOAP 1.1/HTTP or SOAP 1.2/HTTP binding. Using this annotation
 * with any other binding is undefined.
 * 

* This annotation MUST only be used in conjunction with the * {@code javax.jws.WebService}, {@link WebServiceProvider}, * and {@link WebServiceRef} annotations. * When used with a {@code javax.jws.WebService} annotation, this * annotation MUST only be used on the service endpoint implementation * class. * When used with a {@code WebServiceRef} annotation, this annotation * MUST only be used when a proxy instance is created. The injected SEI * proxy, and endpoint MUST honor the values of the {@code Addressing} * annotation. *

* This annotation's behaviour is defined by the corresponding feature * {@link AddressingFeature}. * * @since 1.6, JAX-WS 2.1 */ @Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) @Documented @WebServiceFeatureAnnotation(id=AddressingFeature.ID,bean=AddressingFeature.class) public @interface Addressing { /** * Specifies if this feature is enabled or disabled. If enabled, it means * the endpoint supports WS-Addressing but does not require its use. * Corresponding * * 3.1.1 Addressing Assertion must be generated in the generated WSDL. * * @return {@code true} if endpoint supports WS-Addressing, {@code false} otherwise */ boolean enabled() default true; /** * If addressing is enabled, this property determines whether the endpoint * requires WS-Addressing. If required is true, the endpoint requires * WS-Addressing and WS-Addressing headers MUST * be present on incoming messages. A corresponding * * 3.1.1 Addressing Assertion must be generated in the WSDL. * * @return {@code true} if endpoint requires WS-Addressing, {@code false} otherwise */ boolean required() default false; /** * If addressing is enabled, this property determines whether endpoint * requires the use of anonymous responses, or non-anonymous responses, * or all. * *

* {@link Responses#ALL} supports all response types and this is the * default value. * *

* {@link Responses#ANONYMOUS} requires the use of only anonymous * responses. It will result into wsam:AnonymousResponses nested assertion * as specified in * * 3.1.2 AnonymousResponses Assertion in the generated WSDL. * *

* {@link Responses#NON_ANONYMOUS} requires the use of only non-anonymous * responses. It will result into * wsam:NonAnonymousResponses nested assertion as specified in * * 3.1.3 NonAnonymousResponses Assertion in the generated WSDL. * * @return supported response types * @since 1.7, JAX-WS 2.2 */ Responses responses() default Responses.ALL; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy