325N/A/*
325N/A * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.xml.internal.ws.message.stream;
325N/A
325N/Aimport com.sun.istack.internal.FinalArrayList;
325N/Aimport com.sun.istack.internal.NotNull;
325N/Aimport com.sun.xml.internal.stream.buffer.XMLStreamBuffer;
325N/Aimport com.sun.xml.internal.stream.buffer.XMLStreamBufferSource;
325N/Aimport com.sun.xml.internal.ws.api.SOAPVersion;
325N/Aimport com.sun.xml.internal.ws.api.addressing.AddressingVersion;
325N/Aimport com.sun.xml.internal.ws.api.addressing.WSEndpointReference;
325N/Aimport com.sun.xml.internal.ws.api.message.Header;
325N/Aimport com.sun.xml.internal.ws.message.AbstractHeaderImpl;
325N/Aimport org.w3c.dom.Node;
325N/Aimport org.xml.sax.ContentHandler;
325N/Aimport org.xml.sax.ErrorHandler;
325N/Aimport org.xml.sax.SAXException;
325N/A
325N/Aimport javax.xml.soap.SOAPException;
325N/Aimport javax.xml.soap.SOAPHeader;
325N/Aimport javax.xml.soap.SOAPMessage;
325N/Aimport javax.xml.stream.XMLStreamException;
325N/Aimport javax.xml.stream.XMLStreamReader;
325N/Aimport javax.xml.stream.XMLStreamWriter;
325N/Aimport javax.xml.transform.Transformer;
325N/Aimport javax.xml.transform.TransformerFactory;
325N/Aimport javax.xml.transform.dom.DOMResult;
325N/Aimport java.util.List;
325N/Aimport java.util.Set;
325N/A
325N/A/**
325N/A * {@link Header} whose physical data representation is an XMLStreamBuffer.
325N/A *
325N/A * @author Paul.Sandoz@Sun.Com
325N/A */
325N/Apublic abstract class StreamHeader extends AbstractHeaderImpl {
325N/A protected final XMLStreamBuffer _mark;
325N/A
325N/A protected boolean _isMustUnderstand;
325N/A
325N/A /**
325N/A * Role or actor value.
325N/A */
325N/A protected @NotNull String _role;
325N/A
325N/A protected boolean _isRelay;
325N/A
325N/A protected String _localName;
325N/A
325N/A protected String _namespaceURI;
325N/A
325N/A /**
325N/A * Keep the information about an attribute on the header element.
325N/A *
325N/A * TODO: this whole attribute handling could be done better, I think.
325N/A */
325N/A protected static final class Attribute {
325N/A /**
325N/A * Can be empty but never null.
325N/A */
325N/A final String nsUri;
325N/A final String localName;
325N/A final String value;
325N/A
325N/A public Attribute(String nsUri, String localName, String value) {
325N/A this.nsUri = fixNull(nsUri);
325N/A this.localName = localName;
325N/A this.value = value;
325N/A }
325N/A }
325N/A
325N/A /**
325N/A * The attributes on the header element.
325N/A * We expect there to be only a small number of them,
325N/A * so the use of {@link List} would be justified.
325N/A *
325N/A * Null if no attribute is present.
325N/A */
325N/A private final FinalArrayList<Attribute> attributes;
325N/A
325N/A /**
325N/A * Creates a {@link StreamHeader}.
325N/A *
325N/A * @param reader
325N/A * The parser pointing at the start of the mark.
325N/A * Technically this information is redundant,
325N/A * but it achieves a better performance.
325N/A * @param mark
325N/A * The start of the buffered header content.
325N/A */
325N/A protected StreamHeader(XMLStreamReader reader, XMLStreamBuffer mark) {
325N/A assert reader!=null && mark!=null;
325N/A _mark = mark;
325N/A _localName = reader.getLocalName();
325N/A _namespaceURI = reader.getNamespaceURI();
325N/A attributes = processHeaderAttributes(reader);
325N/A }
325N/A
325N/A /**
325N/A * Creates a {@link StreamHeader}.
325N/A *
325N/A * @param reader
325N/A * The parser that points to the start tag of the header.
325N/A * By the end of this method, the parser will point at
325N/A * the end tag of this element.
325N/A */
325N/A protected StreamHeader(XMLStreamReader reader) throws XMLStreamException {
325N/A _localName = reader.getLocalName();
325N/A _namespaceURI = reader.getNamespaceURI();
325N/A attributes = processHeaderAttributes(reader);
325N/A // cache the body
325N/A _mark = XMLStreamBuffer.createNewBufferFromXMLStreamReader(reader);
325N/A }
325N/A
325N/A public final boolean isIgnorable(@NotNull SOAPVersion soapVersion, @NotNull Set<String> roles) {
325N/A // check mustUnderstand
325N/A if(!_isMustUnderstand) return true;
325N/A
325N/A if (roles == null)
325N/A return true;
325N/A
325N/A // now role
325N/A return !roles.contains(_role);
325N/A }
325N/A
325N/A public @NotNull String getRole(@NotNull SOAPVersion soapVersion) {
325N/A assert _role!=null;
325N/A return _role;
325N/A }
325N/A
325N/A public boolean isRelay() {
325N/A return _isRelay;
325N/A }
325N/A
325N/A public @NotNull String getNamespaceURI() {
325N/A return _namespaceURI;
325N/A }
325N/A
325N/A public @NotNull String getLocalPart() {
325N/A return _localName;
325N/A }
325N/A
325N/A public String getAttribute(String nsUri, String localName) {
325N/A if(attributes!=null) {
325N/A for(int i=attributes.size()-1; i>=0; i-- ) {
325N/A Attribute a = attributes.get(i);
325N/A if(a.localName.equals(localName) && a.nsUri.equals(nsUri))
325N/A return a.value;
325N/A }
325N/A }
325N/A return null;
325N/A }
325N/A
325N/A /**
325N/A * Reads the header as a {@link XMLStreamReader}
325N/A */
325N/A public XMLStreamReader readHeader() throws XMLStreamException {
325N/A return _mark.readAsXMLStreamReader();
325N/A }
325N/A
325N/A public void writeTo(XMLStreamWriter w) throws XMLStreamException {
325N/A if(_mark.getInscopeNamespaces().size() > 0)
325N/A _mark.writeToXMLStreamWriter(w,true);
325N/A else
325N/A _mark.writeToXMLStreamWriter(w);
325N/A }
325N/A
325N/A public void writeTo(SOAPMessage saaj) throws SOAPException {
325N/A try {
325N/A // TODO what about in-scope namespaces
325N/A // Not very efficient consider implementing a stream buffer
325N/A // processor that produces a DOM node from the buffer.
325N/A TransformerFactory tf = TransformerFactory.newInstance();
325N/A Transformer t = tf.newTransformer();
325N/A XMLStreamBufferSource source = new XMLStreamBufferSource(_mark);
325N/A DOMResult result = new DOMResult();
325N/A t.transform(source, result);
325N/A Node d = result.getNode();
325N/A if(d.getNodeType() == Node.DOCUMENT_NODE)
325N/A d = d.getFirstChild();
325N/A SOAPHeader header = saaj.getSOAPHeader();
325N/A if(header == null)
325N/A header = saaj.getSOAPPart().getEnvelope().addHeader();
325N/A Node node = header.getOwnerDocument().importNode(d, true);
325N/A header.appendChild(node);
325N/A } catch (Exception e) {
325N/A throw new SOAPException(e);
325N/A }
325N/A }
325N/A
325N/A public void writeTo(ContentHandler contentHandler, ErrorHandler errorHandler) throws SAXException {
325N/A _mark.writeTo(contentHandler);
325N/A }
325N/A
325N/A /**
325N/A * Creates an EPR without copying infoset.
325N/A *
325N/A * This is the most common implementation on which {@link Header#readAsEPR(AddressingVersion)}
325N/A * is invoked on.
325N/A */
325N/A @Override @NotNull
325N/A public WSEndpointReference readAsEPR(AddressingVersion expected) throws XMLStreamException {
325N/A return new WSEndpointReference(_mark,expected);
325N/A }
325N/A
325N/A protected abstract FinalArrayList<Attribute> processHeaderAttributes(XMLStreamReader reader);
325N/A
325N/A /**
325N/A * Convert null to "".
325N/A */
325N/A private static String fixNull(String s) {
325N/A if(s==null) return "";
325N/A else return s;
325N/A }
325N/A}