com.ibm.watson.developer_cloud.util.RequestUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-wrapper Show documentation
Client library to use the IBM Watson Services and AlchemyAPI
The newest version!
/**
 * Copyright 2015 IBM Corp. All Rights Reserved.
 *
 * 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.ibm.watson.developer_cloud.util;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.apache.commons.lang3.ArrayUtils;
import org.apache.http.NameValuePair;
import org.apache.http.protocol.HTTP;

/**
 * Utility functions to use when creating a {@link com.ibm.watson.developer_cloud.service.Request }
 * 
 * @author German Attanasio Ruiz ([email protected])
 */
public class RequestUtil {
	
	/** The Constant log. */
	private static final Logger log = Logger.getLogger(RequestUtil.class
			.getName());
	
	/**
	 * Encode the content with the given encoding.
	 * 
	 * @param content
	 *            the string content to encode
	 * @param encoding
	 *            the character encoding
	 * @return the string encoded
	 */
	private static String encode(final String content, final String encoding) {
		try {
			return URLEncoder.encode(content, encoding != null ? encoding
					: HTTP.DEFAULT_CONTENT_CHARSET);
		} catch (UnsupportedEncodingException e) {
			log.log(Level.SEVERE, encoding + " is not supported", e);
			throw new IllegalArgumentException(e);
		}
	}

	/**
	 * Returns a String that is suitable for use as an
	 * application/x-www-form-urlencoded list of parameters in an
	 * HTTP PUT or HTTP POST. It can also be used as query string in a GET
	 * request
	 * 
	 * @param parameters
	 *            The parameters to include.
	 * @param encoding
	 *            The encoding to use.
	 * 
	 * @return the formated string
	 */
	public static String formatQueryString(
			final List parameters,
			final String encoding) {
		final StringBuilder result = new StringBuilder();
		for (final NameValuePair parameter : parameters) {
			final String encodedName = encode(parameter.getName(), encoding);
			final String value = parameter.getValue();
			final String encodedValue = value != null ? encode(value, encoding)
					: "";
			if (result.length() > 0) {
				result.append("&");
			}
			result.append(encodedName);
			if (value != null) {
				result.append("=");
				result.append(encodedValue);
			}
		}
		return result.toString();
	}

	
	/**
	 * Return a copy of a {@link Map} excluding the given key, or array of keys.
	 *
	 * @param params the parameters
	 * @param toOmit the keys to omit
	 * @return the map with the omitted key-value pars
	 */
	public static Map omit(Map params, String... toOmit) {
		if (params == null) return null;
		if (toOmit == null || toOmit.length == 0) return params;

		Map ret = new HashMap();

		for (String key : params.keySet()) {
			if (!ArrayUtils.contains(toOmit, key))
				ret.put(key, params.get(key));
		}
		return ret;
	}
	
	/**
	 * Return a copy of a {@link Map} with only the specified given key, or array of keys.
	 *
	 * @param params the parameters
	 * @param toPick the keys to pick
	 * @return the map with the picked key-value pars
	 */

	public static Map pick(Map params, String... toPick) {
		if (params == null) return null;
		if (toPick == null || toPick.length == 0) return params;
		
		Map ret = new HashMap();

		for (String key : params.keySet()) {
			if (ArrayUtils.contains(toPick, key))
				ret.put(key, params.get(key));
		}
		
		return ret;
	}
}