< prev index next >

src/jdk.rmic/share/man/rmic.1

Print this page
rev 55120 : 8217412: deprecate rmic for removal
Reviewed-by: XXX


  47 .\" -----------------------------------------------------------------
  48 .\" * MAIN CONTENT STARTS HERE *
  49 .\" -----------------------------------------------------------------
  50 
  51 .SH NAME    
  52 rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL)
  53 .SH SYNOPSIS    
  54 .sp     
  55 .nf     
  56 
  57 \fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR
  58 .fi     
  59 .sp     
  60 .TP     
  61 \fIoptions\fR
  62 The command-line \f3options\fR\&. See Options\&.
  63 .TP     
  64 \fIpackage-qualified-class-names\fR
  65 Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&.
  66 .SH DESCRIPTION    
  67 \fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&.
  68 .PP
  69 The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class files are generated from compiled Java programming language classes that are remote object implementation classes\&. A remote implementation class is a class that implements the interface \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package):
  70 .sp     
  71 .nf     
  72 \f3rmic hello\&.HelloImpl\fP
  73 .fi     
  74 .nf     
  75 \f3\fP
  76 .fi     
  77 .sp     
  78 A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&.
  79 .PP
  80 A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&.
  81 .PP
  82 A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&.
  83 .PP
  84 By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&.
  85 .PP
  86 A stub implements only the remote interfaces, and not any local interfaces that the remote object also implements\&. Because a JRMP stub implements the same set of remote interfaces as the remote object, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&.
  87 .SH OPTIONS    




  47 .\" -----------------------------------------------------------------
  48 .\" * MAIN CONTENT STARTS HERE *
  49 .\" -----------------------------------------------------------------
  50 
  51 .SH NAME    
  52 rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL)
  53 .SH SYNOPSIS    
  54 .sp     
  55 .nf     
  56 
  57 \fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR
  58 .fi     
  59 .sp     
  60 .TP     
  61 \fIoptions\fR
  62 The command-line \f3options\fR\&. See Options\&.
  63 .TP     
  64 \fIpackage-qualified-class-names\fR
  65 Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&.
  66 .SH DESCRIPTION    
  67 \fIDeprecation Note:\fR The \f3rmic\fR tool has been deprecated and is subject to removal in a future release\&. Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Applications should use dynamically generated JRMP stubs, eliminating the need to use the \f3rmic\fR tool for JRMP-based applications\&.
  68 .PP
  69 The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class files are generated from compiled Java programming language classes that are remote object implementation classes\&. A remote implementation class is a class that implements the interface \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package):
  70 .sp     
  71 .nf     
  72 \f3rmic hello\&.HelloImpl\fP
  73 .fi     
  74 .nf     
  75 \f3\fP
  76 .fi     
  77 .sp     
  78 A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&.
  79 .PP
  80 A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&.
  81 .PP
  82 A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&.
  83 .PP
  84 By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&.
  85 .PP
  86 A stub implements only the remote interfaces, and not any local interfaces that the remote object also implements\&. Because a JRMP stub implements the same set of remote interfaces as the remote object, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&.
  87 .SH OPTIONS    


< prev index next >