1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.xml.ws.soap;
// $Id: AddressingFeature.java 2897 2007-04-23 06:12:12Z thomas.diesler@jboss.com $
import javax.xml.ws.WebServiceFeature;
/**
* 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.
* <p>
* Enabling this feature on the server will result in the
* <code>wsaw:UsingAddressing</code> element being added to the
* <code>wsdl:Binding</code> for
* the endpoint and in the runtime being capable of responding to
* WS-Addressing headers.
* <p>
* Enabling this feature on the client will cause the JAX-WS runtime
* to include WS-Addressing headers in SOAP messages.
* <p>
* If the web service developer has not explicitly enabled this feature,
* it may be automatically enabled if the associated WSDL enables
* WS-Addressing via the <code>wsaw:UsingAddressing</code> element with
* the <code>wsdl:required</code> attribute set to <code>true</code>.
* <br>
* See {@link javax.xml.ws.RespectBindingFeature} for more information
* on required WSDL extensions.
* <p>
* The following describes the affects of this feature with respect
* to be enabled or disabled:
* <ul>
* <li> 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.
* <li> DISABLED: In this Mode, Addressing will be disabled
* even if an associated WSDL specifies otherwise. At runtime,
* Addressing headers MUST NOT be used.
* </ul>
* <p>
* The {@link #required} property can be used to
* specify if the <code>required</code> attribute on the
* <code>wsaw:UsingAddressing</code> element should
* be <code>true</code> or <code>false</code>. By default the
* <code>wsdl:required</code> parameter is <code>false</code>.
*
* See <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509/">WS-Addressing</a>
* for more information on WS-Addressing.
* See <a href="http://www.w3.org/TR/2006/CR-ws-addr-wsdl-20060529/">WS-Addressing - WSDL 1.0
* </a> for more information on <code>wsaw:UsingAddressing</code>.
*
* @since JAX-WS 2.1
*/
public final class AddressingFeature extends WebServiceFeature {
/**
* Constant value identifying the AddressingFeature
*/
public static final String ID = "http://www.w3.org/2005/08/addressing/module";
/**
* Property for <code>required</code> feature parameter. When Addressing
* is enabled, the value of this property will be set to the
* <code>wsdl:required</code> attribute on
* <code>wsaw:UsingAddressing</code> element in the WSDL.
*/
protected boolean required = false;
/**
* Create an <code>AddressingFeature</code>.
* The instance created will be enabled.
*/
public AddressingFeature() {
this.enabled = true;
}
/**
* Create an <code>AddressingFeature</code>
*
* @param enabled specifies whether this feature should
* be enabled or not.
*/
public AddressingFeature(boolean enabled) {
this.enabled = enabled;
}
/**
* Create an <code>AddressingFeature</code>
*
* @param enabled specifies whether this feature should
* be enabled or not.
* @param required specifies the value that will be used
* for the <code>wsdl:required</code> attribute on the
* <code>wsaw:UsingAddressing</code> element.
*/
public AddressingFeature(boolean enabled, boolean required) {
this.enabled = enabled;
this.required = required;
}
/**
* {@inheritDoc}
*/
public String getID() {
return ID;
}
/**
* Gets the boolean value used to set the
* <code>wsdl:required</code> attribute on
* <code>wsaw:UsingAddressing</code> element
* in the WSDL.
*
* @return the current required value
*/
public boolean isRequired() {
return required;
}
}
|
