/gwtrpccommlayer/src/main/java/com/googlecode/gwtrpccommlayer/client/impl/GwtRpcCommLayerClient.java

/*

 * Copyright 2010 Jeff McHugh (Segue Development 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.googlecode.gwtrpccommlayer.client.impl;



import org.apache.http.cookie.Cookie;



import java.lang.reflect.InvocationHandler;

import java.lang.reflect.Proxy;

import java.net.URL;

import java.util.Collection;



/**

 * This class is the main client-side hook for all RPC interactions.

 * It hides the proxy class slightly and makes it easy for the developer

 * to quickly initiate a RPC class

 * @author jeff mchugh

 *

 */

public class GwtRpcCommLayerClient

{

	/**

	 * This is the default class used unless a runtime directive changes it (which is perfectly fine)

	 */

	public static String DEFAULT_RPC_CLIENT_SIDE_PROXY_IMPL_CLASS

            = "com.googlecode.gwtrpccommlayer.client.impl.GwtRpcClientSideProxy";

	

	private URL url = null;

	private String gwtRpcClientSizeProxyImplClass = null;

    private Collection<Cookie> cookies;



    public GwtRpcCommLayerClient(URL url)

	{

        this.url = url;

		setGwtRpcClientSizeProxyImplClass(DEFAULT_RPC_CLIENT_SIDE_PROXY_IMPL_CLASS);

	}



    public GwtRpcCommLayerClient(URL url, Collection<Cookie> cookies) {

        this(url);

        this.cookies = cookies;

    }

	/**

	 * This method is the main method through which a GWT interface shall be "wrapped" into a working pojo-proxy-client object.

	 * 

	 * @param serviceInterface (this class is your basic interface class which the developer should have already defined according the GWT-RPC specification 

	 * @return a PojoProxy class that uses standard Java Object serialization instead of GWT-RPC servialization

	 * @throws ClassNotFoundException

	 * @throws IllegalAccessException

	 * @throws InstantiationException

	 */

	public <T> T createRemoteServicePojoProxy(Class<T> serviceInterface) throws ClassNotFoundException, IllegalAccessException, InstantiationException

	{

        //Get the Invocation Handler

		InvocationHandler handler = createGwtRpcClientSideProxy();

		T proxy = (T) Proxy.newProxyInstance(

                serviceInterface.getClassLoader(),

                new Class[] { serviceInterface },

                handler);

		return proxy;

	}

	

	/**

	 * Method called internally. Can be overridden for future functionality

	 * @return

	 * @throws ClassNotFoundException

	 * @throws IllegalAccessException

	 * @throws InstantiationException

	 */

	protected IGwtRpcClientSideProxy createGwtRpcClientSideProxy() throws ClassNotFoundException, IllegalAccessException, InstantiationException

	{

        //todo:  This instance should be injected or created with a factory

        //use factory with cookie argument

		Class<?> clazz = Class.forName(getGwtRpcClientSizeProxyImplClass());

		IGwtRpcClientSideProxy proxy = (IGwtRpcClientSideProxy) clazz.newInstance();

		proxy.setUrl(getUrl());

		proxy.setShowResponseHeaders(false);

		

		return proxy;

	}





	/**

	 * @return the url

	 */

	public URL getUrl()

	{

		return url;

	}



	/**

	 * @param gwtRpcClientSizeProxyImplClass the gwtRpcClientSizeProxyImplClass to set

	 */

	public void setGwtRpcClientSizeProxyImplClass(String gwtRpcClientSizeProxyImplClass)

	{

		this.gwtRpcClientSizeProxyImplClass = gwtRpcClientSizeProxyImplClass;

	}



	/**

	 * @return the gwtRpcClientSizeProxyImplClass

	 */

	public String getGwtRpcClientSizeProxyImplClass()

	{

		return gwtRpcClientSizeProxyImplClass;

	}





}