br.com.caelum.vraptor.util.test.MockSerializationResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vraptor Show documentation
There is a newer version: 4.3.0-beta-3
/***
 * Copyright (c) 2009 Caelum - www.caelum.com.br/opensource
 * 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 br.com.caelum.vraptor.util.test;


import java.util.ArrayList;

import javax.enterprise.inject.Vetoed;

import com.google.gson.JsonDeserializer;
import com.google.gson.JsonSerializer;

import br.com.caelum.vraptor.View;
import br.com.caelum.vraptor.environment.Environment;
import br.com.caelum.vraptor.environment.NullEnvironment;
import br.com.caelum.vraptor.http.FormatResolver;
import br.com.caelum.vraptor.interceptor.DefaultTypeNameExtractor;
import br.com.caelum.vraptor.proxy.JavassistProxifier;
import br.com.caelum.vraptor.proxy.Proxifier;
import br.com.caelum.vraptor.serialization.DefaultRepresentationResult;
import br.com.caelum.vraptor.serialization.JSONSerialization;
import br.com.caelum.vraptor.serialization.RepresentationResult;
import br.com.caelum.vraptor.serialization.Serialization;
import br.com.caelum.vraptor.serialization.XMLSerialization;
import br.com.caelum.vraptor.serialization.gson.GsonBuilderWrapper;
import br.com.caelum.vraptor.serialization.gson.GsonJSONSerialization;
import br.com.caelum.vraptor.serialization.gson.GsonSerializerBuilder;
import br.com.caelum.vraptor.serialization.xstream.XStreamBuilder;
import br.com.caelum.vraptor.serialization.xstream.XStreamBuilderImpl;
import br.com.caelum.vraptor.serialization.xstream.XStreamXMLSerialization;
import br.com.caelum.vraptor.view.EmptyResult;

/**
 *
 * A mocked Result for testing your serialized objects returns.
 *
 * It will serialize your objects for real and return them as string,
 * this way, you could use result.use(Resultrs.json()).from(object) for serialize and inspect objects.
 *
 * @author Vinícius Oliveira
 */
@Vetoed
public class MockSerializationResult extends MockResult {

	private Serialization serialization;
	private MockHttpServletResponse response;
	private DefaultTypeNameExtractor extractor;
	private XStreamBuilder xstreambuilder;
	private GsonSerializerBuilder gsonBuilder;
	private Environment environment;


	/**
	 * @deprecated Prefer using {@link MockSerializationResult#MockSerializationResult(Proxifier, XStreamBuilder, GsonSerializerBuilder, Environment)}
	 * that provides a {@link Environment}.
	 */
	public MockSerializationResult(Proxifier proxifier, XStreamBuilder xstreambuilder, GsonSerializerBuilder gsonBuilder) {
		this(proxifier, xstreambuilder, gsonBuilder, new NullEnvironment());
	}

	public MockSerializationResult(Proxifier proxifier, XStreamBuilder xstreambuilder, GsonSerializerBuilder gsonBuilder,
			Environment environment) {
		super(proxifier);
		this.environment = environment;
		this.response = new MockHttpServletResponse();
		this.extractor = new DefaultTypeNameExtractor();
		this.xstreambuilder = xstreambuilder;
		this.gsonBuilder = gsonBuilder;
	}

	public MockSerializationResult() {
		this(new JavassistProxifier(), XStreamBuilderImpl.cleanInstance(),
				new GsonBuilderWrapper(new MockInstanceImpl<>(new ArrayList>()), 
						new MockInstanceImpl<>(new ArrayList>()))
		);
	}
	
	@Override
	public  T use(final Class view) {
		this.typeToUse = view;
		if (view.equals(EmptyResult.class)) {
			return null;
		}
		return instanceView(view);
	}

	private  T instanceView(Class view){
		if (view.isAssignableFrom(JSONSerialization.class)){
			serialization = new GsonJSONSerialization(response, extractor, gsonBuilder, environment);
			return view.cast(serialization);
		}

		if (view.isAssignableFrom(XMLSerialization.class)){
			serialization = new XStreamXMLSerialization(response, xstreambuilder, environment);
			return view.cast(serialization);
		}

		if (view.isAssignableFrom(RepresentationResult.class)) {
			serialization = new XStreamXMLSerialization(response, xstreambuilder, environment);
			return view.cast(new DefaultRepresentationResult(new FormatResolver() {
				@Override
				public String getAcceptFormat() {
					return "xml";
				}
			}, this, new MockInstanceImpl<>(this.serialization)));
		}

		return proxifier.proxify(view, returnOnFinalMethods(view));
	}


	/**
	 * Retrieve the string with the serialized (JSON/XML) Object if have one as response.
	 *
	 * @return String with the object serialized
	 */
	public String serializedResult() throws Exception {

		if("application/xml".equals(response.getContentType())){
			return response.getContentAsString();
		}

		if("application/json".equals(response.getContentType())){
			return response.getContentAsString();
		}

		return null;
	}

}