1 /*
2 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.xml.internal.ws.addressing;
27
28 import com.sun.istack.internal.Nullable;
29 import com.sun.istack.internal.NotNull;
30 import com.sun.xml.internal.stream.buffer.XMLStreamBufferSource;
31 import com.sun.xml.internal.stream.buffer.stax.StreamWriterBufferCreator;
32 import com.sun.xml.internal.ws.api.addressing.AddressingVersion;
33 import com.sun.xml.internal.ws.developer.MemberSubmissionEndpointReference;
34 import com.sun.xml.internal.ws.util.DOMUtil;
35 import com.sun.xml.internal.ws.util.xml.XmlUtil;
36 import com.sun.xml.internal.ws.wsdl.parser.WSDLConstants;
37 import com.sun.xml.internal.ws.addressing.v200408.MemberSubmissionAddressingConstants;
38 import org.w3c.dom.*;
39
40 import javax.xml.namespace.QName;
41 import javax.xml.stream.XMLStreamException;
42 import javax.xml.transform.dom.DOMResult;
43 import javax.xml.ws.EndpointReference;
44 import javax.xml.ws.WebServiceException;
45 import javax.xml.ws.wsaddressing.W3CEndpointReference;
46 import java.util.ArrayList;
47 import java.util.HashMap;
48 import java.util.Map;
49
50 /**
51 * @author Rama Pulavarthi
52 */
53
54 public class EndpointReferenceUtil {
55 /**
56 * Gives the EPR based on the clazz. It may need to perform tranformation from
57 * W3C EPR to MS EPR or vise-versa.
58 */
59 public static <T extends EndpointReference> T transform(Class<T> clazz, @NotNull EndpointReference epr) {
60 assert epr != null;
61 if (clazz.isAssignableFrom(W3CEndpointReference.class)) {
62 if (epr instanceof W3CEndpointReference) {
63 return (T) epr;
64 } else if (epr instanceof MemberSubmissionEndpointReference) {
65 return (T) toW3CEpr((MemberSubmissionEndpointReference) epr);
66 }
67 } else if (clazz.isAssignableFrom(MemberSubmissionEndpointReference.class)) {
68 if (epr instanceof W3CEndpointReference) {
69 return (T) toMSEpr((W3CEndpointReference) epr);
70 } else if (epr instanceof MemberSubmissionEndpointReference) {
71 return (T) epr;
72 }
73 }
74
75 //This must be an EPR that we dont know
76 throw new WebServiceException("Unknwon EndpointReference: " + epr.getClass());
77 }
78
79 //TODO: bit of redundency on writes of w3c epr, should modularize it
80 private static W3CEndpointReference toW3CEpr(MemberSubmissionEndpointReference msEpr) {
81 StreamWriterBufferCreator writer = new StreamWriterBufferCreator();
82 w3cMetadataWritten = false;
83 try {
84 writer.writeStartDocument();
85 writer.writeStartElement(AddressingVersion.W3C.getPrefix(),
86 "EndpointReference", AddressingVersion.W3C.nsUri);
87 writer.writeNamespace(AddressingVersion.W3C.getPrefix(),
88 AddressingVersion.W3C.nsUri);
89 //write wsa:Address
90 writer.writeStartElement(AddressingVersion.W3C.getPrefix(),
91 AddressingVersion.W3C.eprType.address
92 , AddressingVersion.W3C.nsUri);
93 writer.writeCharacters(msEpr.addr.uri);
94 writer.writeEndElement();
95 //TODO: write extension attributes on wsa:Address
96 if ((msEpr.referenceProperties != null && msEpr.referenceProperties.elements.size() > 0) ||
97 (msEpr.referenceParameters != null && msEpr.referenceParameters.elements.size() > 0)) {
98
99 writer.writeStartElement(AddressingVersion.W3C.getPrefix(), "ReferenceParameters", AddressingVersion.W3C.nsUri);
100
101 //write ReferenceProperties
102 if (msEpr.referenceProperties != null) {
103 for (Element e : msEpr.referenceProperties.elements) {
104 DOMUtil.serializeNode(e, writer);
105 }
106 }
107 //write referenceParameters
108 if (msEpr.referenceParameters != null) {
109 for (Element e : msEpr.referenceParameters.elements) {
110 DOMUtil.serializeNode(e, writer);
111 }
112 }
113 writer.writeEndElement();
114 }
115 // Supress writing ServiceName and EndpointName in W3CEPR,
116 // Until the ns for those metadata elements is resolved.
117 /*
118 //Write Interface info
119 if (msEpr.portTypeName != null) {
120 writeW3CMetadata(writer);
121 writer.writeStartElement(AddressingVersion.W3C.getWsdlPrefix(),
122 AddressingVersion.W3C.eprType.portTypeName ,
123 AddressingVersion.W3C.wsdlNsUri);
124 writer.writeNamespace(AddressingVersion.W3C.getWsdlPrefix(),
125 AddressingVersion.W3C.wsdlNsUri);
126 String portTypePrefix = fixNull(msEpr.portTypeName.name.getPrefix());
127 writer.writeNamespace(portTypePrefix, msEpr.portTypeName.name.getNamespaceURI());
128 if (portTypePrefix.equals(""))
129 writer.writeCharacters(msEpr.portTypeName.name.getLocalPart());
130 else
131 writer.writeCharacters(portTypePrefix + ":" + msEpr.portTypeName.name.getLocalPart());
132 writer.writeEndElement();
133 }
134 if (msEpr.serviceName != null) {
135 writeW3CMetadata(writer);
136 //Write service and Port info
137 writer.writeStartElement(AddressingVersion.W3C.getWsdlPrefix(),
138 AddressingVersion.W3C.eprType.serviceName ,
139 AddressingVersion.W3C.wsdlNsUri);
140 writer.writeNamespace(AddressingVersion.W3C.getWsdlPrefix(),
141 AddressingVersion.W3C.wsdlNsUri);
142
143 String servicePrefix = fixNull(msEpr.serviceName.name.getPrefix());
144 if (msEpr.serviceName.portName != null)
145 writer.writeAttribute(AddressingVersion.W3C.eprType.portName,
146 msEpr.serviceName.portName);
147
148 writer.writeNamespace(servicePrefix, msEpr.serviceName.name.getNamespaceURI());
149 if (servicePrefix.length() > 0)
150 writer.writeCharacters(servicePrefix + ":" + msEpr.serviceName.name.getLocalPart());
151 else
152 writer.writeCharacters(msEpr.serviceName.name.getLocalPart());
153 writer.writeEndElement();
154 }
155 */
156 //TODO: revisit this
157 Element wsdlElement = null;
158 //Check for wsdl in extension elements
159 if ((msEpr.elements != null) && (msEpr.elements.size() > 0)) {
160 for (Element e : msEpr.elements) {
161 if(e.getNamespaceURI().equals(MemberSubmissionAddressingConstants.MEX_METADATA.getNamespaceURI()) &&
162 e.getLocalName().equals(MemberSubmissionAddressingConstants.MEX_METADATA.getLocalPart())) {
163 NodeList nl = e.getElementsByTagNameNS(WSDLConstants.NS_WSDL,
164 WSDLConstants.QNAME_DEFINITIONS.getLocalPart());
165 if(nl != null)
166 wsdlElement = (Element) nl.item(0);
167 }
168 }
169 }
170 //write WSDL
171 if (wsdlElement != null) {
172 DOMUtil.serializeNode(wsdlElement, writer);
173 }
174
175 if (w3cMetadataWritten)
176 writer.writeEndElement();
177 //TODO revisit this
178 //write extension elements
179 if ((msEpr.elements != null) && (msEpr.elements.size() > 0)) {
180 for (Element e : msEpr.elements) {
181 if (e.getNamespaceURI().equals(WSDLConstants.NS_WSDL) &&
182 e.getLocalName().equals(WSDLConstants.QNAME_DEFINITIONS.getLocalPart())) {
183 // Don't write it as this is written already in Metadata
184 }
185 DOMUtil.serializeNode(e, writer);
186 }
187 }
188
189 //TODO:write extension attributes
190
191 //</EndpointReference>
192 writer.writeEndElement();
193 writer.writeEndDocument();
194 writer.flush();
195 } catch (XMLStreamException e) {
196 throw new WebServiceException(e);
197 }
198 return new W3CEndpointReference(new XMLStreamBufferSource(writer.getXMLStreamBuffer()));
199 }
200
201 private static boolean w3cMetadataWritten = false;
202
203 private static void writeW3CMetadata(StreamWriterBufferCreator writer) throws XMLStreamException {
204 if (!w3cMetadataWritten) {
205 writer.writeStartElement(AddressingVersion.W3C.getPrefix(), AddressingVersion.W3C.eprType.wsdlMetadata.getLocalPart(), AddressingVersion.W3C.nsUri);
206 w3cMetadataWritten = true;
207 }
208 }
209
210 private static MemberSubmissionEndpointReference toMSEpr(W3CEndpointReference w3cEpr) {
211 DOMResult result = new DOMResult();
212 w3cEpr.writeTo(result);
213 Node eprNode = result.getNode();
214 Element e = DOMUtil.getFirstElementChild(eprNode);
215 if (e == null)
216 return null;
217
218 MemberSubmissionEndpointReference msEpr = new MemberSubmissionEndpointReference();
219
220 NodeList nodes = e.getChildNodes();
221 for (int i = 0; i < nodes.getLength(); i++) {
222 if (nodes.item(i).getNodeType() == Node.ELEMENT_NODE) {
223 Element child = (Element) nodes.item(i);
224 if (child.getNamespaceURI().equals(AddressingVersion.W3C.nsUri) &&
225 child.getLocalName().equals(AddressingVersion.W3C.eprType.address)) {
226 if (msEpr.addr == null)
227 msEpr.addr = new MemberSubmissionEndpointReference.Address();
228 msEpr.addr.uri = XmlUtil.getTextForNode(child);
229
230 //now add the attribute extensions
231 msEpr.addr.attributes = getAttributes(child);
232 } else if (child.getNamespaceURI().equals(AddressingVersion.W3C.nsUri) &&
233 child.getLocalName().equals("ReferenceParameters")) {
234 NodeList refParams = child.getChildNodes();
235 for (int j = 0; j < refParams.getLength(); j++) {
236 if (refParams.item(j).getNodeType() == Node.ELEMENT_NODE) {
237 if (msEpr.referenceParameters == null) {
238 msEpr.referenceParameters = new MemberSubmissionEndpointReference.Elements();
239 msEpr.referenceParameters.elements = new ArrayList<Element>();
240 }
241 msEpr.referenceParameters.elements.add((Element) refParams.item(j));
242 }
243 }
244 } else if (child.getNamespaceURI().equals(AddressingVersion.W3C.nsUri) &&
245 child.getLocalName().equals(AddressingVersion.W3C.eprType.wsdlMetadata.getLocalPart())) {
246 NodeList metadata = child.getChildNodes();
247 String wsdlLocation = child.getAttributeNS(W3CAddressingMetadataConstants.WSAM_WSDLI_ATTRIBUTE_NAMESPACE,
248 W3CAddressingMetadataConstants.WSAM_WSDLI_ATTRIBUTE_LOCALNAME);
249 Element wsdlDefinitions = null;
250 for (int j = 0; j < metadata.getLength(); j++) {
251 Node node = metadata.item(j);
252 if (node.getNodeType() != Node.ELEMENT_NODE)
253 continue;
254
255 Element elm = (Element) node;
256 if ((elm.getNamespaceURI().equals(AddressingVersion.W3C.wsdlNsUri) ||
257 elm.getNamespaceURI().equals(W3CAddressingMetadataConstants.WSAM_NAMESPACE_NAME)) &&
258 elm.getLocalName().equals(AddressingVersion.W3C.eprType.serviceName)) {
259 msEpr.serviceName = new MemberSubmissionEndpointReference.ServiceNameType();
260 msEpr.serviceName.portName = elm.getAttribute(AddressingVersion.W3C.eprType.portName);
261
262 String service = elm.getTextContent();
263 String prefix = XmlUtil.getPrefix(service);
264 String name = XmlUtil.getLocalPart(service);
265
266 //if there is no service name then its not a valid EPR but lets continue as its optional anyway
267 if (name == null)
268 continue;
269
270 if (prefix != null) {
271 String ns = elm.lookupNamespaceURI(prefix);
272 if (ns != null)
273 msEpr.serviceName.name = new QName(ns, name, prefix);
274 } else {
275 msEpr.serviceName.name = new QName(null, name);
276 }
277 msEpr.serviceName.attributes = getAttributes(elm);
278 } else if ((elm.getNamespaceURI().equals(AddressingVersion.W3C.wsdlNsUri) ||
279 elm.getNamespaceURI().equals(W3CAddressingMetadataConstants.WSAM_NAMESPACE_NAME)) &&
280 elm.getLocalName().equals(AddressingVersion.W3C.eprType.portTypeName)) {
281 msEpr.portTypeName = new MemberSubmissionEndpointReference.AttributedQName();
282
283 String portType = elm.getTextContent();
284 String prefix = XmlUtil.getPrefix(portType);
285 String name = XmlUtil.getLocalPart(portType);
286
287 //if there is no portType name then its not a valid EPR but lets continue as its optional anyway
288 if (name == null)
289 continue;
290
291 if (prefix != null) {
292 String ns = elm.lookupNamespaceURI(prefix);
293 if (ns != null)
294 msEpr.portTypeName.name = new QName(ns, name, prefix);
295 } else {
296 msEpr.portTypeName.name = new QName(null, name);
297 }
298 msEpr.portTypeName.attributes = getAttributes(elm);
299 } else if(elm.getNamespaceURI().equals(WSDLConstants.NS_WSDL) &&
300 elm.getLocalName().equals(WSDLConstants.QNAME_DEFINITIONS.getLocalPart())) {
301 wsdlDefinitions = elm;
302 } else {
303 //TODO : Revisit this
304 //its extensions in META-DATA and should be copied to extensions in MS EPR
305 if (msEpr.elements == null) {
306 msEpr.elements = new ArrayList<Element>();
307 }
308 msEpr.elements.add(elm);
309 }
310 }
311
312
313 Document doc = DOMUtil.createDom();
314 Element mexEl = doc.createElementNS(MemberSubmissionAddressingConstants.MEX_METADATA.getNamespaceURI(),
315 MemberSubmissionAddressingConstants.MEX_METADATA.getPrefix() + ":"
316 + MemberSubmissionAddressingConstants.MEX_METADATA.getLocalPart());
317 Element metadataEl = doc.createElementNS(MemberSubmissionAddressingConstants.MEX_METADATA_SECTION.getNamespaceURI(),
318 MemberSubmissionAddressingConstants.MEX_METADATA_SECTION.getPrefix() + ":"
319 + MemberSubmissionAddressingConstants.MEX_METADATA_SECTION.getLocalPart());
320 metadataEl.setAttribute(MemberSubmissionAddressingConstants.MEX_METADATA_DIALECT_ATTRIBUTE,
321 MemberSubmissionAddressingConstants.MEX_METADATA_DIALECT_VALUE);
322 if (wsdlDefinitions == null && wsdlLocation != null && !wsdlLocation.equals("")) {
323 wsdlLocation = wsdlLocation.trim();
324 String wsdlTns = wsdlLocation.substring(0, wsdlLocation.indexOf(' '));
325 wsdlLocation = wsdlLocation.substring(wsdlLocation.indexOf(' ') + 1);
326 Element wsdlEl = doc.createElementNS(WSDLConstants.NS_WSDL,
327 WSDLConstants.PREFIX_NS_WSDL + ":"
328 + WSDLConstants.QNAME_DEFINITIONS.getLocalPart());
329 Element wsdlImportEl = doc.createElementNS(WSDLConstants.NS_WSDL,
330 WSDLConstants.PREFIX_NS_WSDL + ":"
331 + WSDLConstants.QNAME_IMPORT.getLocalPart());
332 wsdlImportEl.setAttribute("namespace", wsdlTns);
333 wsdlImportEl.setAttribute("location", wsdlLocation);
334 wsdlEl.appendChild(wsdlImportEl);
335 metadataEl.appendChild(wsdlEl);
336 } else if(wsdlDefinitions != null){
337 metadataEl.appendChild(wsdlDefinitions);
338 }
339 mexEl.appendChild(metadataEl);
340
341 if (msEpr.elements == null) {
342 msEpr.elements = new ArrayList<Element>();
343 }
344 msEpr.elements.add(mexEl);
345
346
347 } else {
348 //its extensions
349 if (msEpr.elements == null) {
350 msEpr.elements = new ArrayList<Element>();
351 }
352 msEpr.elements.add((Element) child);
353
354 }
355 } else if (nodes.item(i).getNodeType() == Node.ATTRIBUTE_NODE) {
356 Node n = nodes.item(i);
357 if (msEpr.attributes == null) {
358 msEpr.attributes = new HashMap<QName, String>();
359 String prefix = fixNull(n.getPrefix());
360 String ns = fixNull(n.getNamespaceURI());
361 String localName = n.getLocalName();
362 msEpr.attributes.put(new QName(ns, localName, prefix), n.getNodeValue());
363 }
364 }
365 }
366
367 return msEpr;
368 }
369
370 private static Map<QName, String> getAttributes(Node node) {
371 Map<QName, String> attribs = null;
372
373 NamedNodeMap nm = node.getAttributes();
374 for (int i = 0; i < nm.getLength(); i++) {
375 if (attribs == null)
376 attribs = new HashMap<QName, String>();
377 Node n = nm.item(i);
378 String prefix = fixNull(n.getPrefix());
379 String ns = fixNull(n.getNamespaceURI());
380 String localName = n.getLocalName();
381 if (prefix.equals("xmlns") || prefix.length() == 0 && localName.equals("xmlns"))
382 continue;
383
384 //exclude some attributes
385 if (!localName.equals(AddressingVersion.W3C.eprType.portName))
386 attribs.put(new QName(ns, localName, prefix), n.getNodeValue());
387 }
388 return attribs;
389 }
390
391 private static
392 @NotNull
393 String fixNull(@Nullable String s) {
394 if (s == null) return "";
395 else return s;
396 }
397
398 }