jaxws/src/java.xml.ws/share/classes/com/sun/xml/internal/messaging/saaj/soap/LazyEnvelope.java
author aefimov
Thu, 16 Feb 2017 13:14:39 +0300
changeset 43852 93a527059d8a
parent 28326 2b9860c0d68a
permissions -rw-r--r--
8174735: Update JAX-WS RI integration to latest version Reviewed-by: alanb, mchung, lancea Contributed-by: roman.grigoriadi@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
23782
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
     1
/*
43852
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
     2
 * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
23782
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
     4
 *
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    10
 *
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    15
 * accompanied this code).
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    16
 *
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    20
 *
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    23
 * questions.
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    24
 */
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    25
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    26
package com.sun.xml.internal.messaging.saaj.soap;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    27
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    28
import javax.xml.namespace.QName;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    29
import javax.xml.soap.SOAPException;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    30
import javax.xml.stream.XMLStreamException;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    31
import javax.xml.stream.XMLStreamReader;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    32
import javax.xml.stream.XMLStreamWriter;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    33
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    34
public interface LazyEnvelope extends Envelope {
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    35
    public XMLStreamReader getPayloadReader() throws SOAPException;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    36
    public boolean isLazy();
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    37
    public void writeTo(XMLStreamWriter writer) throws XMLStreamException, SOAPException;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    38
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    39
    /**
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    40
     * Retrieve payload qname without materializing its contents
43852
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
    41
     * @return QName
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
    42
     * @throws SOAPException in case of an error
23782
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    43
     */
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    44
    public QName getPayloadQName() throws SOAPException;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    45
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    46
    /**
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    47
     * Retrieve payload attribute value without materializing its contents
43852
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
    48
     * @param localName local name
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
    49
     * @return payload attribute value
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
    50
     * @throws SOAPException in case of an error
23782
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    51
     */
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    52
    public String getPayloadAttributeValue(String localName) throws SOAPException;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    53
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    54
    /**
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    55
     * Retrieve payload attribute value without materializing its contents
43852
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
    56
     * @param qName QName
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
    57
     * @return payload attribute value
93a527059d8a 8174735: Update JAX-WS RI integration to latest version
aefimov
parents: 28326
diff changeset
    58
     * @throws SOAPException in case of an error
23782
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    59
     */
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    60
    public String getPayloadAttributeValue(QName qName) throws SOAPException;
953bfc3fbe31 8036030: Update JAX-WS RI integration to latest version
mkos
parents:
diff changeset
    61
}