blob: 822d37660a65b485c9f2aacd7207952c06a8ef83 [file] [log] [blame]
mfangf2cf0062015-07-15 12:12:46 -07001'\" t
2.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
3.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4.\"
5.\" This code is free software; you can redistribute it and/or modify it
6.\" under the terms of the GNU General Public License version 2 only, as
7.\" published by the Free Software Foundation.
8.\"
9.\" This code is distributed in the hope that it will be useful, but WITHOUT
10.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12.\" version 2 for more details (a copy is included in the LICENSE file that
13.\" accompanied this code).
14.\"
15.\" You should have received a copy of the GNU General Public License version
16.\" 2 along with this work; if not, write to the Free Software Foundation,
17.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18.\"
19.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20.\" or visit www.oracle.com if you need additional information or have any
21.\" questions.
22.\"
23.\" Arch: generic
24.\" Software: JDK 8
25.\" Date: 21 November 2013
26.\" SectDesc: Remote Method Invocation (RMI) Tools
27.\" Title: rmiregistry.1
28.\"
29.if n .pl 99999
30.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools"
31.\" -----------------------------------------------------------------
32.\" * Define some portability stuff
33.\" -----------------------------------------------------------------
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.\" http://bugs.debian.org/507673
36.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
37.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38.ie \n(.g .ds Aq \(aq
39.el .ds Aq '
40.\" -----------------------------------------------------------------
41.\" * set default formatting
42.\" -----------------------------------------------------------------
43.\" disable hyphenation
44.nh
45.\" disable justification (adjust text to left margin only)
46.ad l
47.\" -----------------------------------------------------------------
48.\" * MAIN CONTENT STARTS HERE *
49.\" -----------------------------------------------------------------
50
51.SH NAME
52rmiregistry \- Starts a remote object registry on the specified port on the current host\&.
53.SH SYNOPSIS
54.sp
55.nf
56
57\fBrmiregistry\fR [ \fIport\fR ]
58.fi
59.sp
60.TP
61\fIport\fR
62The number of a \f3port\fR on the current host at which to start the remote object registry\&.
63.SH DESCRIPTION
64The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example:
65.sp
66.nf
67\f3rmiregistry &\fP
68.fi
69.nf
70\f3\fP
71.fi
72.sp
73A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&.
74.PP
75The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&.
76.PP
77The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&.
78.PP
79The URL-based methods of the \f3java\&.rmi\&.Naming\fR class operate on a registry and can be used to look up a remote object on any host and on the local host\&. Bind a simple name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&.
80.SH OPTIONS
81.TP
82-J
83.br
84Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&.
85.SH SEE\ ALSO
86.TP 0.2i
87\(bu
88java(1)
89.TP 0.2i
90\(bu
91\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html
92.TP 0.2i
93\(bu
94\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html
95.RE
96.br
97'pl 8.5i
98'bp