1 /*

     2  * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package com.sun.xml.internal.org.jvnet.staxex;

    27 

    28 import javax.xml.namespace.QName;

    29 import javax.xml.soap.SOAPException;

    30 import javax.xml.stream.XMLStreamException;

    31 import javax.xml.stream.XMLStreamReader;

    32 import javax.xml.stream.XMLStreamWriter;

    33 

    34 /**

    35  * A StAxSOAPBody is a SOAPBody that allows to be loaded from a StAX style payload.

    36  *

    37  * @author shih-chang.chen@oracle.com

    38  */

    39 public interface StAxSOAPBody {

    40 

    41     /**

    42      * The StAxSOAPBody represents the StAX source of SOAPBody payload.

    43      */

    44     public static interface Payload {

    45 

    46         /**

    47          * Retrieve payload qname without materializing its contents

    48          * @return

    49          * @throws SOAPException

    50          */

    51        public QName getPayloadQName();

    52 

    53        public XMLStreamReader readPayload() throws XMLStreamException;

    54 

    55        public void writePayloadTo(XMLStreamWriter writer)throws XMLStreamException;

    56 

    57        /**

    58         * Retrieve payload attribute value without materializing its contents

    59         * @param localName

    60         * @return

    61         * @throws SOAPException

    62         */

    63        public String getPayloadAttributeValue(String localName) throws XMLStreamException;

    64 

    65        /**

    66         * Retrieve payload attribute value without materializing its contents

    67         * @param qName

    68         * @return

    69         * @throws SOAPException

    70         */

    71        public String getPayloadAttributeValue(QName qName) throws XMLStreamException;

    72 

    73        public void materialize() throws SOAPException;

    74     }

    75 

    76     public void setPayload(Payload src) throws SOAPException;

    77 

    78     public Payload getPayload()throws SOAPException;

    79 

    80     public boolean hasStaxPayload();

    81  }