ctmidl2j (generate Java stub code)

Format

ctmidl2j  [-h] |
          [-package package-name]
          [-CTMroot_dir path-name] [-root_dir path-name]
          [-gen_included_files]
          [[-I directory[;directory...]]...]
          [-A] IDL-file

To Page Top

Function

This command generates Java stub code for the OTM client from an IDL file.

To Page Top

Arguments

-h

Displays how to use the command.

-package package-name

Specifies the package name that will be prefixed to the package names defined in the IDL files. If a directory with the same name as the specified package name does not exist, the directory is automatically created. If such a directory already exists, the contents of the directory are updated. Note that the command can communicate with components that use the same user-defined IDL interface even if the -package option is not specified.

-TSCroot_dir path-name

Specifies the directory to which the source file and header file will be output. If a non-existent directory is specified, it is automatically created.

-root_dir path-name

Specifies the directory to which the source file and header file output by the idl2java command will be output.

-gen_included_files

If this option is specified, the command outputs included IDL definitions.

-I directory[;directory...]

Specifies the include file search paths. In UNIX, to specify multiple search paths, use a colon (:) as a path separator. In Windows, to specify multiple search paths, use a semicolon (;) as a separator. Alternatively, specify the -I option for each search path.

-A

If this option is specified, osagent is not internally started. Specify this option if osagent has already been started on the local host.

IDL-file

Specifies the name of the IDL file to be input. You can omit this option only when you specify the -h option. Make sure that this option is specified at the end of the command line. Also make sure that the extension of the IDL file name is .idl.

To Page Top

Return values

0:

The command ended normally.

Other than 0:

The command terminated abnormally due to an error that occurred during command processing. Take measures as indicated in the message that is output, and then re-execute the command.

To Page Top

Notes

• The command behavior partly differs depending on the OTM version.

• Set the TSCDIR environment variable.

• Make sure that the shared libraries and commands for TPBroker compatible with the version of the OTM client can be used. If the OTM client is V3, set the directory for TPBroker V3. If the OTM client is V5, set the directory for TPBroker V5.

  Table 6‒3: Environment variable settings required for executing the command

  OTM client	Product that requires the environment variable to be set
  	OTM V3	OTM V5	TPBroker V3	TPBroker V5	CTM
  V3	Y	N	Y	N	Y
  V5	N	Y	N	Y	Y

  Legend:

  Y: Setting of an environment variable is required.

  N: Setting of an environment variable is not required.

• For the PATH environment variable, set the paths of the directories that contain the following: osagent, idl2ir, and irep for TPBroker; and tscidl2cpp for OTM.

• Make sure that a space is entered between an option and its argument.

• If the IDL file contains definitions that cannot be used for CTM, the command might behave incorrectly or generate an invalid file.

• During execution of the ctmidl2j command, messages might be output by TPBroker and OTM that are used internally.

To Page Top