org.apache.axiom.om.impl.intf.TextContent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of om-mixins Show documentation
Contains mixins and implementation classes shared by LLOM and DOOM.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.intf;

import java.io.IOException;

import org.apache.axiom.blob.Blob;
import org.apache.axiom.blob.Blobs;
import org.apache.axiom.core.ClonePolicy;
import org.apache.axiom.core.CloneableCharacterData;
import org.apache.axiom.core.stream.CharacterData;
import org.apache.axiom.core.stream.CharacterDataSink;
import org.apache.axiom.ext.stax.BlobProvider;
import org.apache.axiom.mime.PartBlob;
import org.apache.axiom.om.OMCloneOptions;
import org.apache.axiom.om.OMException;
import org.apache.axiom.util.UIDGenerator;
import org.apache.axiom.util.base64.AbstractBase64EncodingOutputStream;
import org.apache.axiom.util.base64.Base64EncodingStringBufferOutputStream;
import org.apache.axiom.util.base64.Base64Utils;

public final class TextContent implements CloneableCharacterData {
    private final String value;

    /** Field contentID for the mime part used when serializing Binary stuff as MTOM optimized. */
    private String contentID;

    /**
     * Contains a {@link Blob} or {@link BlobProvider} object if the text node represents base64
     * encoded binary data.
     */
    private Object blobObject;

    private boolean optimize;
    private boolean binary;

    public TextContent(String value) {
        this.value = value;
    }

    public TextContent(String contentID, Object blobObject, boolean optimize) {
        this.value = null;
        this.contentID = contentID;
        this.blobObject = blobObject;
        binary = true;
        this.optimize = optimize;
    }

    private TextContent(TextContent other) {
        this.value = other.value;
        this.contentID = other.contentID;
        this.blobObject = other.blobObject;
        this.optimize = other.optimize;
        this.binary = other.binary;
    }

    public boolean isOptimize() {
        return optimize;
    }

    public void setOptimize(boolean optimize) {
        this.optimize = optimize;
        if (optimize) {
            binary = true;
        }
    }

    public boolean isBinary() {
        return binary;
    }

    public void setBinary(boolean binary) {
        this.binary = binary;
    }

    public String getContentID() {
        if (contentID == null) {
            contentID = UIDGenerator.generateContentId();
        }
        return contentID;
    }

    public void setContentID(String contentID) {
        this.contentID = contentID;
    }

    /**
     * Returns the base64 decoded content. Can only be used if {@link #isBinary()} returns {@code
     * true}.
     *
     * @return a {@link Blob} or {@link BlobProvider} object for the base64 decoded content
     */
    public Object getBlobObject() {
        if (!binary) {
            throw new IllegalStateException();
        }
        if (blobObject != null) {
            return blobObject;
        }
        return Blobs.createBlob(Base64Utils.decode(value));
    }

    /**
     * Returns a {@link Blob} with the base64 decoded content. Can only be used if {@link
     * #isBinary()} returns {@code true}.
     *
     * @return a {@link Blob} object for the base64 decoded content
     */
    public Blob getBlob() {
        Object blobObject = getBlobObject();
        if (blobObject instanceof BlobProvider) {
            try {
                return ((BlobProvider) blobObject).getBlob();
            } catch (IOException ex) {
                throw new OMException(ex);
            }
        }
        return (Blob) blobObject;
    }

    @Override
    public String toString() {
        if (blobObject != null) {
            try {
                return Base64Utils.encode(getBlob());
            } catch (Exception e) {
                throw new OMException(e);
            }
        } else {
            return value;
        }
    }

    public char[] toCharArray() {
        if (blobObject != null) {
            try {
                return Base64Utils.encodeToCharArray(getBlob());
            } catch (IOException ex) {
                throw new OMException(ex);
            }
        } else {
            return value.toCharArray();
        }
    }

    @Override
    public  CharacterData clone(ClonePolicy policy, T options) {
        if (binary
                && options instanceof OMCloneOptions
                && ((OMCloneOptions) options).isFetchBlobs()) {
            // This will fetch the Blob from the BlobProvider if applicable.
            Blob blob = getBlob();
            // If the blob refers to a MIME part of an XOP encoded message, ensure that the part is
            // fetched.
            if (blob instanceof PartBlob) {
                ((PartBlob) blob).getPart().fetch();
            }
        }
        return new TextContent(this);
    }

    @Override
    public void writeTo(CharacterDataSink sink) throws IOException {
        if (binary) {
            AbstractBase64EncodingOutputStream out = sink.getBase64EncodingOutputStream();
            getBlob().writeTo(out);
            out.complete();
        } else {
            // TODO: there must be a better way to just write a String
            sink.getWriter().write(value);
        }
    }

    @Override
    public void appendTo(StringBuilder buffer) {
        if (binary) {
            Base64EncodingStringBufferOutputStream out =
                    new Base64EncodingStringBufferOutputStream(buffer);
            try {
                getBlob().writeTo(out);
                out.complete();
            } catch (IOException ex) {
                throw new OMException(ex);
            }
        } else {
            buffer.append(value);
        }
    }
}