blob: 1f49ce33e11d8b354aa1c6722d0a48aee2d9ec68 [file] [log] [blame]
/*
* Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
package com.sun.xml.internal.org.jvnet.staxex;
import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.io.InputStream;
import java.io.IOException;
import java.io.ByteArrayInputStream;
import java.io.OutputStream;
/**
* Binary data represented as base64-encoded string
* in XML.
*
* <p>
* Used in conjunction with {@link XMLStreamReaderEx}
* and {@link XMLStreamWriterEx}.
*
* @author Kohsuke Kawaguchi
*/
public class Base64Data implements CharSequence, Cloneable {
// either dataHandler or (data,dataLen,mimeType?) must be present
private DataHandler dataHandler;
private byte[] data;
/**
* 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() {
}
/**
* Clone constructor
*/
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 len
* data[0] to data[len-1] are treated as the data.
* @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 len
* data[0] to data[len-1] are treated as the data.
*/
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.
*/
public void set(byte[] data,String mimeType) {
set(data,data.length,mimeType,false);
}
/**
* Fills in the data object by a {@link DataHandler}.
*/
public void set(DataHandler data) {
assert data!=null;
this.dataHandler = data;
this.data = null;
}
/**
* Gets the raw data.
*/
public DataHandler getDataHandler() {
if(dataHandler==null){
dataHandler = new DataHandler(new 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();
}
});
}
return dataHandler;
}
/**
* Gets the byte[] of the exact length.
*/
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}.
*/
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.
*/
public boolean hasData() {
return data!=null;
}
/**
* Gets the raw data. The size of the byte array maybe larger than the actual length.
*/
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;
}
public int getDataLen() {
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<dataLen)
b1 = data[base+1];
else
b1 = 0;
return Base64Encoder.encode(
((data[base]&0x3)<<4) |
((b1>>4)&0xF));
case 2:
if(base+1<dataLen) {
b1 = data[base+1];
if(base+2<dataLen)
b2 = data[base+2];
else
b2 = 0;
return Base64Encoder.encode(
((b1&0xF)<<2)|
((b2>>6)&0x3));
} else
return '=';
case 3:
if(base+2<dataLen)
return Base64Encoder.encode(data[base+2]&0x3F);
else
return '=';
}
throw new IllegalStateException();
}
/**
* Internally this is only used to split a text to a list,
* which doesn't happen that much for base64.
* So this method should be smaller than faster.
*/
public CharSequence subSequence(int start, int end) {
StringBuilder buf = new StringBuilder();
get(); // fill in the buffer if we haven't done so
for( int i=start; i<end; i++ )
buf.append(charAt(i));
return buf;
}
/**
* Returns the base64 encoded string of this data.
*/
public String toString() {
get(); // fill in the buffer
return Base64Encoder.print(data, 0, dataLen);
}
public void writeTo(char[] buf, int start) {
get();
Base64Encoder.print(data, 0, dataLen, buf, start);
}
public Base64Data clone() {
return new Base64Data(this);
}
}