Package: LazyEnvelope

LazyEnvelope

Coverage

1: /*
2: * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
3: *
4: * This program and the accompanying materials are made available under the
5: * terms of the Eclipse Distribution License v. 1.0, which is available at
6: * http://www.eclipse.org/org/documents/edl-v10.php.
7: *
8: * SPDX-License-Identifier: BSD-3-Clause
9: */
10:
11: package com.sun.xml.messaging.saaj.soap;
12:
13: import javax.xml.namespace.QName;
14: import jakarta.xml.soap.SOAPException;
15: import javax.xml.stream.XMLStreamException;
16: import javax.xml.stream.XMLStreamReader;
17: import javax.xml.stream.XMLStreamWriter;
18:
19: public interface LazyEnvelope extends Envelope {
20: public XMLStreamReader getPayloadReader() throws SOAPException;
21: public boolean isLazy();
22: public void writeTo(XMLStreamWriter writer) throws XMLStreamException, SOAPException;
23:
24: /**
25: * Retrieve payload qname without materializing its contents
26: * @return QName
27: * @throws SOAPException in case of an error
28: */
29: public QName getPayloadQName() throws SOAPException;
30:
31: /**
32: * Retrieve payload attribute value without materializing its contents
33: * @param localName local name
34: * @return payload attribute value
35: * @throws SOAPException in case of an error
36: */
37: public String getPayloadAttributeValue(String localName) throws SOAPException;
38:
39: /**
40: * Retrieve payload attribute value without materializing its contents
41: * @param qName QName
42: * @return payload attribute value
43: * @throws SOAPException in case of an error
44: */
45: public String getPayloadAttributeValue(QName qName) throws SOAPException;
46: }