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.api.addressing;
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.XMLStreamBufferException;
325N/Aimport com.sun.xml.internal.ws.api.message.Header;
325N/Aimport com.sun.xml.internal.ws.message.AbstractHeaderImpl;
325N/Aimport com.sun.xml.internal.ws.util.xml.XMLStreamWriterFilter;
325N/Aimport org.w3c.dom.Element;
325N/Aimport org.xml.sax.Attributes;
325N/Aimport org.xml.sax.ContentHandler;
325N/Aimport org.xml.sax.ErrorHandler;
325N/Aimport org.xml.sax.SAXException;
325N/Aimport org.xml.sax.helpers.AttributesImpl;
325N/Aimport org.xml.sax.helpers.XMLFilterImpl;
325N/A
325N/Aimport javax.xml.namespace.QName;
325N/Aimport javax.xml.soap.SOAPException;
325N/Aimport javax.xml.soap.SOAPMessage;
325N/Aimport javax.xml.soap.SOAPHeader;
325N/Aimport javax.xml.stream.XMLStreamException;
325N/Aimport javax.xml.stream.XMLStreamReader;
325N/Aimport javax.xml.stream.XMLStreamWriter;
325N/Aimport javax.xml.stream.util.StreamReaderDelegate;
325N/Aimport javax.xml.ws.WebServiceException;
325N/A
325N/A/**
325N/A * Used to represent outbound header created from {@link WSEndpointReference}'s
325N/A * referenec parameters.
325N/A *
325N/A * <p>
325N/A * This is optimized for outbound use, so it implements some of the methods lazily,
325N/A * in a slow way.
325N/A *
325N/A * <p>
325N/A * This header adds "wsa:IsReferenceParameter" and thus only used for the W3C version.
325N/A *
325N/A * @author Kohsuke Kawaguchi
325N/A */
325N/Afinal class OutboundReferenceParameterHeader extends AbstractHeaderImpl {
325N/A private final XMLStreamBuffer infoset;
325N/A private final String nsUri,localName;
325N/A
325N/A /**
325N/A * The attributes on the header element.
325N/A * Lazily parsed.
325N/A * Null if not parsed yet.
325N/A */
325N/A private FinalArrayList<Attribute> attributes;
325N/A
325N/A OutboundReferenceParameterHeader(XMLStreamBuffer infoset, String nsUri, String localName) {
325N/A this.infoset = infoset;
325N/A this.nsUri = nsUri;
325N/A this.localName = localName;
325N/A }
325N/A
325N/A public @NotNull String getNamespaceURI() {
325N/A return nsUri;
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 parseAttributes();
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 return null;
325N/A }
325N/A
325N/A /**
325N/A * We don't really expect this to be used, but just to satisfy
325N/A * the {@link Header} contract.
325N/A *
325N/A * So this is rather slow.
325N/A */
325N/A private void parseAttributes() {
325N/A try {
325N/A XMLStreamReader reader = readHeader();
325N/A reader.nextTag(); // move to the first element, which is the header element
325N/A
325N/A attributes = new FinalArrayList<Attribute>();
325N/A boolean refParamAttrWritten = false;
325N/A for (int i = 0; i < reader.getAttributeCount(); i++) {
325N/A final String localName = reader.getAttributeLocalName(i);
325N/A final String namespaceURI = reader.getAttributeNamespace(i);
325N/A final String value = reader.getAttributeValue(i);
325N/A if(namespaceURI.equals(AddressingVersion.W3C.nsUri)&& localName.equals("IS_REFERENCE_PARAMETER"))
325N/A refParamAttrWritten = true;
325N/A attributes.add(new Attribute(namespaceURI,localName,value));
325N/A }
325N/A // we are adding one more attribute "wsa:IsReferenceParameter", if its not alrady there
325N/A if(!refParamAttrWritten)
325N/A attributes.add(new Attribute(AddressingVersion.W3C.nsUri,IS_REFERENCE_PARAMETER,TRUE_VALUE));
325N/A } catch (XMLStreamException e) {
325N/A throw new WebServiceException("Unable to read the attributes for {"+nsUri+"}"+localName+" header",e);
325N/A }
325N/A }
325N/A
325N/A public XMLStreamReader readHeader() throws XMLStreamException {
325N/A return new StreamReaderDelegate(infoset.readAsXMLStreamReader()) {
325N/A int state=0; /* 0:expecting root, 1:in root, 2:past root */
325N/A public int next() throws XMLStreamException {
325N/A return check(super.next());
325N/A }
325N/A
325N/A public int nextTag() throws XMLStreamException {
325N/A return check(super.nextTag());
325N/A }
325N/A
325N/A private int check(int type) {
325N/A switch(state) {
325N/A case 0:
325N/A if(type==START_ELEMENT)
325N/A state=1;
325N/A break;
325N/A case 1:
325N/A state=2;
325N/A }
325N/A
325N/A return type;
325N/A }
325N/A
325N/A public int getAttributeCount() {
325N/A if(state==1) return super.getAttributeCount()+1;
325N/A else return super.getAttributeCount();
325N/A }
325N/A
325N/A public String getAttributeLocalName(int index) {
325N/A if(state==1 && index==super.getAttributeCount())
325N/A return IS_REFERENCE_PARAMETER;
325N/A else
325N/A return super.getAttributeLocalName(index);
325N/A }
325N/A
325N/A public String getAttributeNamespace(int index) {
325N/A if(state==1 && index==super.getAttributeCount())
325N/A return AddressingVersion.W3C.nsUri;
325N/A else
325N/A return super.getAttributeNamespace(index);
325N/A }
325N/A
325N/A public String getAttributePrefix(int index) {
325N/A if(state==1 && index==super.getAttributeCount())
325N/A return "wsa";
325N/A else
325N/A return super.getAttributePrefix(index);
325N/A }
325N/A
325N/A public String getAttributeType(int index) {
325N/A if(state==1 && index==super.getAttributeCount())
325N/A return "CDATA";
325N/A else
325N/A return super.getAttributeType(index);
325N/A }
325N/A
325N/A public String getAttributeValue(int index) {
325N/A if(state==1 && index==super.getAttributeCount())
325N/A return TRUE_VALUE;
325N/A else
325N/A return super.getAttributeValue(index);
325N/A }
325N/A
325N/A public QName getAttributeName(int index) {
325N/A if(state==1 && index==super.getAttributeCount())
325N/A return new QName(AddressingVersion.W3C.nsUri, IS_REFERENCE_PARAMETER, "wsa");
325N/A else
325N/A return super.getAttributeName(index);
325N/A }
325N/A
325N/A public String getAttributeValue(String namespaceUri, String localName) {
325N/A if(state==1 && localName.equals(IS_REFERENCE_PARAMETER) && namespaceUri.equals(AddressingVersion.W3C.nsUri))
325N/A return TRUE_VALUE;
325N/A else
325N/A return super.getAttributeValue(namespaceUri, localName);
325N/A }
325N/A };
325N/A }
325N/A
325N/A public void writeTo(XMLStreamWriter w) throws XMLStreamException {
325N/A infoset.writeToXMLStreamWriter(new XMLStreamWriterFilter(w) {
325N/A private boolean root=true;
325N/A private boolean onRootEl = true;
325N/A public void writeStartElement(String localName) throws XMLStreamException {
325N/A super.writeStartElement(localName);
325N/A writeAddedAttribute();
325N/A }
325N/A
325N/A private void writeAddedAttribute() throws XMLStreamException {
325N/A if(!root) {
325N/A onRootEl = false;
325N/A return;
325N/A }
325N/A root=false;
325N/A writeNamespace("wsa",AddressingVersion.W3C.nsUri);
325N/A super.writeAttribute("wsa",AddressingVersion.W3C.nsUri,IS_REFERENCE_PARAMETER,TRUE_VALUE);
325N/A }
325N/A
325N/A public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException {
325N/A super.writeStartElement(namespaceURI, localName);
325N/A writeAddedAttribute();
325N/A }
325N/A
325N/A public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException {
325N/A //TODO: Verify with KK later
325N/A //check if prefix is declared before writing start element.
325N/A boolean prefixDeclared = isPrefixDeclared(prefix,namespaceURI);
325N/A super.writeStartElement(prefix, localName, namespaceURI);
325N/A if(!prefixDeclared && !prefix.equals(""))
325N/A super.writeNamespace(prefix,namespaceURI);
325N/A writeAddedAttribute();
325N/A }
325N/A public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException{
325N/A //TODO: Verify with KK later
325N/A if(isPrefixDeclared(prefix, namespaceURI)) {
325N/A //Dont write it again , as its already in NamespaceContext
325N/A return;
325N/A } else
325N/A super.writeNamespace(prefix,namespaceURI);
325N/A }
325N/A
325N/A public void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws XMLStreamException {
325N/A //skip if its on root element and attribute is wsa;IsReferenceParameter, as we write it.
325N/A if(onRootEl && namespaceURI.equals(AddressingVersion.W3C.nsUri)
325N/A && localName.equals(IS_REFERENCE_PARAMETER))
325N/A return;
325N/A
325N/A writer.writeAttribute(prefix, namespaceURI, localName, value);
325N/A }
325N/A public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException {
325N/A
325N/A
325N/A writer.writeAttribute(namespaceURI, localName, value);
325N/A }
325N/A private boolean isPrefixDeclared(String prefix, String namespaceURI ) {
325N/A return namespaceURI.equals(getNamespaceContext().getNamespaceURI(prefix));
325N/A }
325N/A },true);
325N/A }
325N/A
325N/A public void writeTo(SOAPMessage saaj) throws SOAPException {
325N/A //TODO: SAAJ returns null instead of throwing SOAPException,
325N/A // when there is no SOAPHeader in the message,
325N/A // which leads to NPE.
325N/A try {
325N/A SOAPHeader header = saaj.getSOAPHeader();
325N/A if (header == null)
325N/A header = saaj.getSOAPPart().getEnvelope().addHeader();
325N/A Element node = (Element)infoset.writeTo(header);
325N/A node.setAttributeNS(AddressingVersion.W3C.nsUri,AddressingVersion.W3C.getPrefix()+":"+IS_REFERENCE_PARAMETER,TRUE_VALUE);
325N/A } catch (XMLStreamBufferException 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 class Filter extends XMLFilterImpl {
325N/A Filter(ContentHandler ch) { setContentHandler(ch); }
325N/A private int depth=0;
325N/A public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
325N/A if(depth++==0) {
325N/A // add one more attribute
325N/A super.startPrefixMapping("wsa",AddressingVersion.W3C.nsUri);
325N/A
325N/A //Add the attirbute wsa:IsReferenceParameter if not present already
325N/A if(atts.getIndex(AddressingVersion.W3C.nsUri,IS_REFERENCE_PARAMETER) == -1) {
325N/A AttributesImpl atts2 = new AttributesImpl(atts);
325N/A atts2.addAttribute(
325N/A AddressingVersion.W3C.nsUri,
325N/A IS_REFERENCE_PARAMETER,
325N/A "wsa:IsReferenceParameter",
325N/A "CDATA",
325N/A TRUE_VALUE);
325N/A atts = atts2;
325N/A }
325N/A }
325N/A
325N/A super.startElement(uri, localName, qName, atts);
325N/A }
325N/A
325N/A public void endElement(String uri, String localName, String qName) throws SAXException {
325N/A super.endElement(uri, localName, qName);
325N/A if(--depth==0)
325N/A super.endPrefixMapping("wsa");
325N/A }
325N/A }
325N/A
325N/A infoset.writeTo(new Filter(contentHandler),errorHandler);
325N/A }
325N/A
325N/A
325N/A /**
325N/A * Keep the information about an attribute on the header element.
325N/A */
325N/A 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 * 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 }
325N/A
325N/A /**
325N/A * We the performance paranoid people in the JAX-WS RI thinks
325N/A * saving three bytes is worth while...
325N/A */
325N/A private static final String TRUE_VALUE = "1";
325N/A private static final String IS_REFERENCE_PARAMETER = "IsReferenceParameter";
325N/A}