org.jvnet.staxex.Base64Data Maven / Gradle / Ivy
Show all versions of stax-ex Show documentation
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.jvnet.staxex;
import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
// for testing method
//import com.sun.xml.stream.writers.XMLStreamWriterImpl;
//import java.io.FileNotFoundException;
//import java.io.FileWriter;
//import javax.activation.FileDataSource;
/**
* Binary data represented as base64-encoded string
* in XML.
*
*
* Used in conjunction with {@link XMLStreamReaderEx}
* and {@link XMLStreamWriterEx}.
*
* @author Kohsuke Kawaguchi, Martin Grebac
*/
public class Base64Data implements CharSequence, Cloneable {
// either dataHandler or (data,dataLen,mimeType?) must be present
// (note that having both is allowed)
private DataHandler dataHandler;
private byte[] data;
private String hrefCid;
/**
* Length of the valid data in {@link #data}.
*/
private int dataLen;
/**
* True if {@link #data} can be cloned by reference
* if Base64Data instance is cloned.
*/
private boolean dataCloneByRef;
/**
* Optional MIME type of {@link #data}.
*
* Unused when {@link #dataHandler} is set.
* Use {@link DataHandler#getContentType()} in that case.
*/
private String mimeType;
/**
* Default constructor
*/
public Base64Data() {
}
private static final Logger logger = Logger.getLogger(Base64Data.class.getName());
/**
* Clone constructor
* @param that needs to be cloned
*/
public Base64Data(Base64Data that) {
that.get();
if (that.dataCloneByRef) {
this.data = that.data;
} else {
this.data = new byte[that.dataLen];
System.arraycopy(that.data, 0, this.data, 0, that.dataLen);
}
this.dataCloneByRef = true;
this.dataLen = that.dataLen;
this.dataHandler = null;
this.mimeType = that.mimeType;
}
/**
* Fills in the data object by a portion of the byte[].
*
* @param data actual data
* @param len
* data[0] to data[len-1] are treated as the data.
* @param mimeType MIME type
* @param cloneByRef
* true if data[] can be cloned by reference
*/
public void set(byte[] data, int len, String mimeType, boolean cloneByRef) {
this.data = data;
this.dataLen = len;
this.dataCloneByRef = cloneByRef;
this.dataHandler = null;
this.mimeType = mimeType;
}
/**
* Fills in the data object by a portion of the byte[].
*
* @param data actual data bytes
* @param len
* data[0] to data[len-1] are treated as the data.
* @param mimeType MIME type
*/
public void set(byte[] data, int len, String mimeType) {
set(data,len,mimeType,false);
}
/**
* Fills in the data object by the byte[] of the exact length.
*
* @param data
* this buffer may be owned directly by the unmarshaleld JAXB object.
* @param mimeType MIME type
*/
public void set(byte[] data,String mimeType) {
set(data,data.length,mimeType,false);
}
/**
* Fills in the data object by a {@link DataHandler}.
*
* @param data DataHandler for the data
*/
public void set(DataHandler data) {
assert data!=null;
this.dataHandler = data;
this.data = null;
}
/**
* Gets the raw data. If the returned DataHandler is {@link StreamingDataHandler},
* callees may need to downcast to take advantage of its capabilities.
*
* @see StreamingDataHandler
* @return DataHandler for the data
*/
public DataHandler getDataHandler() {
if(dataHandler==null){
dataHandler = new Base64StreamingDataHandler(new Base64DataSource());
} else if (!(dataHandler instanceof StreamingDataHandler)) {
dataHandler = new FilterDataHandler(dataHandler);
}
return dataHandler;
}
private final class Base64DataSource implements DataSource {
public String getContentType() {
return getMimeType();
}
public InputStream getInputStream() {
return new ByteArrayInputStream(data,0,dataLen);
}
public String getName() {
return null;
}
public OutputStream getOutputStream() {
throw new UnsupportedOperationException();
}
}
private final class Base64StreamingDataHandler extends StreamingDataHandler {
Base64StreamingDataHandler(DataSource source) {
super(source);
}
public InputStream readOnce() throws IOException {
return getDataSource().getInputStream();
}
public void moveTo(File dst) throws IOException {
FileOutputStream fout = new FileOutputStream(dst);
try {
fout.write(data, 0, dataLen);
} finally {
fout.close();
}
}
public void close() throws IOException {
// nothing to do
}
}
private static final class FilterDataHandler extends StreamingDataHandler {
FilterDataHandler(DataHandler dh) {
super(dh.getDataSource());
}
public InputStream readOnce() throws IOException {
return getDataSource().getInputStream();
}
public void moveTo(File dst) throws IOException {
byte[] buf = new byte[8192];
InputStream in = null;
OutputStream out = null;
try {
in = getDataSource().getInputStream();
out = new FileOutputStream(dst);
while (true) {
int amountRead = in.read(buf);
if (amountRead == -1) {
break;
}
out.write(buf, 0, amountRead);
}
} finally {
if (in != null) {
try {
in.close();
} catch(IOException ioe) {
// nothing to do
}
}
if (out != null) {
try {
out.close();
} catch(IOException ioe) {
// nothing to do
}
}
}
}
public void close() throws IOException {
// nothing to do
}
}
/**
* Gets the byte[] of the exact length.
*
* @return byte[] for data
*/
public byte[] getExact() {
get();
if(dataLen!=data.length) {
byte[] buf = new byte[dataLen];
System.arraycopy(data,0,buf,0,dataLen);
data = buf;
}
return data;
}
/**
* Gets the data as an {@link InputStream}.
*
* @return data as InputStream
* @throws IOException if i/o error occurs
*/
public InputStream getInputStream() throws IOException {
if(dataHandler!=null) {
return dataHandler.getInputStream();
} else {
return new ByteArrayInputStream(data,0,dataLen);
}
}
/**
* Returns false if this object only has {@link DataHandler} and therefore
* {@link #get()} operation is likely going to be expensive.
*
* @return false if it has only DataHandler
*/
public boolean hasData() {
return data!=null;
}
/**
* Gets the raw data. The size of the byte array maybe larger than the actual length.
*
* @return data as byte[], the array may be larger
*/
public byte[] get() {
if(data==null) {
try {
ByteArrayOutputStreamEx baos = new ByteArrayOutputStreamEx(1024);
InputStream is = dataHandler.getDataSource().getInputStream();
baos.readFrom(is);
is.close();
data = baos.getBuffer();
dataLen = baos.size();
dataCloneByRef = true;
} catch (IOException e) {
// TODO: report the error to the unmarshaller
dataLen = 0; // recover by assuming length-0 data
}
}
return data;
}
/**
* Gets the length of the binary data counted in bytes.
*
* Note that if this object encapsulates {@link DataHandler},
* this method would have to read the whole thing into {@code byte[]}
* just to count the length, because {@link DataHandler}
* doesn't easily expose the length.
*
* @return no of bytes
*/
public int getDataLen() {
get();
return dataLen;
}
public String getMimeType() {
if (mimeType==null) {
return "application/octet-stream";
}
return mimeType;
}
/**
* Gets the number of characters needed to represent
* this binary data in the base64 encoding.
*/
public int length() {
// for each 3 bytes you use 4 chars
// if the remainder is 1 or 2 there will be 4 more
get(); // fill in the buffer if necessary
return ((dataLen+2)/3)*4;
}
/**
* Encode this binary data in the base64 encoding
* and returns the character at the specified position.
*/
public char charAt(int index) {
// we assume that the length() method is called before this method
// (otherwise how would the caller know that the index is valid?)
// so we assume that the byte[] is already populated
int offset = index%4;
int base = (index/4)*3;
byte b1,b2;
switch(offset) {
case 0:
return Base64Encoder.encode(data[base]>>2);
case 1:
if (base+1>4)&0xF));
case 2:
if (base+1>6)&0x3));
} else {
return '=';
}
case 3:
if(base+2