1/* 2 * Copyright (c) 2013, 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 26package com.sun.xml.internal.org.jvnet.staxex; 27 28import javax.xml.namespace.QName; 29import javax.xml.stream.XMLStreamException; 30import javax.xml.stream.XMLStreamReader; 31import javax.xml.stream.XMLStreamWriter; 32 33/** 34 * A StAxSOAPBody is a SOAPBody that allows to be loaded from a StAX style payload. 35 * 36 * @author shih-chang.chen@oracle.com 37 */ 38public interface StAxSOAPBody { 39 40 /** 41 * The StAxSOAPBody represents the StAX source of SOAPBody payload. 42 */ 43 public static interface Payload { 44 45 /** 46 * Retrieve payload qname without materializing its contents 47 * @return 48 */ 49 public QName getPayloadQName(); 50 51 public XMLStreamReader readPayload() throws XMLStreamException; 52 53 public void writePayloadTo(XMLStreamWriter writer)throws XMLStreamException; 54 55 /** 56 * Retrieve payload attribute value without materializing its contents 57 * @param localName 58 * @return 59 * @throws XMLStreamException 60 */ 61 public String getPayloadAttributeValue(String localName) throws XMLStreamException; 62 63 /** 64 * Retrieve payload attribute value without materializing its contents 65 * @param qName 66 * @return 67 * @throws XMLStreamException 68 */ 69 public String getPayloadAttributeValue(QName qName) throws XMLStreamException; 70 71 public void materialize() throws XMLStreamException; 72 } 73 74 public void setPayload(Payload src) throws XMLStreamException; 75 76 public Payload getPayload()throws XMLStreamException; 77 78 public boolean hasStaxPayload(); 79 } 80