com.navercorp.volleyextensions.request.Jackson2Request Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of volley-extensions Show documentation
There is a newer version: 1.1.1
/*
 * Copyright (C) 2014 Naver Business Platform Corp.
 * 
 * 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.navercorp.volleyextensions.request;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.UnsupportedEncodingException;

import com.android.volley.NetworkResponse;
import com.android.volley.ParseError;
import com.android.volley.Request;
import com.android.volley.Response;
import com.android.volley.Response.ErrorListener;
import com.android.volley.Response.Listener;
import com.android.volley.VolleyError;
import com.android.volley.toolbox.HttpHeaderParser;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.navercorp.volleyextensions.util.Assert;
import com.navercorp.volleyextensions.util.IoUtils;

/**
 * A Request{@literal } for which make a request and convert response data by Jackson 2.x ObjectMapper.    
 * @param  Specific type of an converted object from response data
 * 
 * @see AbstractConverterRequest
 * @see Request
 */
public class Jackson2Request extends AbstractConverterRequest {
	/** Default {@link ObjectMapper} is singleton. */
	private static class ObjectMapperHolder {
		private final static ObjectMapper objectMapper;
		static {
			objectMapper = new ObjectMapper();
			// ignore unknown json properties
			objectMapper.configure(
					DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
			// allow unquoted control characters
			objectMapper.configure(
					JsonParser.Feature.ALLOW_UNQUOTED_CONTROL_CHARS, true);
			// ObjectMapper is thread-safe after configuration. ( )
		}
		
		private static ObjectMapper getObjectMapper() {
			return objectMapper;
		}
	}
	
	/** {@code objectMapper} is immutable(but not severely). */
	private final ObjectMapper objectMapper;
	
	/**
	 * Make a request with custom {@code objectMapper} and {@code errorListener}
	 * @param method HTTP method. See here : {@link com.android.volley.Request.Method} 
	 * @param url URL of the request to make
	 * @param clazz Specific type object of an converted object from response data
	 * @param objectMapper {@link ObjectMapper} to convert
	 * @param listener listener for response
	 * @param errorListener listener for errors
	 */
	public Jackson2Request(int method, String url, Class clazz, ObjectMapper objectMapper, Listener listener,
			ErrorListener errorListener) {
		super(method, url, clazz, listener, errorListener);
		assertObjectMapper(objectMapper);
		this.objectMapper = objectMapper;
	}	

	/**
	 * Make a GET request with custom {@code objectMapper} and {@code errorListener}
	 * @param url URL of the request to make
	 * @param clazz Specific type object of an converted object from response data
	 * @param objectMapper {@link ObjectMapper} to convert
	 * @param listener listener for response
	 * @param errorListener listener for errors
	 */
	public Jackson2Request(String url, Class clazz, ObjectMapper objectMapper, Listener listener,
			ErrorListener errorListener) {
		super(url, clazz, listener, errorListener);
		assertObjectMapper(objectMapper);
		this.objectMapper = objectMapper;
	}

	/**
	 * Make a GET request with custom {@code objectMapper}
	 * @param url URL of the request to make
	 * @param clazz Specific type object of an converted object from response data
	 * @param objectMapper {@link ObjectMapper} to convert
	 * @param listener listener for response
	 */
	public Jackson2Request(String url, Class clazz, ObjectMapper objectMapper, Listener listener) {
		super(url, clazz, listener);
		assertObjectMapper(objectMapper);
		this.objectMapper = objectMapper;
	}

	private final void assertObjectMapper(ObjectMapper objectMapper) {
		Assert.notNull(objectMapper, "objectMapper");
	}
	
	/**
	 * Make a request with custom {@code errorListener}
	 * @param method HTTP method. See here : {@link com.android.volley.Request.Method} 
	 * @param url URL of the request to make
	 * @param clazz Specific type object of an converted object from response data
	 * @param listener listener for response
	 * @param errorListener listener for errors
	 */
	public Jackson2Request(int method, String url, Class clazz, Listener listener,
			ErrorListener errorListener) {
		this(method, url, clazz, ObjectMapperHolder.getObjectMapper(), listener, errorListener);
	}	
	
	/**
	 * Make a GET request with custom {@code errorListener}
	 * @param url URL of the request to make
	 * @param clazz Specific type object of an converted object from response data
	 * @param listener listener for response
	 * @param errorListener listener for errors
	 */
	public Jackson2Request(String url, Class clazz, Listener listener, ErrorListener errorListener) {
		this(url, clazz, ObjectMapperHolder.getObjectMapper(), listener, errorListener);
	}
	
	/**
	 * Make a GET request
	 * @param url URL of the request to make
	 * @param clazz
	 * @param listener listener for response
	 */
	public Jackson2Request(String url, Class clazz, Listener listener) {
		this(url, clazz, ObjectMapperHolder.getObjectMapper(), listener);
	}

	@Override
	protected Response parseNetworkResponse(NetworkResponse response) {
		String charset = HttpHeaderParser.parseCharset(response.headers);
		Reader reader = null;
		try {
			reader = new InputStreamReader(new ByteArrayInputStream(response.data), charset);
			T result = objectMapper.readValue(reader, getTargetClass());
			return Response.success(result,
					HttpHeaderParser.parseCacheHeaders(response));
		} catch (JsonParseException e) {
			return Response.error(new ParseError(e));
		} catch (JsonMappingException e) {
			return Response.error(new ParseError(e));
		} catch (UnsupportedEncodingException e) {
			return Response.error(new ParseError(e));
		} catch (IOException e) {
			return Response.error(new VolleyError(e));
		} catch (Exception e) {
			return Response.error(new VolleyError(e));
		} finally {
			IoUtils.closeQuietly(reader);
		}
	}
}