org.acplt.oncrpc.maven.plugin

Class JRpcGeneratorBase

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.acplt.oncrpc.maven.plugin.JRpcGeneratorBase

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

JRpcClientGenerator, JRpcGenerator, JRpcServerGenerator

public abstract class JRpcGeneratorBase
extends org.apache.maven.plugin.AbstractMojo

Base class of the maven plugin to run the ONC/RPC '.x' file compiler provided in the Remote Tea library within Maven projects.

The Remote Tea library is a complete open source implementation of the ONC/RPC standard, originally developed by the Chair of Process Control Engineering of University of Aachen, Germany.

Remote Tea can be found at https://sourceforge.net/projects/remotetea/.

The plugin parameters that can be specified within the element configuration in the POM are:

• srcfile : '.x' file to compile (mandatory)
• destdir : directory where generated files need to be placed (mandatory). If a 'package' directive is used, do not add the package directories to destDir (it is done automatically by the task)
• package : package name to be used for generated files (optional)
• createdir : indicates whether jrpcgen must create destdir if it does not exist (optional). Defaults to no.
• verbose : indicates whether jrpcgen must be verbose (optional). Defaults to no.
• debug : indicates whether jrpcgen must trace debug information (optional). Defaults to no.
• backup : indicates whether jrpcgen must backup files (optional). Defaults to no.
• serverTcpOnly : indicates whether jrpcgen shall generate the server stub for the TCP transport, only (optional). Defaults to no.
• serverUdpOnly : indicates whether jrpcgen shall generate the server stub for the UDP transport, only (optional). Defaults to no.
• bean : indicates whether jrpcgen shall generate the XDR datatype classes with getters and setters for bean usage (optional). Setting this attribute to true implies setting the attribute serializable to true as well. Defaults to no.
• serializable : indicates whether jrpcgen shall tag the XDR datatype classes as serializable by adding the private static final field serialVersionUID (optional). Defaults to no.
• noValueCtor : indicates whether jrpcgen shall skip the generation of value constructors for the XDR datatype classes (optional). Defaults to no.
• noToString : indicates whether jrpcgen shall skip the generation of the toString() - methods for the XDR datatype classes (optional). Defaults to no.
• noEquals : indicates whether jrpcgen shall skip the generation of the equals() - and hashCode() - methods for the XDR datatype classes (optional). Defaults to no.
• noEnum : indicates whether jrpcgen shall fall back to Java interfaces instead of Java enumerations as mapping for enumerations specified in an x-file (optional). Defaults to no.
• initStrings : indicates whether jrpcgen shall intialize string fields with an empty string instead of null (optional). Defaults to no.
• noClamp : indicates whether generated client calls shall get the version from the client instance instead of getting a hard coded value referring to the version number specified in the x-file (optional). Defaults to no.
• withCallInfo : indicates whether the generated server stub methods shall get the ONC/RPC call information as first parameter (optional). Defaults to no.

Author:

Harald Wirths <hwirths@nde.ag>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	backup
protected boolean	bean
protected boolean	createDir
protected boolean	debug
protected File	destDir
protected boolean	initStrings
protected boolean	noClamp
protected boolean	noEnum
protected boolean	noEquals
protected boolean	noToString
protected boolean	noValueCtor
protected JrpcgenOptions	options
protected String	packageName
protected boolean	serializable
protected boolean	serverTcpOnly
protected boolean	serverUdpOnly
protected boolean	verbose
protected boolean	withCallInfo
protected File	xFile

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JRpcGeneratorBase()

Method Summary

Modifier and Type	Method and Description
protected void	checkAttributes()
protected void	dumpState()
protected void	generateSources()
protected void	logDebug(String format, Object... arguments)
protected void	logError(String format, Object... arguments)
protected void	logInfo(String format, Object... arguments)
protected void	logWarn(String format, Object... arguments)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

xFile

@Parameter(required=true)
protected File xFile

destDir

@Parameter(required=true)
protected File destDir

packageName

@Parameter(required=true)
protected String packageName

debug

@Parameter(defaultValue="false")
protected boolean debug

verbose

@Parameter(defaultValue="false")
protected boolean verbose

backup

@Parameter(defaultValue="false")
protected boolean backup

createDir

@Parameter(defaultValue="false")
protected boolean createDir

serverTcpOnly

@Parameter(defaultValue="false")
protected boolean serverTcpOnly

serverUdpOnly

@Parameter(defaultValue="false")
protected boolean serverUdpOnly

bean

@Parameter(defaultValue="false")
protected boolean bean

serializable

@Parameter(defaultValue="false")
protected boolean serializable

noValueCtor

@Parameter(defaultValue="false")
protected boolean noValueCtor

noToString

@Parameter(defaultValue="false")
protected boolean noToString

noEquals

@Parameter(defaultValue="false")
protected boolean noEquals

noEnum

@Parameter(defaultValue="false")
protected boolean noEnum

initStrings

@Parameter(defaultValue="false")
protected boolean initStrings

noClamp

@Parameter(defaultValue="false")
protected boolean noClamp

withCallInfo

@Parameter(defaultValue="false")
protected boolean withCallInfo

options

protected final JrpcgenOptions options

Constructor Detail

JRpcGeneratorBase

protected JRpcGeneratorBase()

Method Detail

generateSources

protected void generateSources()
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

checkAttributes

protected void checkAttributes()
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

dumpState

protected void dumpState()
                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

logDebug

protected void logDebug(String format,
                        Object... arguments)

logInfo

protected void logInfo(String format,
                       Object... arguments)

logWarn

protected void logWarn(String format,
                       Object... arguments)

logError

protected void logError(String format,
                        Object... arguments)