vona.rmi.rmiwrap

Class RMIWrap

java.lang.Object

vona.rmi.rmiwrap.RMIWrap

public class RMIWrap
extends java.lang.Object

Vona's Utils: Generates wrappers that handle RemoteException.

This is a utility that eases the pain of adding RMI capability to an arbitrary class. It is a sourcecode generator which takes two inputs

• an (arbitrary) compiled API interface foo.API
• an (arbitrary) compiled implementation class foo.Impl for foo.API interface

and which generates three outputs

• APIRemote.java -- an interface with all the methods of foo.API throwing RemoteException
• ImplServer.java -- a proxy that has (i.e. makes) an instance of foo.Impl and which implements foo.APIRemote and which has a main() method that runs a stand-alone RMI server, starting its own Registry
• ImplClient.java -- a proxy that has (i.e. acquires) an instance of foo.ImplServer and which implements foo.API, which forwards API calls to the server, catching RemoteExceptions and passing them to handler methods. The handler methods can be overridden both at the method level and at a global level; by default they throw RuntimeRemoteExceptions, which, unlike RemoteException, are unchecked.

Convenience utilities are built into the makefile to ease the invocation of RMIWrap (and rmic). See the package vona.rmi.rmiwrap.test for a demo of how to use RMIWrap.

Copyright (C) 2005, Marsette A. Vona, III

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Author:

Marsette (Marty) A. Vona, III

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RMIWrap.ClientWriter Write foo.ImplClient from foo.API.
protected static class	RMIWrap.ImplementationWriter Base class for the implementation writers.
protected static class	RMIWrap.InterfaceWriter Writes foo.APIRemote from foo.API.
protected static class	RMIWrap.ServerWriter Write foo.ImplServer from foo.API.
protected static class	RMIWrap.WrapperBodyWriter Encapsulates the ability to write the body of a wrapper class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLIENT_API_EXCEPTION_HANDLER_JAVADOC Javadoc for client API exception handler methods.
static java.lang.String	CLIENT_API_METHOD_JAVADOC Javadoc for client API methods.
static java.lang.String	CLIENT_DIRECT_CONSTRUCTOR_JAVADOC Javadoc for client direct constructor.
static java.lang.String	CLIENT_GENERIC_EXCEPTION_HANDLER_JAVADOC Javadoc for client generic exception handler.
static java.lang.String	CLIENT_GENERIC_SHORT_CIRCUIT_HANDLER_JAVADOC Javadoc for client generic short circuit handler.
static java.lang.String	CLIENT_INDIRECT_CONSTRUCTOR_EXCEPTION_HANDLER_JAVADOC Javadoc for client indirect constructor exception handler.
static java.lang.String	CLIENT_INDIRECT_CONSTRUCTOR_JAVADOC Javadoc for client indirect constructor.
static java.lang.String	CLIENT_REMOTE_INSTANCE_JAVADOC Javadoc for client remote instance field.
static java.lang.String	CLIENT_WRAPPER_JAVADOC Class header doc for the client wrapper.
private static java.lang.String	cvsid CVS id.
static java.lang.String	GEN_HEADER Header string identifies generated files.
static java.lang.String	INTERFACE_API_METHOD_JAVADOC Javadoc for remote interface wrapper API methods.
static java.lang.String	REMOTE_WRAPPER_JAVADOC Class header doc for the remote API wrapper.
static java.lang.String	SERVER_API_METHOD_JAVADOC Javadoc for server API methods.
static java.lang.String	SERVER_AUTOMATIC_CONSTRUCTOR_JAVADOC Javadoc for the server automatic constructor.
static java.lang.String	SERVER_CONSTRUCTOR_JAVADOC Javadoc for the server constructor.
static java.lang.String	SERVER_LOCAL_INSTANCE_JAVADOC Javadoc for the server local instance member.
static java.lang.String	SERVER_MAIN_JAVADOC Javadoc for the server main method.
static java.lang.String	SERVER_WRAPPER_JAVADOC Class header doc for the server wrapper.
static java.lang.String	USAGE Usage message.
static java.lang.String	WRAPPER_LICENSE_JAVADOC Javadoc for the wrapper license.

Constructor Summary

Constructors

Constructor and Description
RMIWrap()

Method Summary

Methods

Modifier and Type	Method and Description
protected static java.lang.String	getPackageName(java.lang.String name) Get the package spec from a class name.
protected static java.lang.String	getSimpleName(java.lang.String name) Get the simple name of a class (the name without any package spec).
protected static java.lang.String	getTypeName(java.lang.Class type) Get the name of a class.
static void	main(java.lang.String[] arg) See USAGE and the class header doc.
protected static void	writeWrapper(java.lang.String baseName, java.lang.String ext, java.lang.String type, RMIWrap.WrapperBodyWriter wrapperBodyWriter, java.lang.String wrapperJavadoc) Write a wrapper.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cvsid

private static final java.lang.String cvsid

CVS id.

See Also:

Constant Field Values

USAGE

public static final java.lang.String USAGE

Usage message.

See Also:

Constant Field Values

GEN_HEADER

public static final java.lang.String GEN_HEADER

Header string identifies generated files.

See Also:

Constant Field Values

