1 /*
   2  * Copyright (c) 2005, 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.messaging.saaj.soap;
  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 public interface LazyEnvelope extends Envelope {
  35     public XMLStreamReader getPayloadReader() throws SOAPException;
  36     public boolean isLazy();
  37     public void writeTo(XMLStreamWriter writer) throws XMLStreamException, SOAPException;
  38 
  39     /**
  40      * Retrieve payload qname without materializing its contents
  41      * @return
  42      * @throws SOAPException
  43      */
  44     public QName getPayloadQName() throws SOAPException;
  45 
  46     /**
  47      * Retrieve payload attribute value without materializing its contents
  48      * @param localName
  49      * @return
  50      * @throws SOAPException
  51      */
  52     public String getPayloadAttributeValue(String localName) throws SOAPException;
  53 
  54     /**
  55      * Retrieve payload attribute value without materializing its contents
  56      * @param qName
  57      * @return
  58      * @throws SOAPException
  59      */
  60     public String getPayloadAttributeValue(QName qName) throws SOAPException;
  61 }