idl:generate

Full name:

com.addc.plugins:maven-idl-plugin:1.0.0:generate

Description:

Compile IDL files with the Jacorb idl compiler. By default this expects to find the idl files in src/main/idl and will generate the java files in src/main/generated .

Generally, the only elements you will need to set to generate the java files for your build.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
project MavenProject - The Maven Project Object

Optional Parameters

Name Type Since Description
amiCallbacks boolean - Ggenerate AMI reply handlers and sendc methods. Default value is: false.
amiPolling boolean - Generate AMI poller and sendp methods Default value is: false.
debugLevel int - The compiler debug level
defines String[] - Defines for compiling the idl files
diiStubs boolean - Generate DII-based client stubs Default value is: false.
excludes String[] - A list of exclusion filters for the compiler.
forceOverwrite boolean - Generate code even if IDL has not changed. Default value is: true.
generateEnhanced boolean - Generate stubs with toString/equals (only StructType) Default value is: true.
generateIncluded boolean - Generate all included idl files Default value is: false.
generateIr boolean - Generate extra information required by the JacORB Interface Repository (One extra file for each IDL module, and another additional file per IDL interface.) Default value is: false.
i2jpackages String[] - List of i2jpackage statements, these will have the format
<i2jpackage>x:a.b.c</i2jpackage> which replaces IDL package name x by a.b.c in generated Java code (e.g. CORBA:org.omg.CORBA).
includePaths File[] - A set of paths to include when searching for included idl files
includes String[] - A list of inclusion filters for the compiler.
noFinal boolean - Generated Java code will contain no final class definitions, which is the default to allow for compiler optimizations. Default value is: false.
noSkel boolean - Disable generation of POA skeletons (e.g., for client-side use) Default value is: false.
noStub boolean - Disable generation of client stubs (for server-side use) Default value is: false.
omgPrefix boolean - Prefix generated code with org.omg Default value is: false.
outputDirectory File - Directory containing the generated java files. This will be added to the compile source path automatically
parseOnly boolean - Only perform syntax check without generating code. Default value is: false.
sourceDirectory File - Directory where the idl files are found
uncheckedNarrow boolean - Use unchecked narrow in generated code for IOR parameters in operations (default is off). Generated helper classes contain marshalling code which, by default, will try to narrow any object references to statically known interface type. This may involve remote invocations to test a remote object's type, thus incurring runtime overhead to achieve static type safety. The -unchecked narrow option generates code that will not by statically type safe, but avoids remote tests of an object's type. If the type is not as expected, clients will experience CORBA.BAD OPERATION exceptions at invocation time. Default value is: false.
undefines String[] - Undefines for compiling the idl files

Parameter Details

amiCallbacks :

Ggenerate AMI reply handlers and sendc methods.

  • Type: boolean
  • Required: No
  • Default: false

amiPolling :

Generate AMI poller and sendp methods

  • Type: boolean
  • Required: No
  • Default: false

debugLevel :

The compiler debug level

  • Type: int
  • Required: No
  • Expression: 1

defines :

Defines for compiling the idl files

  • Type: java.lang.String[]
  • Required: No

diiStubs :

Generate DII-based client stubs

  • Type: boolean
  • Required: No
  • Default: false

excludes :

A list of exclusion filters for the compiler.

  • Type: java.lang.String[]
  • Required: No

forceOverwrite :

Generate code even if IDL has not changed.

  • Type: boolean
  • Required: No
  • Default: true

generateEnhanced :

Generate stubs with toString/equals (only StructType)

  • Type: boolean
  • Required: No
  • Default: true

generateIncluded :

Generate all included idl files

  • Type: boolean
  • Required: No
  • Default: false

generateIr :

Generate extra information required by the JacORB Interface Repository (One extra file for each IDL module, and another additional file per IDL interface.)

  • Type: boolean
  • Required: No
  • Default: false

i2jpackages :

List of i2jpackage statements, these will have the format
<i2jpackage>x:a.b.c</i2jpackage> which replaces IDL package name x by a.b.c in generated Java code (e.g. CORBA:org.omg.CORBA).

  • Type: java.lang.String[]
  • Required: No

includePaths :

A set of paths to include when searching for included idl files

  • Type: java.io.File[]
  • Required: No

includes :

A list of inclusion filters for the compiler.

  • Type: java.lang.String[]
  • Required: No

noFinal :

Generated Java code will contain no final class definitions, which is the default to allow for compiler optimizations.

  • Type: boolean
  • Required: No
  • Default: false

noSkel :

Disable generation of POA skeletons (e.g., for client-side use)

  • Type: boolean
  • Required: No
  • Default: false

noStub :

Disable generation of client stubs (for server-side use)

  • Type: boolean
  • Required: No
  • Default: false

omgPrefix :

Prefix generated code with org.omg

  • Type: boolean
  • Required: No
  • Default: false

outputDirectory :

Directory containing the generated java files. This will be added to the compile source path automatically

  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/generated

parseOnly :

Only perform syntax check without generating code.

  • Type: boolean
  • Required: No
  • Default: false

project :

The Maven Project Object

  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • Expression: ${project}

sourceDirectory :

Directory where the idl files are found

  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/idl

uncheckedNarrow :

Use unchecked narrow in generated code for IOR parameters in operations (default is off). Generated helper classes contain marshalling code which, by default, will try to narrow any object references to statically known interface type. This may involve remote invocations to test a remote object's type, thus incurring runtime overhead to achieve static type safety. The -unchecked narrow option generates code that will not by statically type safe, but avoids remote tests of an object's type. If the type is not as expected, clients will experience CORBA.BAD OPERATION exceptions at invocation time.

  • Type: boolean
  • Required: No
  • Default: false

undefines :

Undefines for compiling the idl files

  • Type: java.lang.String[]
  • Required: No