jaxws/src/share/classes/com/sun/xml/internal/ws/api/addressing/OutboundReferenceParameterHeader.java - platform/libcore - Git at Google

 /*
  * Copyright 2005-2006 Sun Microsystems, Inc.  All Rights Reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Sun designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Sun in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.com if you need additional information or
  * have any questions.
  */

 package com.sun.xml.internal.ws.api.addressing;

 import com.sun.istack.internal.FinalArrayList;
 import com.sun.istack.internal.NotNull;
 import com.sun.xml.internal.stream.buffer.XMLStreamBuffer;
 import com.sun.xml.internal.stream.buffer.XMLStreamBufferException;
 import com.sun.xml.internal.ws.api.message.Header;
 import com.sun.xml.internal.ws.message.AbstractHeaderImpl;
 import com.sun.xml.internal.ws.util.xml.XMLStreamWriterFilter;
 import org.w3c.dom.Element;
 import org.xml.sax.Attributes;
 import org.xml.sax.ContentHandler;
 import org.xml.sax.ErrorHandler;
 import org.xml.sax.SAXException;
 import org.xml.sax.helpers.AttributesImpl;
 import org.xml.sax.helpers.XMLFilterImpl;

 import javax.xml.namespace.QName;
 import javax.xml.soap.SOAPException;
 import javax.xml.soap.SOAPMessage;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 import javax.xml.stream.XMLStreamWriter;
 import javax.xml.stream.util.StreamReaderDelegate;
 import javax.xml.ws.WebServiceException;

 /**
  * Used to represent outbound header created from {@link WSEndpointReference}'s
  * referenec parameters.
  *
  * <p>
  * This is optimized for outbound use, so it implements some of the methods lazily,
  * in a slow way.
  *
  * <p>
  * This header adds "wsa:IsReferenceParameter" and thus only used for the W3C version.
  *
  * @author Kohsuke Kawaguchi
  */
 final class OutboundReferenceParameterHeader 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<Attribute> attributes;

     OutboundReferenceParameterHeader(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();
             reader.nextTag();   // move to the first element, which is the header element

             attributes = new FinalArrayList<Attribute>();

             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));
             }

             // we are adding one more attribute "wsa:IsReferenceParameter"
             attributes.add(new Attribute(AddressingVersion.W3C.nsUri,IS_REFERENCE_PARAMETER,TRUE_VALUE));
         } catch (XMLStreamException e) {
             throw new WebServiceException("Unable to read the attributes for {"+nsUri+"}"+localName+" header",e);
         }
     }

     public XMLStreamReader readHeader() throws XMLStreamException {
         return new StreamReaderDelegate(infoset.readAsXMLStreamReader()) {
             int state=0; /* 0:expecting root, 1:in root, 2:past root */
             public int next() throws XMLStreamException {
                 return check(super.next());
             }

             public int nextTag() throws XMLStreamException {
                 return check(super.nextTag());
             }

             private int check(int type) {
                 switch(state) {
                 case 0:
                     if(type==START_ELEMENT)
                         state=1;
                     break;
                 case 1:
                     state=2;
                 }

                 return type;
             }

             public int getAttributeCount() {
                 if(state==1)    return super.getAttributeCount()+1;
                 else            return super.getAttributeCount();
             }

             public String getAttributeLocalName(int index) {
                 if(state==1 && index==super.getAttributeCount())
                     return IS_REFERENCE_PARAMETER;
                 else
                     return super.getAttributeLocalName(index);
             }

             public String getAttributeNamespace(int index) {
                 if(state==1 && index==super.getAttributeCount())
                     return AddressingVersion.W3C.nsUri;
                 else
                     return super.getAttributeNamespace(index);
             }

             public String getAttributePrefix(int index) {
                 if(state==1 && index==super.getAttributeCount())
                     return "wsa";
                 else
                     return super.getAttributePrefix(index);
             }

             public String getAttributeType(int index) {
                 if(state==1 && index==super.getAttributeCount())
                     return "CDATA";
                 else
                     return super.getAttributeType(index);
             }

             public String getAttributeValue(int index) {
                 if(state==1 && index==super.getAttributeCount())
                     return TRUE_VALUE;
                 else
                     return super.getAttributeValue(index);
             }

             public QName getAttributeName(int index) {
                 if(state==1 && index==super.getAttributeCount())
                     return new QName(AddressingVersion.W3C.nsUri, IS_REFERENCE_PARAMETER, "wsa");
                 else
                     return super.getAttributeName(index);
             }

             public String getAttributeValue(String namespaceUri, String localName) {
                 if(state==1 && localName.equals(IS_REFERENCE_PARAMETER) && namespaceUri.equals(AddressingVersion.W3C.nsUri))
                     return TRUE_VALUE;
                 else
                     return super.getAttributeValue(namespaceUri, localName);
             }
         };
     }

     public void writeTo(XMLStreamWriter w) throws XMLStreamException {
         infoset.writeToXMLStreamWriter(new XMLStreamWriterFilter(w) {
             private boolean root=true;

             public void writeStartElement(String localName) throws XMLStreamException {
                 super.writeStartElement(localName);
                 writeAddedAttribute();
             }

             private void writeAddedAttribute() throws XMLStreamException {
                 if(!root)   return;
                 root=false;
                 writeNamespace("wsa",AddressingVersion.W3C.nsUri);
                 super.writeAttribute("wsa",AddressingVersion.W3C.nsUri,IS_REFERENCE_PARAMETER,TRUE_VALUE);
             }

             public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException {
                 super.writeStartElement(namespaceURI, localName);
                 writeAddedAttribute();
             }

             public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException {
                 //TODO: Verify with KK later
                 //check if prefix is declared before writing start element.
                 boolean prefixDeclared = isPrefixDeclared(prefix,namespaceURI);
                 super.writeStartElement(prefix, localName, namespaceURI);
                 if(!prefixDeclared && !prefix.equals(""))
                     super.writeNamespace(prefix,namespaceURI);
                 writeAddedAttribute();
             }
             public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException{
                 //TODO: Verify with KK later
                 if(isPrefixDeclared(prefix, namespaceURI)) {
                     //Dont write it again , as its already in NamespaceContext
                     return;
                 } else
                     super.writeNamespace(prefix,namespaceURI);
             }

             private boolean isPrefixDeclared(String prefix, String namespaceURI ) {
                 return namespaceURI.equals(getNamespaceContext().getNamespaceURI(prefix));
             }
         },true);
     }

     public void writeTo(SOAPMessage saaj) throws SOAPException {
         //TODO: SAAJ returns null instead of throwing SOAPException,
         // when there is no SOAPHeader in the message,
         // which leads to NPE.
         try {
             Element node = (Element)infoset.writeTo(saaj.getSOAPHeader());
             node.setAttributeNS(AddressingVersion.W3C.nsUri,AddressingVersion.W3C.getPrefix()+":"+IS_REFERENCE_PARAMETER,TRUE_VALUE);
         } catch (XMLStreamBufferException e) {
             throw new SOAPException(e);
         }
     }

     public void writeTo(ContentHandler contentHandler, ErrorHandler errorHandler) throws SAXException {
         class Filter extends XMLFilterImpl {
             Filter(ContentHandler ch) { setContentHandler(ch); }
             private int depth=0;
             public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
                 if(depth++==0) {
                     // add one more attribute
                     super.startPrefixMapping("wsa",AddressingVersion.W3C.nsUri);
                     AttributesImpl atts2 = new AttributesImpl(atts);
                     atts2.addAttribute(
                         AddressingVersion.W3C.nsUri,
                         IS_REFERENCE_PARAMETER,
                         "wsa:IsReferenceParameter",
                         "CDATA",
                         TRUE_VALUE);
                     atts = atts2;
                 }

                 super.startElement(uri, localName, qName, atts);
             }

             public void endElement(String uri, String localName, String qName) throws SAXException {
                 super.endElement(uri, localName, qName);
                 if(--depth==0)
                     super.endPrefixMapping("wsa");
             }
         }

         infoset.writeTo(new Filter(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";
 }
	/*
	* Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
	*
	* This code is free software; you can redistribute it and/or modify it
	* under the terms of the GNU General Public License version 2 only, as
	* published by the Free Software Foundation. Sun designates this
	* particular file as subject to the "Classpath" exception as provided
	* by Sun in the LICENSE file that accompanied this code.
	*
	* This code is distributed in the hope that it will be useful, but WITHOUT
	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	* version 2 for more details (a copy is included in the LICENSE file that
	* accompanied this code).
	*
	* You should have received a copy of the GNU General Public License version
	* 2 along with this work; if not, write to the Free Software Foundation,
	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
	*
	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
	* CA 95054 USA or visit www.sun.com if you need additional information or
	* have any questions.
	*/

	package com.sun.xml.internal.ws.api.addressing;

	import com.sun.istack.internal.FinalArrayList;
	import com.sun.istack.internal.NotNull;
	import com.sun.xml.internal.stream.buffer.XMLStreamBuffer;
	import com.sun.xml.internal.stream.buffer.XMLStreamBufferException;
	import com.sun.xml.internal.ws.api.message.Header;
	import com.sun.xml.internal.ws.message.AbstractHeaderImpl;
	import com.sun.xml.internal.ws.util.xml.XMLStreamWriterFilter;
	import org.w3c.dom.Element;
	import org.xml.sax.Attributes;
	import org.xml.sax.ContentHandler;
	import org.xml.sax.ErrorHandler;
	import org.xml.sax.SAXException;
	import org.xml.sax.helpers.AttributesImpl;
	import org.xml.sax.helpers.XMLFilterImpl;

	import javax.xml.namespace.QName;
	import javax.xml.soap.SOAPException;
	import javax.xml.soap.SOAPMessage;
	import javax.xml.stream.XMLStreamException;
	import javax.xml.stream.XMLStreamReader;
	import javax.xml.stream.XMLStreamWriter;
	import javax.xml.stream.util.StreamReaderDelegate;
	import javax.xml.ws.WebServiceException;

	/**
	* Used to represent outbound header created from {@link WSEndpointReference}'s
	* referenec parameters.
	*
	* <p>
	* This is optimized for outbound use, so it implements some of the methods lazily,
	* in a slow way.
	*
	* <p>
	* This header adds "wsa:IsReferenceParameter" and thus only used for the W3C version.
	*
	* @author Kohsuke Kawaguchi
	*/
	final class OutboundReferenceParameterHeader 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<Attribute> attributes;

	OutboundReferenceParameterHeader(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();
	reader.nextTag(); // move to the first element, which is the header element

	attributes = new FinalArrayList<Attribute>();

	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));
	}

	// we are adding one more attribute "wsa:IsReferenceParameter"
	attributes.add(new Attribute(AddressingVersion.W3C.nsUri,IS_REFERENCE_PARAMETER,TRUE_VALUE));
	} catch (XMLStreamException e) {
	throw new WebServiceException("Unable to read the attributes for {"+nsUri+"}"+localName+" header",e);
	}
	}

	public XMLStreamReader readHeader() throws XMLStreamException {
	return new StreamReaderDelegate(infoset.readAsXMLStreamReader()) {
	int state=0; /* 0:expecting root, 1:in root, 2:past root */
	public int next() throws XMLStreamException {
	return check(super.next());
	}

	public int nextTag() throws XMLStreamException {
	return check(super.nextTag());
	}

	private int check(int type) {
	switch(state) {
	case 0:
	if(type==START_ELEMENT)
	state=1;
	break;
	case 1:
	state=2;
	}

	return type;
	}

	public int getAttributeCount() {
	if(state==1) return super.getAttributeCount()+1;
	else return super.getAttributeCount();
	}

	public String getAttributeLocalName(int index) {
	if(state==1 && index==super.getAttributeCount())
	return IS_REFERENCE_PARAMETER;
	else
	return super.getAttributeLocalName(index);
	}

	public String getAttributeNamespace(int index) {
	if(state==1 && index==super.getAttributeCount())
	return AddressingVersion.W3C.nsUri;
	else
	return super.getAttributeNamespace(index);
	}

	public String getAttributePrefix(int index) {
	if(state==1 && index==super.getAttributeCount())
	return "wsa";
	else
	return super.getAttributePrefix(index);
	}

	public String getAttributeType(int index) {
	if(state==1 && index==super.getAttributeCount())
	return "CDATA";
	else
	return super.getAttributeType(index);
	}

	public String getAttributeValue(int index) {
	if(state==1 && index==super.getAttributeCount())
	return TRUE_VALUE;
	else
	return super.getAttributeValue(index);
	}

	public QName getAttributeName(int index) {
	if(state==1 && index==super.getAttributeCount())
	return new QName(AddressingVersion.W3C.nsUri, IS_REFERENCE_PARAMETER, "wsa");
	else
	return super.getAttributeName(index);
	}

	public String getAttributeValue(String namespaceUri, String localName) {
	if(state==1 && localName.equals(IS_REFERENCE_PARAMETER) && namespaceUri.equals(AddressingVersion.W3C.nsUri))
	return TRUE_VALUE;
	else
	return super.getAttributeValue(namespaceUri, localName);
	}
	};
	}

	public void writeTo(XMLStreamWriter w) throws XMLStreamException {
	infoset.writeToXMLStreamWriter(new XMLStreamWriterFilter(w) {
	private boolean root=true;

	public void writeStartElement(String localName) throws XMLStreamException {
	super.writeStartElement(localName);
	writeAddedAttribute();
	}

	private void writeAddedAttribute() throws XMLStreamException {
	if(!root) return;
	root=false;
	writeNamespace("wsa",AddressingVersion.W3C.nsUri);
	super.writeAttribute("wsa",AddressingVersion.W3C.nsUri,IS_REFERENCE_PARAMETER,TRUE_VALUE);
	}

	public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException {
	super.writeStartElement(namespaceURI, localName);
	writeAddedAttribute();
	}

	public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException {
	//TODO: Verify with KK later
	//check if prefix is declared before writing start element.
	boolean prefixDeclared = isPrefixDeclared(prefix,namespaceURI);
	super.writeStartElement(prefix, localName, namespaceURI);
	if(!prefixDeclared && !prefix.equals(""))
	super.writeNamespace(prefix,namespaceURI);
	writeAddedAttribute();
	}
	public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException{
	//TODO: Verify with KK later
	if(isPrefixDeclared(prefix, namespaceURI)) {
	//Dont write it again , as its already in NamespaceContext
	return;
	} else
	super.writeNamespace(prefix,namespaceURI);
	}

	private boolean isPrefixDeclared(String prefix, String namespaceURI ) {
	return namespaceURI.equals(getNamespaceContext().getNamespaceURI(prefix));
	}
	},true);
	}

	public void writeTo(SOAPMessage saaj) throws SOAPException {
	//TODO: SAAJ returns null instead of throwing SOAPException,
	// when there is no SOAPHeader in the message,
	// which leads to NPE.
	try {
	Element node = (Element)infoset.writeTo(saaj.getSOAPHeader());
	node.setAttributeNS(AddressingVersion.W3C.nsUri,AddressingVersion.W3C.getPrefix()+":"+IS_REFERENCE_PARAMETER,TRUE_VALUE);
	} catch (XMLStreamBufferException e) {
	throw new SOAPException(e);
	}
	}

	public void writeTo(ContentHandler contentHandler, ErrorHandler errorHandler) throws SAXException {
	class Filter extends XMLFilterImpl {
	Filter(ContentHandler ch) { setContentHandler(ch); }
	private int depth=0;
	public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
	if(depth++==0) {
	// add one more attribute
	super.startPrefixMapping("wsa",AddressingVersion.W3C.nsUri);
	AttributesImpl atts2 = new AttributesImpl(atts);
	atts2.addAttribute(
	AddressingVersion.W3C.nsUri,
	IS_REFERENCE_PARAMETER,
	"wsa:IsReferenceParameter",
	"CDATA",
	TRUE_VALUE);
	atts = atts2;
	}

	super.startElement(uri, localName, qName, atts);
	}

	public void endElement(String uri, String localName, String qName) throws SAXException {
	super.endElement(uri, localName, qName);
	if(--depth==0)
	super.endPrefixMapping("wsa");
	}
	}

	infoset.writeTo(new Filter(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";
	}