org.jvnet.staxex.StAxSOAPBody Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webservices-rt Show documentation
This module contains the Metro runtime code.
There is a newer version: 4.0.4
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2013-2014 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 org.jvnet.staxex;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;

/**
 * A StAxSOAPBody is a SOAPBody that allows to be loaded from a StAX style payload.
 * 
 * @author [email protected]
 */
public interface StAxSOAPBody {
    
    /**
     * The StAxSOAPBody represents the StAX source of SOAPBody payload.
     */
    public static interface Payload {
        
        /**
         * Retrieve payload qname without materializing its contents
         * @return
         */
       public QName getPayloadQName();   
       
       public XMLStreamReader readPayload() throws XMLStreamException;
       
       public void writePayloadTo(XMLStreamWriter writer)throws XMLStreamException;

       /**
        * Retrieve payload attribute value without materializing its contents
        * @param localName
        * @return
        * @throws XMLStreamException
        */
       public String getPayloadAttributeValue(String localName) throws XMLStreamException;   

       /**
        * Retrieve payload attribute value without materializing its contents
        * @param qName
        * @return
        * @throws XMLStreamException
        */
       public String getPayloadAttributeValue(QName qName) throws XMLStreamException;
       
       public void materialize() throws XMLStreamException;
    }
    
    public void setPayload(Payload src) throws XMLStreamException;
    
    public Payload getPayload()throws XMLStreamException;
    
    public boolean hasStaxPayload();
 }