![[Jenkins]](/jaxb-impl/static/4136dced/images/svgs/logo.svg){kind=logo}
Package: XMLStreamReaderToXMLStreamWriter
XMLStreamReaderToXMLStreamWriter
| name | instruction | branch | complexity | line | method | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| XMLStreamReaderToXMLStreamWriter() |
|
|
|
|
|
||||||||||||||||||||
| bridge(XMLStreamReader, XMLStreamWriter) |
|
|
|
|
|
||||||||||||||||||||
| bridge(XMLStreamReader, XMLStreamWriter, XMLStreamReaderToXMLStreamWriter.Breakpoint) |
|
|
|
|
|
||||||||||||||||||||
| bridge(XMLStreamReaderToXMLStreamWriter.Breakpoint) |
|
|
|
|
|
||||||||||||||||||||
| fixNull(String) |
|
|
|
|
|
||||||||||||||||||||
| getEventType() |
|
|
|
|
|
||||||||||||||||||||
| getNextEvent() |
|
|
|
|
|
||||||||||||||||||||
| handleAttribute(int) |
|
|
|
|
|
||||||||||||||||||||
| handleCDATA() |
|
|
|
|
|
||||||||||||||||||||
| handleCharacters() |
|
|
|
|
|
||||||||||||||||||||
| handleComment() |
|
|
|
|
|
||||||||||||||||||||
| handleDTD() |
|
|
|
|
|
||||||||||||||||||||
| handleEndElement() |
|
|
|
|
|
||||||||||||||||||||
| handleEntityReference() |
|
|
|
|
|
||||||||||||||||||||
| handlePI() |
|
|
|
|
|
||||||||||||||||||||
| handleSpace() |
|
|
|
|
|
||||||||||||||||||||
| handleStartElement() |
|
|
|
|
|
||||||||||||||||||||
| static {...} |
|
|
|
|
|
||||||||||||||||||||
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 org.jvnet.staxex.util;
12:
13: import java.io.IOException;
14:
15: import jakarta.xml.bind.attachment.AttachmentMarshaller;
16: import javax.xml.stream.XMLStreamConstants;
17: import javax.xml.stream.XMLStreamException;
18: import javax.xml.stream.XMLStreamReader;
19: import javax.xml.stream.XMLStreamWriter;
20: import javax.xml.XMLConstants;
21:
22: import org.jvnet.staxex.Base64Data;
23: import org.jvnet.staxex.XMLStreamReaderEx;
24: import org.jvnet.staxex.XMLStreamWriterEx;
25:
26: /**
27: * Reads a sub-tree from {@link XMLStreamReader} and writes to {@link XMLStreamWriter}
28: * as-is.
29: *
30: * <p>
31: * This class can be sub-classed to implement a simple transformation logic.
32: *
33: * @author Kohsuke Kawaguchi
34: * @author Ryan Shoemaker
35: */
36: public class XMLStreamReaderToXMLStreamWriter {
37:
38: static public class Breakpoint {
39: protected XMLStreamReader reader;
40: protected XMLStreamWriter writer;
41:
42: public Breakpoint(XMLStreamReader r, XMLStreamWriter w) { reader = r; writer = w; }
43:
44: public XMLStreamReader reader() { return reader; }
45: public XMLStreamWriter writer() { return writer; }
46: public boolean proceedBeforeStartElement() { return true; }
47: public boolean proceedAfterStartElement() { return true; }
48: }
49:
50: private static final int BUF_SIZE = 4096;
51:
52: protected XMLStreamReader in;
53: protected XMLStreamWriter out;
54:
55: private char[] buf;
56:
57: boolean optimizeBase64Data = false;
58:
59: AttachmentMarshaller mtomAttachmentMarshaller;
60:
61: public XMLStreamReaderToXMLStreamWriter() {
62: super();
63: }
64:
65: /**
66: * Reads one subtree and writes it out.
67: *
68: * <p>
69: * The {@link XMLStreamWriter} never receives a start/end document event.
70: * Those need to be written separately by the caller.
71: * @throws javax.xml.stream.XMLStreamException
72: */
73: public void bridge(XMLStreamReader in, XMLStreamWriter out) throws XMLStreamException {
74: bridge(in, out, null);
75: }
76:
77: public void bridge(Breakpoint breakPoint) throws XMLStreamException {
78: bridge(breakPoint.reader(), breakPoint.writer(), breakPoint);
79: }
80:
81: private void bridge(XMLStreamReader in, XMLStreamWriter out, Breakpoint breakPoint) throws XMLStreamException {
82:• assert in!=null && out!=null;
83: this.in = in;
84: this.out = out;
85:
86: optimizeBase64Data = (in instanceof XMLStreamReaderEx);
87:
88:• if (out instanceof XMLStreamWriterEx && out instanceof MtomStreamWriter) {
89: mtomAttachmentMarshaller = ((MtomStreamWriter) out).getAttachmentMarshaller();
90: }
91: // remembers the nest level of elements to know when we are done.
92: int depth=0;
93:
94: buf = new char[BUF_SIZE];
95:
96: // if the parser is at the start tag, proceed to the first element
97: int event = getEventType();
98:
99:• if( event!=XMLStreamConstants.START_ELEMENT)
100: throw new IllegalStateException("The current event is not START_ELEMENT\n but " + event);
101:
102: do {
103: // These are all of the events listed in the javadoc for
104: // XMLEvent.
105: // The spec only really describes 11 of them.
106:• switch (event) {
107: case XMLStreamConstants.START_ELEMENT :
108:• if (breakPoint != null && !breakPoint.proceedBeforeStartElement()) return;
109: depth++;
110: handleStartElement();
111:• if (breakPoint != null && !breakPoint.proceedAfterStartElement()) return;
112: break;
113: case XMLStreamConstants.END_ELEMENT :
114: handleEndElement();
115: depth--;
116:• if(depth==0)
117: return;
118: break;
119: case XMLStreamConstants.CHARACTERS :
120: handleCharacters();
121: break;
122: case XMLStreamConstants.ENTITY_REFERENCE :
123: handleEntityReference();
124: break;
125: case XMLStreamConstants.PROCESSING_INSTRUCTION :
126: handlePI();
127: break;
128: case XMLStreamConstants.COMMENT :
129: handleComment();
130: break;
131: case XMLStreamConstants.DTD :
132: handleDTD();
133: break;
134: case XMLStreamConstants.CDATA :
135: handleCDATA();
136: break;
137: case XMLStreamConstants.SPACE :
138: handleSpace();
139: break;
140: case XMLStreamConstants.END_DOCUMENT:
141: throw new XMLStreamException("Malformed XML at depth="+depth+", Reached EOF. Event="+event);
142: default :
143: throw new XMLStreamException("Cannot process event: " + event);
144: }
145:
146: event=getNextEvent();
147:• } while (depth!=0);
148: }
149:
150: protected void handlePI() throws XMLStreamException {
151: out.writeProcessingInstruction(
152: in.getPITarget(),
153: in.getPIData());
154: }
155:
156:
157: protected void handleCharacters() throws XMLStreamException {
158:
159: CharSequence c = null;
160:
161:• if (optimizeBase64Data) {
162: c = ((XMLStreamReaderEx)in).getPCDATA();
163: }
164:
165:• if ((c != null) && (c instanceof Base64Data)) {
166:• if (mtomAttachmentMarshaller != null) {
167: Base64Data b64d = (Base64Data) c;
168: ((XMLStreamWriterEx)out).writeBinary(b64d.getDataHandler());
169: } else {
170: try {
171: ((Base64Data)c).writeTo(out);
172: } catch (IOException e) {
173: throw new XMLStreamException(e);
174: }
175: }
176: } else {
177:• for (int start=0,read=buf.length; read == buf.length; start+=buf.length) {
178: read = in.getTextCharacters(start, buf, 0, buf.length);
179: out.writeCharacters(buf, 0, read);
180: }
181: }
182: }
183:
184: protected void handleEndElement() throws XMLStreamException {
185: out.writeEndElement();
186: }
187:
188: protected void handleStartElement() throws XMLStreamException {
189: String nsUri = in.getNamespaceURI();
190:• if(nsUri==null)
191: out.writeStartElement(in.getLocalName());
192: else
193: out.writeStartElement(
194: fixNull(in.getPrefix()),
195: in.getLocalName(),
196: nsUri
197: );
198:
199: // start namespace bindings
200: int nsCount = in.getNamespaceCount();
201:• for (int i = 0; i < nsCount; i++) {
202: out.writeNamespace(
203: fixNull(in.getNamespacePrefix(i)), //StAX reader will return null for default NS
204: fixNull(in.getNamespaceURI(i))); // zephyr doesn't like null, I don't know what is correct, so just fix null to "" for now
205: }
206:
207: // write attributes
208: int attCount = in.getAttributeCount();
209:• for (int i = 0; i < attCount; i++) {
210: handleAttribute(i);
211: }
212: }
213:
214: /**
215: * Writes out the {@code i}-th attribute of the current element.
216: *
217: * <p>
218: * Used from {@link #handleStartElement()}.
219: * @throws javax.xml.stream.XMLStreamException
220: */
221: protected void handleAttribute(int i) throws XMLStreamException {
222: String nsUri = in.getAttributeNamespace(i);
223: String prefix = in.getAttributePrefix(i);
224:• if (fixNull(nsUri).equals(XMLConstants.XMLNS_ATTRIBUTE_NS_URI)) {
225: //Its a namespace decl, ignore as it is already written.
226: return;
227: }
228:
229:• if(nsUri==null || prefix == null || prefix.equals("")) {
230: out.writeAttribute(
231: in.getAttributeLocalName(i),
232: in.getAttributeValue(i)
233: );
234: } else {
235: out.writeAttribute(
236: prefix,
237: nsUri,
238: in.getAttributeLocalName(i),
239: in.getAttributeValue(i)
240: );
241: }
242: }
243:
244: protected void handleDTD() throws XMLStreamException {
245: out.writeDTD(in.getText());
246: }
247:
248: protected void handleComment() throws XMLStreamException {
249: out.writeComment(in.getText());
250: }
251:
252: protected void handleEntityReference() throws XMLStreamException {
253: out.writeEntityRef(in.getText());
254: }
255:
256: protected void handleSpace() throws XMLStreamException {
257: handleCharacters();
258: }
259:
260: protected void handleCDATA() throws XMLStreamException {
261: out.writeCData(in.getText());
262: }
263:
264: private static String fixNull(String s) {
265:• if(s==null) return "";
266: else return s;
267: }
268:
269: private int getEventType() throws XMLStreamException {
270: int event = in.getEventType();
271: // if the parser is at the start tag, proceed to the first element
272: //Note - need to do this every time because we could be using a composite reader
273:• if(event == XMLStreamConstants.START_DOCUMENT) {
274: // nextTag doesn't correctly handle DTDs
275:• while( !in.isStartElement() ) {
276: event = in.next();
277:• if (event == XMLStreamConstants.COMMENT)
278: handleComment();
279: }
280: }
281: return event;
282: }
283:
284: private int getNextEvent() throws XMLStreamException {
285: in.next();
286: return getEventType();
287: }
288: }