Package | Description |
---|---|
java.rmi |
Provides the RMI package.
|
java.rmi.activation |
Provides support for RMI Object Activation.
|
java.rmi.dgc |
Provides classes and interface for RMI distributed
garbage-collection (DGC).
|
java.rmi.registry |
Provides a class and two interfaces for the RMI registry.
|
java.rmi.server |
Provides classes and interfaces for supporting the server
side of RMI.
|
javax.activity |
Contains Activity service related exceptions thrown by the ORB machinery during
unmarshalling.
|
javax.management.remote.rmi |
The RMI connector is a connector for the JMX Remote API that
uses RMI to transmit client requests to a remote MBean server.
|
javax.rmi |
Contains user APIs for RMI-IIOP.
|
javax.rmi.CORBA |
Contains portability APIs for RMI-IIOP.
|
javax.transaction |
Contains three exceptions thrown by the ORB machinery during unmarshalling.
|
Modifier and Type | Class and Description |
---|---|
class |
AccessException
An
AccessException is thrown by certain methods of the
java.rmi.Naming class (specifically bind ,
rebind , and unbind ) and methods of the
java.rmi.activation.ActivationSystem interface to
indicate that the caller does not have permission to perform the action
requested by the method call. |
class |
ConnectException
A
ConnectException is thrown if a connection is refused
to the remote host for a remote method call. |
class |
ConnectIOException
A
ConnectIOException is thrown if an
IOException occurs while making a connection
to the remote host for a remote method call. |
class |
MarshalException
A
MarshalException is thrown if a
java.io.IOException occurs while marshalling the remote call
header, arguments or return value for a remote method call. |
class |
NoSuchObjectException
A
NoSuchObjectException is thrown if an attempt is made to
invoke a method on an object that no longer exists in the remote virtual
machine. |
class |
ServerError
A
ServerError is thrown as a result of a remote method
invocation when an Error is thrown while processing
the invocation on the server, either while unmarshalling the arguments,
executing the remote method itself, or marshalling the return value. |
class |
ServerException
A
ServerException is thrown as a result of a remote method
invocation when a RemoteException is thrown while processing
the invocation on the server, either while unmarshalling the arguments or
executing the remote method itself. |
class |
ServerRuntimeException
Deprecated.
no replacement
|
class |
StubNotFoundException
A
StubNotFoundException is thrown if a valid stub class
could not be found for a remote object when it is exported. |
class |
UnexpectedException
An
UnexpectedException is thrown if the client of a
remote method call receives, as a result of the call, a checked
exception that is not among the checked exception types declared in the
throws clause of the method in the remote interface. |
class |
UnknownHostException
An
UnknownHostException is thrown if a
java.net.UnknownHostException occurs while creating
a connection to the remote host for a remote method call. |
class |
UnmarshalException
An
UnmarshalException can be thrown while unmarshalling the
parameters or results of a remote method call if any of the following
conditions occur:
if an exception occurs while unmarshalling the call header
if the protocol for the return value is invalid
if a java.io.IOException occurs unmarshalling
parameters (on the server side) or the return value (on the client side). |
Modifier and Type | Method and Description |
---|---|
static void |
Naming.bind(String name,
Remote obj)
Binds the specified
name to a remote object. |
static String[] |
Naming.list(String name)
Returns an array of the names bound in the registry.
|
static Remote |
Naming.lookup(String name)
Returns a reference, a stub, for the remote object associated
with the specified
name . |
static void |
Naming.rebind(String name,
Remote obj)
Rebinds the specified name to a new remote object.
|
static void |
Naming.unbind(String name)
Destroys the binding for the specified name that is associated
with a remote object.
|
Modifier and Type | Class and Description |
---|---|
class |
ActivateFailedException
This exception is thrown by the RMI runtime when activation
fails during a remote call to an activatable object.
|
Modifier and Type | Method and Description |
---|---|
MarshalledObject<? extends Remote> |
Activator.activate(ActivationID id,
boolean force)
Activate the object associated with the activation identifier,
id . |
Remote |
ActivationID.activate(boolean force)
Activate the object for this id.
|
ActivationMonitor |
ActivationSystem.activeGroup(ActivationGroupID id,
ActivationInstantiator group,
long incarnation)
Callback to inform activation system that group is now
active.
|
protected void |
ActivationGroup.activeObject(ActivationID id,
MarshalledObject<? extends Remote> mobj)
This protected method is necessary for subclasses to
make the
activeObject callback to the group's
monitor. |
void |
ActivationMonitor.activeObject(ActivationID id,
MarshalledObject<? extends Remote> obj)
Informs that an object is now active.
|
abstract void |
ActivationGroup.activeObject(ActivationID id,
Remote obj)
The group's
activeObject method is called when an
object is exported (either by Activatable object
construction or an explicit call to
Activatable.exportObject . |
static Remote |
Activatable.exportObject(Remote obj,
ActivationID id,
int port)
Export the activatable remote object to the RMI runtime to make
the object available to receive incoming calls.
|
static Remote |
Activatable.exportObject(Remote obj,
ActivationID id,
int port,
RMIClientSocketFactory csf,
RMIServerSocketFactory ssf)
Export the activatable remote object to the RMI runtime to make
the object available to receive incoming calls.
|
static ActivationID |
Activatable.exportObject(Remote obj,
String location,
MarshalledObject<?> data,
boolean restart,
int port)
Registers an activation descriptor (with the specified location,
data, and restart mode) for the specified object, and exports that
object with the specified port.
|
static ActivationID |
Activatable.exportObject(Remote obj,
String location,
MarshalledObject<?> data,
boolean restart,
int port,
RMIClientSocketFactory csf,
RMIServerSocketFactory ssf)
Registers an activation descriptor (with the specified location,
data, and restart mode) for the specified object, and exports that
object with the specified port, and the specified client and server
socket factories.
|
ActivationDesc |
ActivationSystem.getActivationDesc(ActivationID id)
Returns the activation descriptor, for the object with the activation
identifier,
id . |
ActivationGroupDesc |
ActivationSystem.getActivationGroupDesc(ActivationGroupID id)
Returns the activation group descriptor, for the group
with the activation group identifier,
id . |
static boolean |
Activatable.inactive(ActivationID id)
Informs the system that the object with the corresponding activation
id is currently inactive. |
protected void |
ActivationGroup.inactiveGroup()
This protected method is necessary for subclasses to
make the
inactiveGroup callback to the group's
monitor. |
void |
ActivationMonitor.inactiveGroup(ActivationGroupID id,
long incarnation)
Informs that the group is now inactive.
|
boolean |
ActivationGroup.inactiveObject(ActivationID id)
The group's
inactiveObject method is called
indirectly via a call to the Activatable.inactive
method. |
void |
ActivationMonitor.inactiveObject(ActivationID id)
An activation group calls its monitor's
inactiveObject method when an object in its group
becomes inactive (deactivates). |
MarshalledObject |
ActivationGroup_Stub.newInstance(ActivationID id,
ActivationDesc desc)
Stub method for
ActivationGroup.newInstance . |
MarshalledObject<? extends Remote> |
ActivationInstantiator.newInstance(ActivationID id,
ActivationDesc desc)
The activator calls an instantiator's
newInstance
method in order to recreate in that group an object with the
activation identifier, id , and descriptor,
desc . |
static Remote |
Activatable.register(ActivationDesc desc)
Register an object descriptor for an activatable remote
object so that is can be activated on demand.
|
ActivationGroupID |
ActivationSystem.registerGroup(ActivationGroupDesc desc)
Register the activation group.
|
ActivationID |
ActivationSystem.registerObject(ActivationDesc desc)
The
registerObject method is used to register an
activation descriptor, desc , and obtain an
activation identifier for a activatable remote object. |
ActivationDesc |
ActivationSystem.setActivationDesc(ActivationID id,
ActivationDesc desc)
Set the activation descriptor,
desc for the object with
the activation identifier, id . |
ActivationGroupDesc |
ActivationSystem.setActivationGroupDesc(ActivationGroupID id,
ActivationGroupDesc desc)
Set the activation group descriptor,
desc for the object
with the activation group identifier, id . |
void |
ActivationSystem.shutdown()
Shutdown the activation system.
|
static void |
Activatable.unregister(ActivationID id)
Revokes previous registration for the activation descriptor
associated with
id . |
void |
ActivationSystem.unregisterGroup(ActivationGroupID id)
Remove the activation group.
|
void |
ActivationSystem.unregisterObject(ActivationID id)
Remove the activation id and associated descriptor previously
registered with the
ActivationSystem ; the object
can no longer be activated via the object's activation id. |
Constructor and Description |
---|
Activatable(ActivationID id,
int port)
Constructor used to activate/export the object on a specified
port.
|
Activatable(ActivationID id,
int port,
RMIClientSocketFactory csf,
RMIServerSocketFactory ssf)
Constructor used to activate/export the object on a specified
port.
|
Activatable(String location,
MarshalledObject<?> data,
boolean restart,
int port)
Constructs an activatable remote object by registering
an activation descriptor (with the specified location, data, and
restart mode) for this object, and exporting the object with the
specified port.
|
Activatable(String location,
MarshalledObject<?> data,
boolean restart,
int port,
RMIClientSocketFactory csf,
RMIServerSocketFactory ssf)
Constructs an activatable remote object by registering
an activation descriptor (with the specified location, data, and
restart mode) for this object, and exporting the object with the
specified port, and specified client and server socket factories.
|
ActivationGroup(ActivationGroupID groupID)
Constructs an activation group with the given activation group
identifier.
|
Modifier and Type | Method and Description |
---|---|
void |
DGC.clean(ObjID[] ids,
long sequenceNum,
VMID vmid,
boolean strong)
The clean call removes the 'vmid' from the reference list of
each remote object indicated in 'id's.
|
Lease |
DGC.dirty(ObjID[] ids,
long sequenceNum,
Lease lease)
The dirty call requests leases for the remote object references
associated with the object identifiers contained in the array
'ids'.
|
Modifier and Type | Method and Description |
---|---|
void |
Registry.bind(String name,
Remote obj)
Binds a remote reference to the specified
name in
this registry. |
static Registry |
LocateRegistry.createRegistry(int port)
Creates and exports a
Registry instance on the local
host that accepts requests on the specified port . |
static Registry |
LocateRegistry.createRegistry(int port,
RMIClientSocketFactory csf,
RMIServerSocketFactory ssf)
Creates and exports a
Registry instance on the local
host that uses custom socket factories for communication with that
instance. |
static Registry |
LocateRegistry.getRegistry()
Returns a reference to the the remote object
Registry for
the local host on the default registry port of 1099. |
static Registry |
LocateRegistry.getRegistry(int port)
Returns a reference to the the remote object
Registry for
the local host on the specified port . |
static Registry |
LocateRegistry.getRegistry(String host)
Returns a reference to the remote object
Registry on the
specified host on the default registry port of 1099. |
static Registry |
LocateRegistry.getRegistry(String host,
int port)
Returns a reference to the remote object
Registry on the
specified host and port . |
static Registry |
LocateRegistry.getRegistry(String host,
int port,
RMIClientSocketFactory csf)
Returns a locally created remote reference to the remote object
Registry on the specified host and
port . |
String[] |
Registry.list()
Returns an array of the names bound in this registry.
|
Remote |
Registry.lookup(String name)
Returns the remote reference bound to the specified
name in this registry. |
void |
Registry.rebind(String name,
Remote obj)
Replaces the binding for the specified
name in
this registry with the supplied remote reference. |
Registry |
RegistryHandler.registryImpl(int port)
Deprecated.
no replacement. As of the Java 2 platform v1.2, RMI no
longer uses the
RegistryHandler to obtain the registry's
implementation. |
Registry |
RegistryHandler.registryStub(String host,
int port)
Deprecated.
no replacement. As of the Java 2 platform v1.2, RMI no
longer uses the
RegistryHandler to obtain the registry's
stub. |
void |
Registry.unbind(String name)
Removes the binding for the specified
name in
this registry. |
Modifier and Type | Class and Description |
---|---|
class |
ExportException
An
ExportException is a RemoteException
thrown if an attempt to export a remote object fails. |
class |
SkeletonMismatchException
Deprecated.
no replacement. Skeletons are no longer required for remote
method calls in the Java 2 platform v1.2 and greater.
|
class |
SkeletonNotFoundException
Deprecated.
no replacement. Skeletons are no longer required for remote
method calls in the Java 2 platform v1.2 and greater.
|
class |
SocketSecurityException
Deprecated.
This class is obsolete. Use
ExportException instead. |
Modifier and Type | Method and Description |
---|---|
void |
RemoteRef.done(RemoteCall call)
Deprecated.
1.2 style stubs no longer use this method. Instead of
using a sequence of method calls to the remote reference
(
newCall , invoke , and done ), a
stub uses a single method, invoke(Remote, Method, Object[],
int) , on the remote reference to carry out parameter
marshalling, remote method executing and unmarshalling of the return
value. |
static RemoteStub |
UnicastRemoteObject.exportObject(Remote obj)
Deprecated.
This method is deprecated because it supports only static stubs.
Use
exportObject(Remote, port) or
exportObject(Remote, port, csf, ssf)
instead. |
static Remote |
UnicastRemoteObject.exportObject(Remote obj,
int port)
Exports the remote object to make it available to receive incoming
calls, using the particular supplied port.
|
static Remote |
UnicastRemoteObject.exportObject(Remote obj,
int port,
RMIClientSocketFactory csf,
RMIServerSocketFactory ssf)
Exports the remote object to make it available to receive incoming
calls, using a transport specified by the given socket factory.
|
RemoteStub |
ServerRef.exportObject(Remote obj,
Object data)
Deprecated.
Creates a client stub object for the supplied Remote object.
|
RemoteCall |
RemoteRef.newCall(RemoteObject obj,
Operation[] op,
int opnum,
long hash)
Deprecated.
1.2 style stubs no longer use this method. Instead of
using a sequence of method calls on the stub's the remote reference
(
newCall , invoke , and done ), a
stub uses a single method, invoke(Remote, Method, Object[],
int) , on the remote reference to carry out parameter
marshalling, remote method executing and unmarshalling of the return
value. |
Constructor and Description |
---|
UnicastRemoteObject()
Creates and exports a new UnicastRemoteObject object using an
anonymous port.
|
UnicastRemoteObject(int port)
Creates and exports a new UnicastRemoteObject object using the
particular supplied port.
|
UnicastRemoteObject(int port,
RMIClientSocketFactory csf,
RMIServerSocketFactory ssf)
Creates and exports a new UnicastRemoteObject object using the
particular supplied port and socket factories.
|
Modifier and Type | Class and Description |
---|---|
class |
ActivityCompletedException
This exception may be thrown on any method for which Activity context is
accessed and indicates that ongoing work within the Activity is not
possible.
|
class |
ActivityRequiredException
This exception is thrown by a container if Activity context is not received
on a method for which Activity context is mandatory.
|
class |
InvalidActivityException
This exception may be thrown on any method for which Activity context
is accessed and indicates that the attempted invocation or the Activity
context associated with the attempted invocation is incompatible with
the Activity's current state.
|
Modifier and Type | Method and Description |
---|---|
String |
RMIServerImpl_Stub.getVersion() |
String |
RMIServer.getVersion()
The version of the RMI Connector Protocol understood by this
connector server.
|
Modifier and Type | Method and Description |
---|---|
static void |
PortableRemoteObject.connect(Remote target,
Remote source)
Makes a Remote object ready for remote communication.
|
static void |
PortableRemoteObject.exportObject(Remote obj)
Makes a server object ready to receive remote calls.
|
Constructor and Description |
---|
PortableRemoteObject()
Initializes the object by calling
exportObject(this) . |
Modifier and Type | Method and Description |
---|---|
static RemoteException |
Util.mapSystemException(SystemException ex)
Maps a SystemException to a RemoteException.
|
RemoteException |
UtilDelegate.mapSystemException(SystemException ex)
Delegation call for
Util.mapSystemException(org.omg.CORBA.SystemException) . |
static RemoteException |
Util.wrapException(Throwable orig)
Wraps an exception thrown by an implementation
method.
|
RemoteException |
UtilDelegate.wrapException(Throwable obj)
Delegation call for
Util.wrapException(java.lang.Throwable) . |
Modifier and Type | Method and Description |
---|---|
void |
Stub.connect(ORB orb)
Connects this stub to an ORB.
|
void |
PortableRemoteObjectDelegate.connect(Remote target,
Remote source)
Delegation call for
PortableRemoteObject.connect(java.rmi.Remote, java.rmi.Remote) . |
void |
StubDelegate.connect(Stub self,
ORB orb)
Delegation call for
Stub.connect(org.omg.CORBA.ORB) . |
static Object |
Util.copyObject(Object obj,
ORB orb)
Copies or connects an object.
|
Object |
UtilDelegate.copyObject(Object obj,
ORB orb)
Delegation call for
Util.copyObject(java.lang.Object, org.omg.CORBA.ORB) . |
static Object[] |
Util.copyObjects(Object[] obj,
ORB orb)
Copies or connects an array of objects.
|
Object[] |
UtilDelegate.copyObjects(Object[] obj,
ORB orb)
Delegation call for
Util.copyObjects(java.lang.Object[], org.omg.CORBA.ORB) . |
void |
PortableRemoteObjectDelegate.exportObject(Remote obj)
Delegation call for
PortableRemoteObject.exportObject(java.rmi.Remote) . |
static boolean |
Util.isLocal(Stub stub)
The isLocal method has the same semantics as the
ObjectImpl._is_local
method, except that it can throw a RemoteException.
|
boolean |
UtilDelegate.isLocal(Stub stub)
Delegation call for
Util.isLocal(javax.rmi.CORBA.Stub) . |
Modifier and Type | Class and Description |
---|---|
class |
InvalidTransactionException
This exception indicates that the request carried an invalid transaction
context.
|
class |
TransactionRequiredException
This exception indicates that a request carried a null transaction context,
but the target object requires an activate transaction.
|
class |
TransactionRolledbackException
This exception indicates that the transaction associated with processing
of the request has been rolled back, or marked to roll back.
|
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2024, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.