INTERFACE_API_METHOD_JAVADOC

public static final java.lang.String INTERFACE_API_METHOD_JAVADOC

Javadoc for remote interface wrapper API methods.

See Also:

Constant Field Values

CLIENT_REMOTE_INSTANCE_JAVADOC

public static final java.lang.String CLIENT_REMOTE_INSTANCE_JAVADOC

Javadoc for client remote instance field.

See Also:

Constant Field Values

CLIENT_DIRECT_CONSTRUCTOR_JAVADOC

public static final java.lang.String CLIENT_DIRECT_CONSTRUCTOR_JAVADOC

Javadoc for client direct constructor.

See Also:

Constant Field Values

CLIENT_INDIRECT_CONSTRUCTOR_JAVADOC

public static final java.lang.String CLIENT_INDIRECT_CONSTRUCTOR_JAVADOC

Javadoc for client indirect constructor.

See Also:

Constant Field Values

CLIENT_INDIRECT_CONSTRUCTOR_EXCEPTION_HANDLER_JAVADOC

public static final java.lang.String CLIENT_INDIRECT_CONSTRUCTOR_EXCEPTION_HANDLER_JAVADOC

Javadoc for client indirect constructor exception handler.

See Also:

Constant Field Values

CLIENT_GENERIC_EXCEPTION_HANDLER_JAVADOC

public static final java.lang.String CLIENT_GENERIC_EXCEPTION_HANDLER_JAVADOC

Javadoc for client generic exception handler.

See Also:

Constant Field Values

CLIENT_GENERIC_SHORT_CIRCUIT_HANDLER_JAVADOC

public static final java.lang.String CLIENT_GENERIC_SHORT_CIRCUIT_HANDLER_JAVADOC

Javadoc for client generic short circuit handler.

See Also:

Constant Field Values

CLIENT_API_METHOD_JAVADOC

public static final java.lang.String CLIENT_API_METHOD_JAVADOC

Javadoc for client API methods.

See Also:

Constant Field Values

CLIENT_API_EXCEPTION_HANDLER_JAVADOC

public static final java.lang.String CLIENT_API_EXCEPTION_HANDLER_JAVADOC

Javadoc for client API exception handler methods.

See Also:

Constant Field Values

SERVER_LOCAL_INSTANCE_JAVADOC

public static final java.lang.String SERVER_LOCAL_INSTANCE_JAVADOC

Javadoc for the server local instance member.

See Also:

Constant Field Values

SERVER_CONSTRUCTOR_JAVADOC

public static final java.lang.String SERVER_CONSTRUCTOR_JAVADOC

Javadoc for the server constructor.

See Also:

Constant Field Values

SERVER_AUTOMATIC_CONSTRUCTOR_JAVADOC

public static final java.lang.String SERVER_AUTOMATIC_CONSTRUCTOR_JAVADOC

Javadoc for the server automatic constructor.

See Also:

Constant Field Values

SERVER_MAIN_JAVADOC

public static final java.lang.String SERVER_MAIN_JAVADOC

Javadoc for the server main method.

See Also:

Constant Field Values

SERVER_API_METHOD_JAVADOC

public static final java.lang.String SERVER_API_METHOD_JAVADOC

Javadoc for server API methods.

See Also:

Constant Field Values

WRAPPER_LICENSE_JAVADOC

public static final java.lang.String WRAPPER_LICENSE_JAVADOC

Javadoc for the wrapper license.

See Also:

Constant Field Values

REMOTE_WRAPPER_JAVADOC

public static final java.lang.String REMOTE_WRAPPER_JAVADOC

Class header doc for the remote API wrapper.

See Also:

Constant Field Values

CLIENT_WRAPPER_JAVADOC

public static final java.lang.String CLIENT_WRAPPER_JAVADOC

Class header doc for the client wrapper.

See Also:

Constant Field Values

SERVER_WRAPPER_JAVADOC

public static final java.lang.String SERVER_WRAPPER_JAVADOC

Class header doc for the server wrapper.

See Also:

Constant Field Values

Constructor Detail

RMIWrap

public RMIWrap()

Method Detail

main

public static void main(java.lang.String[] arg)

See USAGE and the class header doc.

writeWrapper

protected static void writeWrapper(java.lang.String baseName,
                java.lang.String ext,
                java.lang.String type,
                RMIWrap.WrapperBodyWriter wrapperBodyWriter,
                java.lang.String wrapperJavadoc)

Write a wrapper.

Parameters:

baseName - the base of the wrapper class name

ext - the suffix of the wrapper class name

type - the type of wrapper, "class" or "interface"

wrapperBodyWriter - the body writer

wrapperJavadoc - the class header javadoc for the wrapper

getSimpleName

protected static java.lang.String getSimpleName(java.lang.String name)

Get the simple name of a class (the name without any package spec).

Parameters:

name - the class name, with or without package spec

Returns:

the simple name of the class

getPackageName

protected static java.lang.String getPackageName(java.lang.String name)

Get the package spec from a class name.

Parameters:

name - the class name, with or without package spec

Returns:

the package name, or null if none

getTypeName

protected static java.lang.String getTypeName(java.lang.Class type)

Get the name of a class.

Parameters:

type - the class

Returns:

the name of type