Fri, 14 Feb 2014 11:13:45 +0100
8026188: Enhance envelope factory
Summary: Avoiding caching data initialized via TCCL in static context; fix also reviewed by Alexander Fomin
Reviewed-by: ahgross, mgrebac, skoivu
ohair@286 | 1 | /* |
alanb@368 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
ohair@286 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
ohair@286 | 4 | * |
ohair@286 | 5 | * This code is free software; you can redistribute it and/or modify it |
ohair@286 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@286 | 7 | * published by the Free Software Foundation. Oracle designates this |
ohair@286 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@286 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
ohair@286 | 10 | * |
ohair@286 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
ohair@286 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
ohair@286 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
ohair@286 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
ohair@286 | 15 | * accompanied this code). |
ohair@286 | 16 | * |
ohair@286 | 17 | * You should have received a copy of the GNU General Public License version |
ohair@286 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
ohair@286 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
ohair@286 | 20 | * |
ohair@286 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@286 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@286 | 23 | * questions. |
ohair@286 | 24 | */ |
ohair@286 | 25 | |
ohair@286 | 26 | package com.sun.xml.internal.ws.message; |
ohair@286 | 27 | |
ohair@286 | 28 | import com.sun.istack.internal.NotNull; |
ohair@286 | 29 | import com.sun.istack.internal.Nullable; |
ohair@286 | 30 | import com.sun.xml.internal.stream.buffer.MutableXMLStreamBuffer; |
ohair@286 | 31 | import com.sun.xml.internal.ws.api.SOAPVersion; |
ohair@286 | 32 | import com.sun.xml.internal.ws.api.message.Header; |
ohair@286 | 33 | import org.xml.sax.ContentHandler; |
ohair@286 | 34 | import org.xml.sax.ErrorHandler; |
ohair@286 | 35 | import org.xml.sax.SAXException; |
ohair@286 | 36 | import org.xml.sax.helpers.AttributesImpl; |
ohair@286 | 37 | |
ohair@286 | 38 | import javax.xml.namespace.QName; |
ohair@286 | 39 | import javax.xml.soap.SOAPException; |
ohair@286 | 40 | import javax.xml.soap.SOAPHeader; |
ohair@286 | 41 | import javax.xml.soap.SOAPHeaderElement; |
ohair@286 | 42 | import javax.xml.soap.SOAPMessage; |
ohair@286 | 43 | import javax.xml.stream.XMLStreamException; |
ohair@286 | 44 | import javax.xml.stream.XMLStreamReader; |
ohair@286 | 45 | import javax.xml.stream.XMLStreamWriter; |
ohair@286 | 46 | |
ohair@286 | 47 | /** |
ohair@286 | 48 | * {@link Header} that has a single text value in it |
ohair@286 | 49 | * (IOW, of the form <foo>text</foo>.) |
ohair@286 | 50 | * |
ohair@286 | 51 | * @author Rama Pulavarthi |
ohair@286 | 52 | * @author Arun Gupta |
ohair@286 | 53 | */ |
ohair@286 | 54 | public class StringHeader extends AbstractHeaderImpl { |
ohair@286 | 55 | /** |
ohair@286 | 56 | * Tag name. |
ohair@286 | 57 | */ |
ohair@286 | 58 | protected final QName name; |
ohair@286 | 59 | /** |
ohair@286 | 60 | * Header value. |
ohair@286 | 61 | */ |
ohair@286 | 62 | protected final String value; |
ohair@286 | 63 | |
ohair@286 | 64 | protected boolean mustUnderstand = false; |
ohair@286 | 65 | protected SOAPVersion soapVersion; |
ohair@286 | 66 | |
ohair@286 | 67 | public StringHeader(@NotNull QName name, @NotNull String value) { |
ohair@286 | 68 | assert name != null; |
ohair@286 | 69 | assert value != null; |
ohair@286 | 70 | this.name = name; |
ohair@286 | 71 | this.value = value; |
ohair@286 | 72 | } |
ohair@286 | 73 | |
ohair@286 | 74 | public StringHeader(@NotNull QName name, @NotNull String value, @NotNull SOAPVersion soapVersion, boolean mustUnderstand ) { |
ohair@286 | 75 | this.name = name; |
ohair@286 | 76 | this.value = value; |
ohair@286 | 77 | this.soapVersion = soapVersion; |
ohair@286 | 78 | this.mustUnderstand = mustUnderstand; |
ohair@286 | 79 | } |
ohair@286 | 80 | |
ohair@286 | 81 | public @NotNull String getNamespaceURI() { |
ohair@286 | 82 | return name.getNamespaceURI(); |
ohair@286 | 83 | } |
ohair@286 | 84 | |
ohair@286 | 85 | public @NotNull String getLocalPart() { |
ohair@286 | 86 | return name.getLocalPart(); |
ohair@286 | 87 | } |
ohair@286 | 88 | |
ohair@286 | 89 | @Nullable public String getAttribute(@NotNull String nsUri, @NotNull String localName) { |
ohair@286 | 90 | if(mustUnderstand && soapVersion.nsUri.equals(nsUri) && MUST_UNDERSTAND.equals(localName)) { |
ohair@286 | 91 | return getMustUnderstandLiteral(soapVersion); |
ohair@286 | 92 | } |
ohair@286 | 93 | return null; |
ohair@286 | 94 | } |
ohair@286 | 95 | |
ohair@286 | 96 | public XMLStreamReader readHeader() throws XMLStreamException { |
ohair@286 | 97 | MutableXMLStreamBuffer buf = new MutableXMLStreamBuffer(); |
ohair@286 | 98 | XMLStreamWriter w = buf.createFromXMLStreamWriter(); |
ohair@286 | 99 | writeTo(w); |
ohair@286 | 100 | return buf.readAsXMLStreamReader(); |
ohair@286 | 101 | } |
ohair@286 | 102 | |
ohair@286 | 103 | public void writeTo(XMLStreamWriter w) throws XMLStreamException { |
ohair@286 | 104 | w.writeStartElement("", name.getLocalPart(), name.getNamespaceURI()); |
ohair@286 | 105 | w.writeDefaultNamespace(name.getNamespaceURI()); |
ohair@286 | 106 | if (mustUnderstand) { |
ohair@286 | 107 | //Writing the ns declaration conditionally checking in the NSContext breaks XWSS. as readHeader() adds ns declaration, |
ohair@286 | 108 | // where as writing alonf with the soap envelope does n't add it. |
ohair@286 | 109 | //Looks like they expect the readHeader() and writeTo() produce the same infoset, Need to understand their usage |
ohair@286 | 110 | |
ohair@286 | 111 | //if(w.getNamespaceContext().getPrefix(soapVersion.nsUri) == null) { |
ohair@286 | 112 | w.writeNamespace("S", soapVersion.nsUri); |
ohair@286 | 113 | w.writeAttribute("S", soapVersion.nsUri, MUST_UNDERSTAND, getMustUnderstandLiteral(soapVersion)); |
ohair@286 | 114 | // } else { |
ohair@286 | 115 | // w.writeAttribute(soapVersion.nsUri,MUST_UNDERSTAND, getMustUnderstandLiteral(soapVersion)); |
ohair@286 | 116 | // } |
ohair@286 | 117 | } |
ohair@286 | 118 | w.writeCharacters(value); |
ohair@286 | 119 | w.writeEndElement(); |
ohair@286 | 120 | } |
ohair@286 | 121 | |
ohair@286 | 122 | public void writeTo(SOAPMessage saaj) throws SOAPException { |
ohair@286 | 123 | SOAPHeader header = saaj.getSOAPHeader(); |
ohair@286 | 124 | if(header == null) |
ohair@286 | 125 | header = saaj.getSOAPPart().getEnvelope().addHeader(); |
ohair@286 | 126 | SOAPHeaderElement she = header.addHeaderElement(name); |
ohair@286 | 127 | if(mustUnderstand) { |
ohair@286 | 128 | she.setMustUnderstand(true); |
ohair@286 | 129 | } |
ohair@286 | 130 | she.addTextNode(value); |
ohair@286 | 131 | } |
ohair@286 | 132 | |
ohair@286 | 133 | public void writeTo(ContentHandler h, ErrorHandler errorHandler) throws SAXException { |
ohair@286 | 134 | String nsUri = name.getNamespaceURI(); |
ohair@286 | 135 | String ln = name.getLocalPart(); |
ohair@286 | 136 | |
ohair@286 | 137 | h.startPrefixMapping("",nsUri); |
ohair@286 | 138 | if(mustUnderstand) { |
ohair@286 | 139 | AttributesImpl attributes = new AttributesImpl(); |
ohair@286 | 140 | attributes.addAttribute(soapVersion.nsUri,MUST_UNDERSTAND,"S:"+MUST_UNDERSTAND,"CDATA", getMustUnderstandLiteral(soapVersion)); |
ohair@286 | 141 | h.startElement(nsUri,ln,ln,attributes); |
ohair@286 | 142 | } else { |
ohair@286 | 143 | h.startElement(nsUri,ln,ln,EMPTY_ATTS); |
ohair@286 | 144 | } |
ohair@286 | 145 | h.characters(value.toCharArray(),0,value.length()); |
ohair@286 | 146 | h.endElement(nsUri,ln,ln); |
ohair@286 | 147 | } |
ohair@286 | 148 | |
ohair@286 | 149 | private static String getMustUnderstandLiteral(SOAPVersion sv) { |
ohair@286 | 150 | if(sv == SOAPVersion.SOAP_12) { |
ohair@286 | 151 | return S12_MUST_UNDERSTAND_TRUE; |
ohair@286 | 152 | } else { |
ohair@286 | 153 | return S11_MUST_UNDERSTAND_TRUE; |
ohair@286 | 154 | } |
ohair@286 | 155 | |
ohair@286 | 156 | } |
ohair@286 | 157 | |
ohair@286 | 158 | protected static final String MUST_UNDERSTAND = "mustUnderstand"; |
ohair@286 | 159 | protected static final String S12_MUST_UNDERSTAND_TRUE ="true"; |
ohair@286 | 160 | protected static final String S11_MUST_UNDERSTAND_TRUE ="1"; |
ohair@286 | 161 | } |