com.sun.xml.ws.message.stream.OutboundStreamHeader Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/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 packager/legal/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.message.stream;
import com.sun.istack.FinalArrayList;
import com.sun.istack.NotNull;
import com.sun.xml.stream.buffer.XMLStreamBuffer;
import com.sun.xml.stream.buffer.XMLStreamBufferException;
import com.sun.xml.ws.api.message.Header;
import com.sun.xml.ws.message.AbstractHeaderImpl;
import org.xml.sax.ContentHandler;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.soap.SOAPHeader;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.ws.WebServiceException;
/**
* Used to represent outbound header created from {@link XMLStreamBuffer}.
*
*
* This is optimized for outbound use, so it implements some of the methods lazily,
* in a slow way.
*
* @author Kohsuke Kawaguchi
*/
public final class OutboundStreamHeader extends AbstractHeaderImpl {
private final XMLStreamBuffer infoset;
private final String nsUri,localName;
/**
* The attributes on the header element.
* Lazily parsed.
* Null if not parsed yet.
*/
private FinalArrayList attributes;
public OutboundStreamHeader(XMLStreamBuffer infoset, String nsUri, String localName) {
this.infoset = infoset;
this.nsUri = nsUri;
this.localName = localName;
}
public @NotNull String getNamespaceURI() {
return nsUri;
}
public @NotNull String getLocalPart() {
return localName;
}
public String getAttribute(String nsUri, String localName) {
if(attributes==null)
parseAttributes();
for(int i=attributes.size()-1; i>=0; i-- ) {
Attribute a = attributes.get(i);
if(a.localName.equals(localName) && a.nsUri.equals(nsUri))
return a.value;
}
return null;
}
/**
* We don't really expect this to be used, but just to satisfy
* the {@link Header} contract.
*
* So this is rather slow.
*/
private void parseAttributes() {
try {
XMLStreamReader reader = readHeader();
attributes = new FinalArrayList();
for (int i = 0; i < reader.getAttributeCount(); i++) {
final String localName = reader.getAttributeLocalName(i);
final String namespaceURI = reader.getAttributeNamespace(i);
final String value = reader.getAttributeValue(i);
attributes.add(new Attribute(namespaceURI,localName,value));
}
} catch (XMLStreamException e) {
throw new WebServiceException("Unable to read the attributes for {"+nsUri+"}"+localName+" header",e);
}
}
public XMLStreamReader readHeader() throws XMLStreamException {
return infoset.readAsXMLStreamReader();
}
public void writeTo(XMLStreamWriter w) throws XMLStreamException {
infoset.writeToXMLStreamWriter(w,true);
}
public void writeTo(SOAPMessage saaj) throws SOAPException {
try {
SOAPHeader header = saaj.getSOAPHeader();
if (header == null)
header = saaj.getSOAPPart().getEnvelope().addHeader();
infoset.writeTo(header);
} catch (XMLStreamBufferException e) {
throw new SOAPException(e);
}
}
public void writeTo(ContentHandler contentHandler, ErrorHandler errorHandler) throws SAXException {
infoset.writeTo(contentHandler,errorHandler);
}
/**
* Keep the information about an attribute on the header element.
*/
static final class Attribute {
/**
* Can be empty but never null.
*/
final String nsUri;
final String localName;
final String value;
public Attribute(String nsUri, String localName, String value) {
this.nsUri = fixNull(nsUri);
this.localName = localName;
this.value = value;
}
/**
* Convert null to "".
*/
private static String fixNull(String s) {
if(s==null) return "";
else return s;
}
}
/**
* We the performance paranoid people in the JAX-WS RI thinks
* saving three bytes is worth while...
*/
private static final String TRUE_VALUE = "1";
private static final String IS_REFERENCE_PARAMETER = "IsReferenceParameter";
}