//
// SwitchRMI  Framework
// Copyright (c) 2000-2002 by Michael J. Henderson & Associates.
//
// Michael Henderson
// http://switchrmi.sf.net
// mailto:mikehenderson@dunelm.org.uk
//
// This library is free software.
//
// You may redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License as published by the Free Software Foundation.
//
// Version 2.1 of the license should be included with this distribution in
// the file LICENSE, as well as License.html. If the license is not
// included with this distribution, you may find a copy at the FSF web
// site at 'www.gnu.org' or 'www.fsf.org', or you may write to the
// Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139 USA.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied waranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// $Id: RmiClient.java,v 1.1 2002/11/11 22:19:48 mikehenderson Exp $
package com.mjh.switchrmi;

import java.lang.reflect.*;

import java.util.*;

import javax.naming.*;

import org.apache.log4j.Logger;

/**
 * RmiClient provides the client-side interface to connect to remote objects served by any of the remote
 * method invocation transports.
 *
 *
 * @author Mike Henderson
 */
public class RmiClient
{
    private static final Logger log = 
            Logger.getLogger(RmiClient.class.getName());
    private Context ctx;

    /**
     * Initialize a client for connecting to remote objects via HTTP.
     */
    public RmiClient() throws Exception
    {
        this(null);
    }

    /**
     * Creates a new RmiClient object.
     * 
     * @param resourceName DOCUMENT ME!
     * @throws Exception DOCUMENT ME!
     */
    public RmiClient(String resourceName)
              throws Exception
    {
        Hashtable env = new Hashtable();

        if (resourceName != null)
        {
            env.put(Context.PROVIDER_URL, resourceName);
        }

        env.put(Context.INITIAL_CONTEXT_FACTORY, 
                "com.mjh.switchrmi.jndi.JndiContextImplFactory");
        ctx = new InitialContext(env);
        log.debug("ctx = " + ctx);
    }

    /**
     * DOCUMENT ME!
     * 
     * @return DOCUMENT ME! 
     */
    public Object getJndiContext()
    {
        return ctx;
    }

    /**
     * Obtain a proxy for the remote obejct with the given URL to invoke methods in the specified interface.
     *
     * @param url a valid remote object URL, valid URLS end in /name.protocol
     * @param interface a Java interface implemented by the remote object.
     *
     * @return a Proxy to the remote object.
     *
     */
    public Object connect(String url, Class interfaze)
                   throws Exception
    {
        return connect(url, new Class[] { interfaze });
    }

    /**
     * Obtain a proxy for the remote obejct with the given URL to invoke methods in the specified interfaces.
     *
     * @param url a valid remote object URL, valid URLS end in /name.protocol
     * @param interfaces an array of Java interfaces implemented by the remote object.
     *
     * @return a Proxy to the remote object.
     *
     */
    public Object connect(String url, Class[] interfaces)
                   throws Exception
    {
        RmiUrlInfo info = new RmiUrlInfo(url);

        return connect(url, interfaces, info.getProtocolName());
    }

    /**
     * Obtain a proxy for the remote obejct with the given URL to invoke methods in the specified interfaces.
     *
     * @param url a valid URL,for the remote transport method
     * @param interface a Java interface implemented by the remote object.
     * @param protocolName a valid RMI invocation protocol. Valid names are specified in RmiProtocol.
     *
     * @return a Proxy to the remote object.
     * @see RmiProtocol
     */
    public Object connect(String url, Class interfaze, String protocolName)
                   throws Exception
    {
        return connect(url, new Class[] { interfaze }, protocolName);
    }

    /**
     * Obtain a proxy for the remote obejct with the given URL to invoke methods in the specified interfaces.
     *
     * @param url a valid URL,for the remote transport method
     * @param interfaces an array of Java interfaces implemented by the remote object.
     * @param protocolName a valid RMI invocation protocol. Valid names are specified in RmiProtocol.
     *
     * @return a Proxy to the remote object.
     * @see RmiProtocol.
     */
    public Object connect(String url, Class[] interfaces, String protocolName)
                   throws Exception
    {
        RmiClientInvocationHandler handler = 
                new RmiClientInvocationHandler(url, interfaces, protocolName, 
                                               ctx);

        return Proxy.newProxyInstance(getClass().getClassLoader(), interfaces, 
                                      handler);
    }
}