public class jrpcgen
extends java.lang.Object
jrpcgen
implements a Java-based rpcgen RPC protocol
compiler. 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).Modifier and Type | Field and Description |
---|---|
static java.lang.String |
baseClassname
Name of class containing global constants.
|
private static java.lang.String[] |
baseTypes
Java base data types for which are XDR encoding and decoding helper
methods available.
|
static boolean |
clampProgAndVers
Clamp version and program number in client method stubs to the
version and program number specified in the x-file.
|
static java.lang.String |
clientClass
Name of class containing the ONC/RPC client stubs.
|
static java.lang.String |
currentFilename
Full name of the current source code file.
|
static java.io.Writer |
currentFileWriter
Current FileWriter object receiving generated source code.
|
static java.io.PrintWriter |
currentPrintWriter
Current PrintWriter object sitting on top of the
currentFileWriter object receiving generated source code. |
static boolean |
debug
Enable diagnostic messages when parsing the x-file.
|
static java.io.File |
destinationDir
Destination directory where to place the generated files.
|
static java.util.Hashtable |
globalIdentifiers
Contains all global identifiers for type, structure and union specifiers
as well as for constants and enumeration members.
|
static boolean |
initStrings
Enable automatic initialization of String with empty Strings
instead of null reference.
|
static boolean |
makeBean
Enable generation of accessors in order to use XDR classes as beans.
|
static boolean |
makeSerializable
Enable tagging of XDR classes as being Serializable
|
static boolean |
noBackups
Disable automatic backup of old source code files, if
true . |
static boolean |
noClient
Do not generate source code for the client proxy stub if
true . |
static boolean |
noServer
Do not generate source code for the server proxy stub if
true . |
static java.lang.String |
packageName
Specifies package name for generated source code, if not
null . |
static int |
PARAMS_MORE
A remote procedure expects more than one parameter and thus needs
an XDR wrapping class.
|
static int |
PARAMS_SINGLE
A remote procedure expects only a single parameter, which is a
complex type (class).
|
static int |
PARAMS_SINGLE_BASETYPE
A remote procedure expects only a single parameter, which is of
a base type, like integer, boolean, string, et cetera.
|
static int |
PARAMS_VOID
A remote procedure has no parameters and thus needs to use the
XDR void wrapper class as a dummy.
|
static boolean |
parseOnly
Parse x-file only but do not create source code files if set to
true . |
static java.util.Vector |
programInfos
Holds information about the remote program defined in the jrpcgen
x-file.
|
static java.lang.String |
serverClass
Name of class containing the ONC/RPC server stubs.
|
static java.lang.String |
startDate
String containing date/time when a jrpcgen run was started.
|
static boolean |
verbose
Verbosity flag.
|
static java.lang.String |
VERSION
Current version of jrpcgen.
|
static boolean |
withCallInfo
Supply (additional) call information to server method stubs.
|
static java.io.File |
xFile
The x-file to parse (not: the X Files, the latter ones are something
completely different).
|
Constructor and Description |
---|
jrpcgen() |
Modifier and Type | Method and Description |
---|---|
static JrpcgenEnDecodingInfo |
baseEnDecodingSyllable(JrpcgenDeclaration decl)
Return the en-/decoding syllable XXX appropriate for a base data
type including arrays of base data types.
|
static java.lang.String |
checkForEnumValue(java.lang.String value)
Checks whether a given value references an identifier and then
returns the qualified identifier (interface where the value is
defined in) or simply the value in case of an integer literal.
|
static java.lang.String |
checkForSpecials(java.lang.String dataType)
Checks whether a given data type identifier refers to an enumeration
type and then returns Java's int data type instead.
|
static void |
closeJavaSourceFile()
Closes the source code file previously opened with
createJavaSourceFile . |
static java.lang.String |
codingMethod(JrpcgenDeclaration decl,
boolean encode)
Return en- or decoding method appropriate for a struct or union member.
|
static java.lang.String |
codingMethod(JrpcgenDeclaration decl,
boolean encode,
java.lang.String oref)
Return en- or decoding method appropriate for a struct or union member.
|
static java.io.PrintWriter |
createJavaSourceFile(java.lang.String classname)
Creates a new source code file for a Java class based on its class
name.
|
static java.io.PrintWriter |
createJavaSourceFile(java.lang.String classname,
boolean emitImports)
Creates a new source code file for a Java class based on its class
name.
|
static JrpcgenSHA |
createSHA(java.lang.String classname)
Create a new hash function object and initialize it using a class
and package name.
|
static void |
doParse()
The real parsing and code generation part.
|
static void |
dumpClasses()
Generate source code files for all structures, unions and enumerations
as well as constants.
|
static void |
dumpClient(JrpcgenProgramInfo programInfo)
Generate source code for the client stub proxy object.
|
static void |
dumpClientStubMethods(java.io.PrintWriter out,
JrpcgenVersionInfo versionInfo)
Generate source code for client-side stub methods for a particular
remote program version.
|
static void |
dumpConstantAndDependency(java.io.PrintWriter out,
JrpcgenConst c)
Dump the value of a constant and optionally first dump all constants
it depends on.
|
static void |
dumpConstants()
Generate source code file containing all constants defined in the
x-file as well as all implicitely defined constants, like program,
version and procedure numbers, etc.
|
static void |
dumpEnum(JrpcgenEnum e)
Generate a source code file containing all elements of an enumeration
defined in a x-file.
|
static void |
dumpFiles()
Create the source code files based on the parsed information from the
x-file.
|
static void |
dumpServer(JrpcgenProgramInfo programInfo) |
static void |
dumpServerStubMethodCall(java.io.PrintWriter out,
JrpcgenProcedureInfo proc) |
static void |
dumpServerStubMethods(java.io.PrintWriter out,
JrpcgenVersionInfo versionInfo)
Generate public abstract method signatures for all remote procedure
calls.
|
static void |
dumpStruct(JrpcgenStruct s)
Generate a source code file containing all elements of a struct
defined in a x-file.
|
static void |
dumpTypedef(JrpcgenDeclaration d)
Generate a source code file containing a wrapper class for a typedef
defined in a x-file.
|
static void |
dumpUnion(JrpcgenUnion u)
Generate a source code file containing all elements of a union
defined in a x-file.
|
static void |
main(java.lang.String[] args)
The main part of jrpcgen where all things start.
|
static void |
printHelp()
Print the help message describing the available command line options.
|
static java.lang.String |
xdrBaseType(java.lang.String type)
Given a name of a data type return the name of the equivalent Java
data type (if it exists), otherwise return
null . |
public static final java.lang.String VERSION
public static final int PARAMS_VOID
public static final int PARAMS_SINGLE
public static final int PARAMS_SINGLE_BASETYPE
public static final int PARAMS_MORE
public static final java.lang.String startDate
public static java.util.Hashtable globalIdentifiers
public static boolean noBackups
true
.public static java.util.Vector programInfos
public static boolean clampProgAndVers
public static boolean withCallInfo
public static boolean debug
public static boolean verbose
true
, then jrpcgen will report about
the steps it is taking when generating all the source code files.public static boolean parseOnly
true
.public static java.io.File xFile
public static java.io.File destinationDir
public static java.io.Writer currentFileWriter
public static java.io.PrintWriter currentPrintWriter
currentFileWriter
object receiving generated source code.public static java.lang.String currentFilename
public static java.lang.String packageName
null
. If null
, then no package statement
is emitted.public static java.lang.String baseClassname
public static boolean noClient
true
.public static boolean noServer
true
.public static java.lang.String serverClass
public static java.lang.String clientClass
public static boolean makeSerializable
public static boolean makeBean
public static boolean initStrings
private static java.lang.String[] baseTypes
public static void printHelp()
public static java.io.PrintWriter createJavaSourceFile(java.lang.String classname)
createJavaSourceFile(String, boolean)
with
the emitImport
parameter set to true
.classname
- Name of Java class to generate. Must not contain
a file extension -- especially ".java" is invalid. When the source
code file is created, ".java" is appended automatically.public static java.io.PrintWriter createJavaSourceFile(java.lang.String classname, boolean emitImports)
classname
- Name of Java class to generate. Must not contain
a file extension -- especially ".java" is invalid. When the source
code file is created, ".java" is appended automatically.emitImports
- if true
, then import statements for
the remotetea ONC/RPC package and IOExceptions.public static JrpcgenSHA createSHA(java.lang.String classname)
classname
- Name of class.public static void closeJavaSourceFile()
createJavaSourceFile
. This method writes a trailer
before closing the file.public static void dumpConstantAndDependency(java.io.PrintWriter out, JrpcgenConst c)
public static void dumpConstants()
public static void dumpEnum(JrpcgenEnum e)
e
- Description
of XDR enumeration.public static java.lang.String xdrBaseType(java.lang.String type)
null
.
NOTE: "opaque" is considered like "byte" to be a base type...
FIXME: char/byte?null
if the
given data type is not equivalent to one of Java's base data
types.public static JrpcgenEnDecodingInfo baseEnDecodingSyllable(JrpcgenDeclaration decl)
decl
- declaration of a member of RPC struct or union.null
, if the declaration does not specify a base data
type. Otherwise a three-element String array, with [0] containing
the type syllable for base type (including arrays), [1] containing
parameter options when encoding (like maximum sizes, etc), and [2]
containing options for decoding.public static java.lang.String codingMethod(JrpcgenDeclaration decl, boolean encode)
public static java.lang.String codingMethod(JrpcgenDeclaration decl, boolean encode, java.lang.String oref)
decl
- declaration for which the en-/decoding Java source code be
returned.encode
- true
if encoding method should be returned,
false
if decoding method is to be returned.oref
- name of object reference or null
if
"this" should be used instead.public static java.lang.String checkForSpecials(java.lang.String dataType)
dataType
- data type identifier to check.public static java.lang.String checkForEnumValue(java.lang.String value)
value
- Either an identifier to resolve or an integer literal.public static void dumpStruct(JrpcgenStruct s)
s
- Description
of XDR struct.public static void dumpUnion(JrpcgenUnion u)
u
- Description
of XDR union.public static void dumpTypedef(JrpcgenDeclaration d)
d
- Description
of XDR typedef.public static void dumpClasses()
public static void dumpClientStubMethods(java.io.PrintWriter out, JrpcgenVersionInfo versionInfo)
out
- Printer writer to send source code to.versionInfo
- Information about the remote program version for
which source code is to be generated.public static void dumpClient(JrpcgenProgramInfo programInfo)
public static void dumpServerStubMethodCall(java.io.PrintWriter out, JrpcgenProcedureInfo proc)
public static void dumpServerStubMethods(java.io.PrintWriter out, JrpcgenVersionInfo versionInfo)
public static void dumpServer(JrpcgenProgramInfo programInfo)
public static void dumpFiles()
public static void main(java.lang.String[] args)
public static void doParse() throws java.io.FileNotFoundException, java.lang.Exception
java.io.FileNotFoundException
java.lang.Exception