com.strato.hidrive.api.utils.multipart.StringPart.java Source code

Introduction

Here is the source code for com.strato.hidrive.api.utils.multipart.StringPart.java

Source

/**
* Copyright 2014 STRATO AG
* 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 com.strato.hidrive.api.utils.multipart;

import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;

import org.apache.http.protocol.HTTP;

import com.strato.hidrive.api.utils.multipart.helper.UrlEncodingHelper;

public final class StringPart extends BasePart {

    private final byte[] valueBytes;

    /**
     * @param name
     *            String - name of parameter (may not be <code>null</code>).
     * @param value
     *            String - value of parameter (may not be <code>null</code>).
     * @param charset
     *            String, if null is passed then default "ISO-8859-1" charset is
     *            used.
     * 
     * @throws IllegalArgumentException
     *             if either <code>value</code> or <code>name</code> is
     *             <code>null</code>.
     * @throws RuntimeException
     *             if <code>charset</code> is unsupported by OS.
     */
    public StringPart(String name, String value, String charset) {
        if (name == null) {
            throw new IllegalArgumentException("Name may not be null"); //$NON-NLS-1$
        }
        if (value == null) {
            throw new IllegalArgumentException("Value may not be null"); //$NON-NLS-1$
        }

        final String partName = UrlEncodingHelper.encode(name, HTTP.DEFAULT_PROTOCOL_CHARSET);

        if (charset == null) {
            charset = HTTP.DEFAULT_CONTENT_CHARSET;
        }
        final String partCharset = charset;

        try {
            this.valueBytes = value.getBytes(partCharset);
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }

        headersProvider = new IHeadersProvider() {
            public String getContentDisposition() {
                return "Content-Disposition: form-data; name=\"" + partName + '"'; //$NON-NLS-1$
            }

            public String getContentType() {
                return "Content-Type: " + HTTP.PLAIN_TEXT_TYPE + HTTP.CHARSET_PARAM + partCharset; //$NON-NLS-1$
            }

            public String getContentTransferEncoding() {
                return "Content-Transfer-Encoding: 8bit"; //$NON-NLS-1$
            }
        };
    }

    /**
     * Default "ISO-8859-1" charset is used.
     * 
     * @param name
     *            String - name of parameter (may not be <code>null</code>).
     * @param value
     *            String - value of parameter (may not be <code>null</code>).
     * 
     * @throws IllegalArgumentException
     *             if either <code>value</code> or <code>name</code> is
     *             <code>null</code>.
     */
    public StringPart(String name, String value) {
        this(name, value, null);
    }

    public long getContentLength(Boundary boundary) {
        return getHeader(boundary).length + valueBytes.length + CRLF.length;
    }

    public void writeTo(final OutputStream out, Boundary boundary) throws IOException {
        out.write(getHeader(boundary));
        out.write(valueBytes);
        out.write(CRLF);
    }
}