/*
* Copyright 2004,2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.axiom.om.impl.llom;
import org.apache.axiom.om.*;
import org.apache.axiom.om.impl.MTOMXMLStreamWriter;
import org.apache.axiom.om.impl.OMNamespaceImpl;
import org.apache.axiom.om.impl.mtom.MTOMStAXSOAPModelBuilder;
import org.apache.axiom.om.impl.util.OMSerializerUtil;
import org.apache.axiom.om.util.Base64;
import org.apache.axiom.om.util.UUIDGenerator;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import java.io.IOException;
import java.io.InputStream;
public class OMTextImpl extends OMNodeImpl implements OMText, OMConstants {
/**
* Field nameSpace used when serializing Binary stuff as MTOM optimized.
*/
public static final OMNamespace XOP_NS = new OMNamespaceImpl(
"http://www.w3.org/2004/08/xop/include", "xop");
protected String value = null;
protected char[] charArray;
protected OMNamespace textNS;
protected String mimeType;
protected boolean optimize = false;
protected boolean isBinary = false;
/**
* Field contentID for the mime part used when serializing Binary stuff as
* MTOM optimized.
*/
private String contentID = null;
/**
* Field dataHandler contains the DataHandler
* Declaring as Object to remove the dependency on
* Javax.activation.DataHandler
*/
private Object dataHandlerObject = null;
/**
* Field localName used when serializing Binary stuff as MTOM optimized.
*/
protected String localName = "Include";
/**
* Field attributes used when serializing Binary stuff as MTOM optimized.
*/
protected OMAttribute attribute;
private static final String EMTPY_STRING = "";
/**
* Constructor OMTextImpl.
*
* @param s
*/
public OMTextImpl(String s, OMFactory factory) {
this(s, TEXT_NODE, factory);
}
/**
* @param s
* @param nodeType - OMText can handle CHARACTERS, SPACES, CDATA and ENTITY REFERENCES.
* Constants for this can be found in OMNode.
*/
public OMTextImpl(String s, int nodeType, OMFactory factory) {
this(null, s, nodeType, factory);
}
/**
* Constructor OMTextImpl.
*
* @param parent
* @param text
*/
public OMTextImpl(OMContainer parent, String text, OMFactory factory) {
this(parent, text, TEXT_NODE, factory);
}
public OMTextImpl(OMContainer parent, String text, int nodeType,
OMFactory factory) {
super(parent, factory, true);
this.value = text == null ? EMTPY_STRING : text;
this.nodeType = nodeType;
}
public OMTextImpl(OMContainer parent, char[] charArray, int nodeType,
OMFactory factory) {
super(parent, factory, true);
this.charArray = charArray;
this.nodeType = nodeType;
}
public OMTextImpl(OMContainer parent, QName text, OMFactory factory) {
this(parent, text, TEXT_NODE, factory);
}
public OMTextImpl(OMContainer parent, QName text, int nodeType,
OMFactory factory) {
super(parent, factory, true);
this.textNS = ((OMElementImpl) parent).handleNamespace(text);
this.value = text == null ? EMTPY_STRING : text.getLocalPart();
this.nodeType = nodeType;
}
/**
* @param s - base64 encoded String representation of Binary
* @param mimeType of the Binary
*/
public OMTextImpl(String s, String mimeType, boolean optimize,
OMFactory factory) {
this(null, s, mimeType, optimize, factory);
}
/**
* @param parent
* @param s -
* base64 encoded String representation of Binary
* @param mimeType of the Binary
*/
public OMTextImpl(OMContainer parent, String s, String mimeType,
boolean optimize, OMFactory factory) {
this(parent, s, factory);
this.mimeType = mimeType;
this.optimize = optimize;
this.isBinary = true;
done = true;
this.nodeType = TEXT_NODE;
}
/**
* @param dataHandler To send binary optimised content Created programatically.
*/
public OMTextImpl(Object dataHandler, OMFactory factory) {
this(dataHandler, true, factory);
}
/**
* @param dataHandler
* @param optimize To send binary content. Created progrmatically.
*/
public OMTextImpl(Object dataHandler, boolean optimize, OMFactory factory) {
super(factory);
this.dataHandlerObject = dataHandler;
this.isBinary = true;
this.optimize = optimize;
done = true;
this.nodeType = TEXT_NODE;
}
/**
* @param contentID
* @param parent
* @param builder Used when the builder is encountered with a XOP:Include tag
* Stores a reference to the builder and the content-id. Supports
* deferred parsing of MIME messages.
*/
public OMTextImpl(String contentID, OMContainer parent,
OMXMLParserWrapper builder, OMFactory factory) {
super(parent, factory, false);
this.contentID = contentID;
this.optimize = true;
this.isBinary = true;
this.builder = builder;
this.nodeType = TEXT_NODE;
}
/**
* @param writer
* @throws XMLStreamException
*/
public void internalSerialize(XMLStreamWriter writer) throws XMLStreamException {
internalSerializeLocal(writer);
}
/**
* Writes the relevant output.
*
* @param writer
* @throws XMLStreamException
*/
private void writeOutput(XMLStreamWriter writer) throws XMLStreamException {
int type = getType();
if (type == TEXT_NODE || type == SPACE_NODE) {
writer.writeCharacters(this.getText());
} else if (type == CDATA_SECTION_NODE) {
writer.writeCData(this.getText());
} else if (type == ENTITY_REFERENCE_NODE) {
writer.writeEntityRef(this.getText());
}
}
/**
* Returns the value.
*/
public String getText() throws OMException {
if (textNS != null) {
return getTextString();
} else if (charArray != null || this.value != null) {
return getTextFromProperPlace();
} else {
try {
InputStream inStream;
inStream = this.getInputStream();
byte[] data;
StringBuffer text = new StringBuffer();
do {
data = new byte[1024];
int len;
while ((len = inStream.read(data)) > 0) {
byte[] temp = new byte[len];
System.arraycopy(data, 0, temp, 0, len);
text.append(Base64.encode(temp));
}
} while (inStream.available() > 0);
return text.toString();
} catch (Exception e) {
throw new OMException(e);
}
}
}
public char[] getTextCharacters() {
return charArray != null ? charArray : value.toCharArray();
}
public boolean isCharacters() {
return charArray != null;
}
/**
* This OMText contains two data source:value and charArray. This method will return text from
* correct place.
*/
private String getTextFromProperPlace() {
return charArray != null ? new String(charArray) : value;
}
/**
* Returns the value.
*/
public QName getTextAsQName() throws OMException {
if (textNS != null) {
String prefix = textNS.getPrefix();
String name = textNS.getNamespaceURI();
if (prefix == null || "".equals(prefix)) {
return new QName(name, getTextFromProperPlace());
} else {
return new QName(textNS.getNamespaceURI(), getTextFromProperPlace(), prefix);
}
} else if (this.value != null || charArray != null) {
return new QName(getTextFromProperPlace());
} else {
try {
InputStream inStream;
inStream = this.getInputStream();
byte[] data;
StringBuffer text = new StringBuffer();
do {
data = new byte[1024];
int len;
while ((len = inStream.read(data)) > 0) {
byte[] temp = new byte[len];
System.arraycopy(data, 0, temp, 0, len);
text.append(Base64.encode(temp));
}
} while (inStream.available() > 0);
return new QName(text.toString());
} catch (Exception e) {
throw new OMException(e);
}
}
}
/* (non-Javadoc)
* @see org.apache.axiom.om.OMText#getNamespace()
*/
public OMNamespace getNamespace() {
return textNS;
}
public boolean isOptimized() {
return optimize;
}
public void setOptimize(boolean value) {
this.optimize = value;
if (value) {
isBinary = true;
}
}
/**
* Receiving binary can happen as either MTOM attachments or as Base64 Text
* In the case of Base64 user has to explicitly specify that the content is
* binary, before calling getDataHandler(), getInputStream()....
*/
public void setBinary(boolean value) {
isBinary = value;
}
public boolean isBinary()
{
return isBinary;
}
/**
* Gets the datahandler.
*
* @return Returns javax.activation.DataHandler
*/
public Object getDataHandler() {
if ((value != null || charArray != null || textNS != null) & isBinary) {
String text = textNS == null ? getTextFromProperPlace() : getTextString();
return org.apache.axiom.attachments.utils.DataHandlerUtils.getDataHandlerFromText(text, mimeType);
} else {
if (dataHandlerObject == null) {
if (contentID == null) {
throw new RuntimeException("ContentID is null");
}
dataHandlerObject = ((MTOMStAXSOAPModelBuilder) builder)
.getDataHandler(contentID);
}
return dataHandlerObject;
}
}
private String getTextString() {
if (textNS != null) {
String prefix = textNS.getPrefix();
if (prefix == null || "".equals(prefix)) {
return getTextFromProperPlace();
} else {
return prefix + ":" + getTextFromProperPlace();
}
}
return null;
}
public String getLocalName() {
return localName;
}
public java.io.InputStream getInputStream() throws OMException {
if (isBinary) {
if (dataHandlerObject == null) {
getDataHandler();
}
InputStream inStream;
javax.activation.DataHandler dataHandler = (javax.activation.DataHandler) dataHandlerObject;
try {
inStream = dataHandler.getDataSource().getInputStream();
} catch (IOException e) {
throw new OMException(
"Cannot get InputStream from DataHandler." + e);
}
return inStream;
} else {
throw new OMException("Unsupported Operation");
}
}
public String getContentID() {
if (contentID == null) {
contentID = UUIDGenerator.getUUID()
+ "@apache.org";
}
return this.contentID;
}
public void internalSerializeAndConsume(XMLStreamWriter writer)
throws XMLStreamException {
internalSerializeLocal(writer);
}
private void internalSerializeLocal(XMLStreamWriter writer2) throws XMLStreamException {
if (!this.isBinary) {
writeOutput(writer2);
} else {
//check whether we have a MTOMXMLStreamWriter. if so
//we can optimize the writing!
if (writer2 instanceof MTOMXMLStreamWriter){
MTOMXMLStreamWriter writer = (MTOMXMLStreamWriter) writer2;
if (writer.isOptimized()) {
if (contentID == null) {
contentID = writer.getNextContentId();
}
// send binary as MTOM optimised
this.attribute = new OMAttributeImpl("href",
new OMNamespaceImpl("", ""), "cid:" + getContentID(), this.factory);
this.serializeStartpart(writer);
writer.writeOptimized(this);
writer.writeEndElement();
} else {
//do normal base64
writeOutput(writer);
}
}else{
//we do not have a optimized writer. Just do the normal
//base64 writing
writeOutput(writer2);
}
}
}
/*
* Methods to copy from OMSerialize utils
*/
private void serializeStartpart(XMLStreamWriter writer)
throws XMLStreamException {
String nameSpaceName = XOP_NS.getNamespaceURI();
String writer_prefix = writer.getPrefix(nameSpaceName);
String prefix = XOP_NS.getPrefix();
if (writer_prefix != null) {
writer.writeStartElement(nameSpaceName, this
.getLocalName());
} else {
// According to StAX, setPrefix must occur before
// writeStartElement
if (OMSerializerUtil.isSetPrefixBeforeStartElement(writer)) {
writer.setPrefix(prefix, nameSpaceName);
writer.writeStartElement(prefix, this.getLocalName(),
nameSpaceName);
} else {
writer.writeStartElement(prefix, this.getLocalName(),
nameSpaceName);
writer.setPrefix(prefix, nameSpaceName);
}
}
// add the elements attribute "href"
serializeAttribute(this.attribute, writer);
// add the namespace
serializeNamespace(XOP_NS, writer);
}
/**
* Method serializeAttribute.
*
* @param attr
* @throws XMLStreamException
*/
static void serializeAttribute(OMAttribute attr, XMLStreamWriter writer)
throws XMLStreamException {
// first check whether the attribute is associated with a namespace
OMNamespace ns = attr.getNamespace();
String prefix;
String namespaceName;
if (ns != null) {
// add the prefix if it's availble
prefix = ns.getPrefix();
namespaceName = ns.getNamespaceURI();
if (prefix != null) {
writer.writeAttribute(prefix, namespaceName, attr
.getLocalName(), attr.getAttributeValue());
} else {
writer.writeAttribute(namespaceName, attr.getLocalName(), attr
.getAttributeValue());
}
} else {
writer.writeAttribute(attr.getLocalName(), attr.getAttributeValue());
}
}
/**
* Method serializeNamespace.
*
* @param namespace
* @param writer
* @throws XMLStreamException
*/
static void serializeNamespace(OMNamespace namespace, XMLStreamWriter writer)
throws XMLStreamException {
if (namespace != null) {
String uri = namespace.getNamespaceURI();
String ns_prefix = namespace.getPrefix();
writer.writeNamespace(ns_prefix, namespace.getNamespaceURI());
writer.setPrefix(ns_prefix, uri);
}
}
/**
* A slightly different implementation of the discard method.
*
* @throws OMException
*/
public void discard() throws OMException {
if (done) {
this.detach();
} else {
builder.discard((OMElement) this.parent);
}
}
/* (non-Javadoc)
* @see org.apache.axiom.om.OMNode#buildAll()
*/
public void buildWithAttachments() {
if (!this.done) {
this.build();
}
if (isOptimized()) {
this.getDataHandler();
}
}
}