com.sun.xml.ws.developer.MemberSubmissionAddressing Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-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 com.sun.xml.ws.developer;
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.spi.WebServiceFeatureAnnotation;
/**
* This feature represents the use of WS-Addressing with either
* the SOAP 1.1/HTTP or SOAP 1.2/HTTP binding. Using this feature
* with any other binding is NOT required.
*
* Enabling this feature will result in the
* wsaw:UsingAddressing element being added to the
* wsdl:Binding for
* the endpoint and in the runtime being capable of responding to
* WS-Addressing headers.
*
* The following describes the affects of this feature with respect
* to be enabled or disabled:
*
* - ENABLED: In this Mode, Addressing will be enabled.
* If there is not a WSDL associated with the Endpoint and
* a WSDL is to be generated, it MUST be generated with the
* wsaw:UsingAddressing element. At runtime, Addressing headers
* MUST be consumed by the receiver and generated by the
* sender even if the WSDL declares otherwise. The
* mustUnderstand="0" attribute MUST be used on the Addressing
* headers.
*
- DISABLED: In this Mode, Addressing will be disabled
* even if an associated WSDL specifies otherwise. At runtime,
* Addressing headers MUST NOT be used.
*
*
* The {@link #required} property can be used to
* specify if the required attribute on the
* wsaw:UsingAddressing element should
* be true or false. By default the
* wsdl:required parameter is false.
*
* See WS-Addressing
* for more information on WS-Addressing.
* See WS-Addressing - WSDL 1.0
* for more information on wsaw:UsingAddressing.
*
* @since JAX-WS 2.1
*/
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@WebServiceFeatureAnnotation(id= MemberSubmissionAddressingFeature.ID,bean=MemberSubmissionAddressingFeature.class)
public @interface MemberSubmissionAddressing {
/**
* Specifies if this feature is enabled or disabled.
*/
boolean enabled() default true;
/**
* Property to determine the value of the
* wsdl:required attribute on
* wsaw:UsingAddressing element in the WSDL.
*/
boolean required() default false;
/**
* Property to determine if the incoming messsages should be checked for conformance
* with MemberSubmission version of WS-Addressing.
*
* If Validation.LAX, then some WS-Adressing headers are not strictly checked.
*/
public enum Validation { LAX, STRICT }
Validation validation() default Validation.LAX;
}