Package org.acplt.oncrpc.apps.jrpcgen

jrpcgen for ONC/RPC Java package.

See:
Description

Interface Summary

JrpcgenSymbols

CUP generated interface containing symbol constants.

Class Summary

CUP$JrpcgenParser$actions	Cup generated class to encapsulate user supplied action code.
jrpcgen	The class jrpcgen implements a Java-based rpcgen RPC protocol compiler.
JrpcgenConst	The JrpcgenConst class represents a single constant defined in an rpcgen "x"-file.
JrpcgenDeclaration	The JrpcgenDeclaration class represents a single declaration from an rpcgen "x"-file.
JrpcgenEnDecodingInfo	The class JrpcgenEnDecodingInfo contains information which is necessary to generate source code calling appropriate XDR encoding and decoding methods.
JrpcgenEnum	The JrpcgenEnum class represents a single enumeration from an rpcgen "x"-file.
JrpcgenParamInfo	The JrpcgenParamInfo class contains information about the data type of a procedure's parameter, as well as the parameter's optional name.
JrpcgenParser	CUP v0.10k TUM Edition 20050516 generated parser.
JrpcgenProcedureInfo	The JrpcgenProcedureInfo class contains information about a specific version of an ONC/RPC program as defined in an rpcgen "x"-file.
JrpcgenProgramInfo	The JrpcgenProgramInfo class contains information about a single ONC/RPC program as defined in an rpcgen "x"-file.
JrpcgenScanner	This class is a scanner generated by JFlex 1.2.2 on 20.10.00 09:36 from the specification file file:/G:/JAVA/SRC/ORG/ACPLT/ONCRPC/APPS/JRPCGEN/JrpcgenScanner.flex
JrpcgenSHA	This class implements the SHA-1 algorithm as described in "Federal Information Processing Standards Publication 180-1: Specifications for the Secure Hash Standard.
JrpcgenStruct	The JrpcgenStruct class represents a single structure defined in an rpcgen "x"-file.
JrpcgenUnion	The JrpcgenUnion class represents a single union defined in an rpcgen "x"-file.
JrpcgenUnionArm	The JrpcgenUnionArm class represents a single union arm defined for a particular union in an rpcgen "x"-file.
JrpcgenVersionInfo	The JrpcgenVersionInfo class contains information about a specific version of an ONC/RPC program as defined in a rpcgen "x"-file.

Exception Summary

JrpcgenParserException

The JrpcgenParserException class represents a parser exception indicating to abort parsing the x-file.

Package org.acplt.oncrpc.apps.jrpcgen Description

jrpcgen for ONC/RPC Java package.

This package provides a Java-based rpcgen RPC protocol compiler called "jrpcgen". jrpcgen is a Java-based tool that generates source code of Java classes to implement an RPC protocol. The input to jrpcgen is a language similiar to C (but more probably much more similiar to FORTRAN) known as the RPC language (Remote Procedure Call Language). Because the files containing RPC language are typically tagged with ".x" they are called "x-files" throughout this documentation.

Usage:

jrpcgen [-options] x-file

where options include:

-c classname

Specify class name of client proxy stub.

-d directory

Specify directory where to place generated class source code files.

-p package name or -package package name

Specify package name for generated source code files.

-s classname

Specify class name of server proxy stub.

-ser

tag classes generated for XDR structs, XDR unions and XDR typedefs as serializable. Also automatically generates serialVersionUID using the SHA-1 algorithm.

-bean

generate accessors for usage as bean, implies -ser.

-noclamp

do not clamp version number in client method stubs.

-initstrings

automatically initialize all Strings as empty strings (""). Note that this may lead to lazy programming; better make explicitly sure that every member of a struct gets initialized properly before encoding the struct.

-nobackup

Do not make backups of old source code files for which new source code is generated.

-noclient

Do not create source code for the client proxy stub.

-noserver

Do not create source code for the server proxy stub.

-parseonly

Parse x-file only but do not generate source code files.

-verbose

Enable verbose output about what the jrpcgen compiler is doing.

-version

Print jrpcgen version.

-? or -help

Print this help.

--

End options.

Notes

To cite the man pages for rpcgen(1): The RPC Language does not support nesting of structures. As a work-around, structures can be declared at the top-level, and their name used inside other structures in order to achieve the same effect. Name clashes can occur when using program definitions, since the apparent scoping does not really apply. Most of these can be avoided by giving unique names for programs, versions, procedures, and types. And I thought that the RFC was written before rpcgen to reflect reality but not wishes for further development.

jrpcgen can process the same x-files as its SunOS4.1-based rpcgen counterpart. Or at least it should. The Java language as well as the Java environment cause some slight differences in the code generated with respect to the typical C code emitted by rpcgen. Please also refer to the demo.x example in tests.org.acplt.oncrpc.jrpcgen for the inner details.

However, jrpcgen currently does not support C preprocessor directives, as rpcgen does my running cpp first on the x-file. If you need to achieve the same effect, first run cpp by hand (pardon: makefile) and pipe the result into jrpcgen.

• All global constants are put into one public interface with the same name as the x-file. Global constants are constants either defined using "const" or program and version constants. If a x-file named demo.x defines a constant FOO, then its Java counterpart will be accessible as demo.FOO.

• All enumeration members of a particular enumeration are put into a public interface with the same name as the enumeration. For example: enum FOO { foo }; results in a public interface FOO with a public static final int foo. The enumeration members are accessed like FOO.foo. Within the generated Java code, wherever the enumeration type is used, a Java base data type of int is used instead to avoid cluttering the code.

• For each typedef the jrpcgen protocol compiler emits a class source file of the same name. For instance, typedef string STRING<>; results in class STRING. Such classes always contain exactly one attribute named value. This attribute is of the same type as specified in the typedef, that is String (Java base type) in our case.

• For each struct the protocol compiler also emits a class source file of the same name, containing the specified attributes.

• The server stub code contains the dispatcher code and defines each remote procedure specified in the x-file as abstract. You need to supply your own implementation for each one of these stubs. Note that RPC base data types like int, u_long, etc. are mapped to their appropriate Java base type counterparts (int, int, in this example).

  By default, the server stub class is named after the x-file but with ServerStub appended. For example, if the x-file is named demo.x, then the server stub class is demoServerStub.

• The client stub/proxy implements the remote procedures specified in the x-file as local methods which will call their remote counterpart on an ONC/RPC server.

  By default, the client stub class is named after the x-file but with Client appended. For example, if the x-file is named demo.x, then the client class is demoClient.