Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
*
* jerry-http - Common Java Functionality
* Copyright (c) 2012-2014, Sandeep Gupta
*
* http://sangupta.com/projects/jerry-http
*
* 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.sangupta.jerry.http;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import org.apache.http.NameValuePair;
import org.apache.http.client.params.CookiePolicy;
import org.apache.http.entity.ContentType;
import org.apache.http.message.BasicNameValuePair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.gson.Gson;
import com.sangupta.jerry.util.AssertUtils;
import com.sangupta.jerry.util.DateUtils;
import com.sangupta.jerry.util.GsonUtils;
import com.sangupta.jerry.util.XStreamUtils;
import com.thoughtworks.xstream.XStream;
/**
* Utility class containing methods pertaining to invocation of REST based webservices and
* capturing the responses obtained from the same. For advanced usage, the {@link WebRequest} facade
* can be used directly to gain much more control over the request/response handling.
*
* The methods in this class will timeout within one minute if no connection is established, or the
* socket timeout happens.
*
* @author sangupta
*
* @since 0.1.0
*
*/
public class WebInvoker {
/**
* Value to be used for connection timeout
*/
private static int CONNECTION_TIMEOUT = (int) DateUtils.ONE_MINUTE;
/**
* Value to be used for socket timeout
*/
private static int SOCKET_TIMEOUT = (int) DateUtils.ONE_MINUTE;
/**
* An instance of {@link WebInvocationInterceptor} that needs to be used when handling interceptors.
* If an interceptor is added while a call is being made, it will not apply to that request. Interceptors
* will work only on a fresh request.
*/
public static WebInvocationInterceptor interceptor = null;
/**
* My private logger
*/
private static final Logger logger = LoggerFactory.getLogger(WebInvoker.class);
/**
* Return the HTTP response body for a GET request to the given URL. In case
* an {@link IOException} is thrown, it will be eaten up, logged at DEBUG
* level, and null returned.
*
* @param url
* the url to hit
*
* @return the string response body
*/
public static String fetchResponse(String url) {
return fetchResponse(url, CookiePolicy.BEST_MATCH);
}
/**
* Return the HTTP response body for a GET request to the given URL using
* the given cookie policy. In case an {@link IOException} is thrown, it
* will be eaten up, logged at DEBUG level, and null returned.
*
* @param url
* the url to hit
*
* @param cookiePolicy
* the cookie policy to use
*
* @return the string reponse body
*/
public static String fetchResponse(String url, String cookiePolicy) {
try {
return WebRequest.get(url).connectTimeout(CONNECTION_TIMEOUT).socketTimeout(SOCKET_TIMEOUT).cookiePolicy(cookiePolicy).execute().webResponse().getContent();
} catch(IOException e) {
logger.debug("Unable to fetch repsonse from url: {}", url, e);
}
return null;
}
/**
* Return the {@link WebResponse} for a GET request to the given URL using
* the {@link CookiePolicy#BEST_MATCH} cookie policy . In case an
* {@link IOException} is thrown, it will be eaten up, logged at DEBUG
* level, and null returned.
*
* @param url
* the url to hit
*
* @return the {@link WebResponse} obtained
*/
public static WebResponse getResponse(String url) {
return getResponse(url, CookiePolicy.BEST_MATCH);
}
/**
* Return the entire response for a GET request to the given URL using the
* given cookie policy
*
* @param url
* the url to hit
*
* @param cookiePolicy
* the cookie policy to use
*
* @return the {@link WebResponse} obtained
*/
public static WebResponse getResponse(String url, String cookiePolicy) {
try {
return WebRequest.get(url).connectTimeout(CONNECTION_TIMEOUT).socketTimeout(SOCKET_TIMEOUT).cookiePolicy(cookiePolicy).execute().webResponse();
} catch(Exception e) {
logger.debug("Unable to fetch repsonse from url: {}", url, e);
}
return null;
}
/**
* Returns the HTTP headers etc by making a HEAD request to the given URL as
* a {@link Map}. A cookie policy of {@link CookiePolicy#BEST_MATCH} is used.
*
* @param url
* the url to hit
*
* @param followRedirects
* whether redirects should be followed or not
*
* @return a map of all header values
*/
public static Map getHeaders(String url, boolean followRedirects) {
return getHeaders(url, followRedirects, CookiePolicy.BEST_MATCH);
}
/**
* Return the HTTP headers by making a HEAD request to the given URL using
* the given cookie policy
*
* @param url
* the url to hit
*
* @param followRedirects
* whether redirects should be followed or not
*
* @param cookiePolicy
* the cookie policy to use
*
* @return a map of all header values
*/
public static Map getHeaders(String url, boolean followRedirects, String cookiePolicy) {
try {
if(followRedirects) {
return WebRequest.head(url).connectTimeout(CONNECTION_TIMEOUT).socketTimeout(SOCKET_TIMEOUT).cookiePolicy(cookiePolicy).followRedirects().execute().webResponse().getHeaders();
}
return WebRequest.head(url).connectTimeout(CONNECTION_TIMEOUT).socketTimeout(SOCKET_TIMEOUT).cookiePolicy(cookiePolicy).noRedirects().execute().webResponse().getHeaders();
} catch(IOException e) {
logger.debug("Unable to fetch response headers from url: {}", url, e);
}
return null;
}
/**
* Make a HEAD request to the URL and return the web response. A cookie
* policy of {@link CookiePolicy#BEST_MATCH} is used.
*
* @param url
* the url to hit
*
* @param followRedirects
* whether to follow redirects or not
*
* @return the {@link WebResponse} obtained
*/
public static WebResponse headRequest(String url, boolean followRedirects) {
return headRequest(url, followRedirects, CookiePolicy.BEST_MATCH);
}
/**
* Make a HEAD request to the URL using given cookie policy and return the
* web response.
*
* @param url
* the url to hit
*
* @param followRedirects
* whether to follow redirects or not
*
* @param cookiePolicy
* the cookie policy to use
*
* @return the {@link WebResponse} obtained
*/
public static WebResponse headRequest(String url, boolean followRedirects, String cookiePolicy) {
try {
if(followRedirects) {
return WebRequest.head(url).connectTimeout(CONNECTION_TIMEOUT).socketTimeout(SOCKET_TIMEOUT).cookiePolicy(cookiePolicy).followRedirects().execute().webResponse();
}
return WebRequest.head(url).connectTimeout(CONNECTION_TIMEOUT).socketTimeout(SOCKET_TIMEOUT).cookiePolicy(cookiePolicy).noRedirects().execute().webResponse();
} catch(IOException e) {
logger.debug("Unable to fetch response headers from url: {}", url, e);
}
return null;
}
/**
* Invoke the given URL by the specified HTTP verb/method and return the
* entire HTTP response.
*
* @param uri
* the url to hit
*
* @param method
* the VERB to use
*
* @return the {@link WebResponse} obtained
*/
public static WebResponse invokeUrl(final String uri, final WebRequestMethod method) {
WebRequest request = getWebRequest(uri, method);
try {
return request.execute().webResponse();
} catch(IOException e) {
logger.debug("Unable to fetch repsonse from url: {}", uri, e);
}
return null;
}
/**
* Invoke the given URL by the specified method, supplying the header and
* params as specified and return the entire HTTP response.
*
* @param uri
* the url to hit
*
* @param method
* the VERB to use
*
* @param headers
* the request headers to be sent
*
* @param params
* the FORM parameters to be sent
*
* @return the {@link WebResponse} obtained
*
*/
public static WebResponse invokeUrl(final String uri, final WebRequestMethod method, final Map headers, final Map params) {
WebRequest request = getWebRequest(uri, method);
if(AssertUtils.isNotEmpty(headers)) {
for(Entry header : headers.entrySet()) {
request.addHeader(header.getKey(), header.getValue());
}
}
if(AssertUtils.isNotEmpty(params)) {
request.bodyForm(getFormParams(params));
}
try {
return request.execute().webResponse();
} catch(IOException e) {
logger.debug("Unable to fetch repsonse from url: {}", uri, e);
}
return null;
}
/**
* Hit the URL with given parameters and return the http response.
*
* @param uri
* the url to hit
*
* @param method
* the VERB to use
*
* @param requestContentType
* the content type of the request body
*
* @param requestBody
* the request body string
*
* @return the {@link WebResponse} obtained
*/
public static WebResponse invokeUrl(final String uri, final WebRequestMethod method, final String requestContentType, final String requestBody) {
WebRequest request = getWebRequest(uri, method);
request.bodyString(requestBody, ContentType.create(requestContentType));
try {
return request.execute().webResponse();
} catch(IOException e) {
logger.debug("Unable to fetch repsonse from url: {}", uri, e);
}
return null;
}
/**
* POST the XML representation of the given object, to the given URL. The
* object is converted to XML format using {@link XStream} project.
*
* @param uri
* the url to hit
*
* @param object
* the object to be sent in request body
*
* @return the {@link WebResponse} obtained
*
*/
public static WebResponse postXML(final String uri, final Object object) {
WebRequest request = getWebRequest(uri, WebRequestMethod.POST);
String requestBody = XStreamUtils.getXStream(object.getClass()).toXML(object);
request.bodyString(requestBody, ContentType.create("text/xml"));
try {
return request.execute().webResponse();
} catch(IOException e) {
logger.debug("Unable to fetch repsonse from url: {}", uri, e);
}
return null;
}
/**
* POST the JSON representation of the given object to the given URL. The
* object is converted to JSON format usign {@link Gson} project.
*
* @param uri
* the url to hit
*
* @param object
* the object to be sent in request body
*
* @return the {@link WebResponse} obtained
*/
public static WebResponse postJSON(final String uri, final Object object) {
WebRequest request = getWebRequest(uri, WebRequestMethod.POST);
String requestBody = GsonUtils.getGson().toJson(object);
request.bodyString(requestBody, ContentType.create("application/json"));
try {
return request.execute().webResponse();
} catch(IOException e) {
logger.debug("Unable to fetch repsonse from url: {}", uri, e);
}
return null;
}
/**
* Get the {@link WebRequest} object for the given VERB method.
*
* @param uri
* the url to hit
*
* @param method
* the HTTP VERB to be used
*
* @return the {@link WebRequest} instance for the request
*/
public static WebRequest getWebRequest(final String uri, final WebRequestMethod method) {
if(method == null) {
throw new IllegalArgumentException("WebRequestMethod cannot be null");
}
WebRequest request = null;
switch(method) {
case DELETE:
request = WebRequest.delete(uri);
break;
case GET:
request = WebRequest.get(uri);
break;
case HEAD:
request = WebRequest.head(uri);
break;
case OPTIONS:
request = WebRequest.options(uri);
break;
case POST:
request = WebRequest.post(uri);
break;
case PUT:
request = WebRequest.put(uri);
break;
case TRACE:
request = WebRequest.trace(uri);
break;
}
if(request != null) {
request.connectTimeout(CONNECTION_TIMEOUT).socketTimeout(SOCKET_TIMEOUT);
return request;
}
throw new IllegalStateException("All options of enumeration have a check above, reaching this is impossible. This is a coding horror.");
}
/**
* Change the default value of the connection timeout.
*
* @param millis
* the timeout in millis
*/
public static void setConnectionTimeout(int millis) {
CONNECTION_TIMEOUT = millis;
}
/**
* Change the default value of the socket timeout.
*
* @param millis
* the timeout in millis
*/
public static void setSocketTimeout(int millis) {
SOCKET_TIMEOUT = millis;
}
/**
* Execute the given {@link WebRequest} silently.
*
* @param request
* the {@link WebRequest} to be executed
*
* @return {@link WebResponse} obtained
*
* @throws IllegalArgumentException
* if the {@link WebRequest} is null
*/
public static WebResponse executeSilently(WebRequest request) {
if(request == null) {
throw new IllegalArgumentException("Webrequest to be executed cannot be null");
}
try {
return request.execute().webResponse();
} catch(Exception e) {
logger.debug("Unable to fetch repsonse from url: {}", request.getHttpRequest().getURI().toString(), e);
}
return null;
}
/**
* Create a {@link NameValuePair} list from the given {@link Map} of params
* to be passed.
*
* @param params
* the params to convert to
*
* @return a list of {@link NameValuePair}s generated
*/
private static List getFormParams(Map params) {
List nvps = new ArrayList();
for(Entry entry : params.entrySet()) {
nvps.add(new BasicNameValuePair(entry.getKey(), entry.getValue()));
}
return nvps;
}
}
