com.jkoolcloud.jesl.net.http.apache.HttpMessageUtils.java Source code

Introduction

Here is the source code for com.jkoolcloud.jesl.net.http.apache.HttpMessageUtils.java

Source

/*
 * Copyright 2015 JKOOL, LLC.
 *
 * 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.jkoolcloud.jesl.net.http.apache;

import java.io.IOException;

import org.apache.commons.lang3.StringUtils;
import org.apache.http.HttpEntity;
import org.apache.http.HttpEntityEnclosingRequest;
import org.apache.http.HttpHeaders;
import org.apache.http.HttpMessage;
import org.apache.http.HttpResponse;
import org.apache.http.entity.ByteArrayEntity;
import org.apache.http.util.EntityUtils;

/**
 * JESL HTTP common message utilities class
 *
 * @version $Revision: 1 $
 */
public class HttpMessageUtils {
    /**
     * Obtain entity object which is sent/received over HTTP.
     *
     * @param message HTTP message
     * @return HTTP entity object
     */
    protected static HttpEntity getEntity(HttpMessage message) {
        if (message instanceof HttpEntityEnclosingRequest)
            return ((HttpEntityEnclosingRequest) message).getEntity();
        if (message instanceof HttpResponse)
            return ((HttpResponse) message).getEntity();
        return null;
    }

    /**
     * Set entity object which are sent/received over HTTP.
     *
     * @param message HTTP message
     * @param entity HTTP entity object
     */
    protected static void setEntity(HttpMessage message, HttpEntity entity) {
        if (message instanceof HttpEntityEnclosingRequest)
            ((HttpEntityEnclosingRequest) message).setEntity(entity);
        else if (message instanceof HttpResponse)
            ((HttpResponse) message).setEntity(entity);
    }

    /**
     * True if HTTP message has content
     *
     * @param message HTTP message
     * @return true if HTTP message has content, false otherwise
     */
    public static boolean hasContent(HttpMessage message) {
        return (getEntity(message) != null);
    }

    /**
     * Obtain content from HTTP message
     *
     * @param message HTTP message
     * @return bytes associated with HTTP content
     * @throws IOException if error reading message content
     */
    public static byte[] getContentBytes(HttpMessage message) throws IOException {
        HttpEntity entity = getEntity(message);
        if (entity == null)
            return null;
        return EntityUtils.toByteArray(entity);
    }

    /**
     * Obtain content from HTTP message
     *
     * @param message HTTP message
     * @return string associated with HTTP content
     * @throws IOException if error reading message content
     */
    public static String getContentString(HttpMessage message) throws IOException {
        HttpEntity entity = getEntity(message);
        if (entity == null)
            return null;
        return EntityUtils.toString(entity);
    }

    /**
     * Obtain content from HTTP message
     *
     * @param message HTTP message
     * @param charset target character set
     * @return string associated with HTTP content in the specified character set
     * @throws IOException if error reading message content
     */
    public static String getContentString(HttpMessage message, String charset) throws IOException {
        HttpEntity entity = getEntity(message);
        if (entity == null)
            return null;
        return EntityUtils.toString(entity, charset);
    }

    /**
     * Set HTTP message content
     *
     * @param message HTTP message
     * @param contentType contentType
     * @param content content bytes
     * @param contentEncoding content encoding
     * @throws IOException if error writing message content
     */
    public static void setContent(HttpMessage message, String contentType, byte[] content, String contentEncoding)
            throws IOException {
        ByteArrayEntity httpContent = new ByteArrayEntity(content);
        if (!StringUtils.isEmpty(contentEncoding))
            httpContent.setContentEncoding(contentEncoding);
        message.addHeader(HttpHeaders.CONTENT_LENGTH, String.valueOf(httpContent.getContentLength()));
        if (!StringUtils.isEmpty(contentType))
            message.addHeader(HttpHeaders.CONTENT_TYPE, contentType);
        setEntity(message, httpContent);
    }

    /**
     * Set HTTP message content
     *
     * @param message HTTP message
     * @param contentType contentType
     * @param content content string
     * @throws IOException if error writing message content
     */
    public static void setContent(HttpMessage message, String contentType, String content) throws IOException {
        setContent(message, contentType, content.getBytes(), null);
    }

    /**
     * Set HTTP message content
     *
     * @param message HTTP message
     * @param contentType contentType
     * @param content content string
     * @param charset character set of the content string
     * @throws IOException if error writing message content
     */
    public static void setContent(HttpMessage message, String contentType, String content, String charset)
            throws IOException {
        setContent(message, contentType + "; charset=" + charset, content.getBytes(charset), charset);
    }
}