agilermi.core

Class RMIHandler

java.lang.Object

agilermi.core.RMIHandler

public final class RMIHandler
extends java.lang.Object

This class defines a RMI connection handler. The instances of this class manages all the RMI communication protocol between the local machine and a remote machine. This class can be instantiated through the RMIRegistry only. See the getRMIHandler(...) method

Author:

Salvatore Giampa'

Method Summary

Modifier and Type	Method and Description
void	dispose(boolean signalFault) Dispose this RMIHandler and frees all the used resources and threads.
boolean	equals(java.lang.Object obj)
java.lang.Exception	getDispositionException() Gets the exception that caused this handler to be disposed.
long	getDispositionTime() Gets the time at which this handler has been disposed.
java.net.InetSocketAddress	getInetSocketAddress() Gets the address of the remote process (IP address + TCP port)
java.lang.Object	getStub(java.lang.String objectId) Gets a stub for the specified object identifier representing a remote object on the remote machine.
java.lang.Object	getStub(java.lang.String objectId, java.lang.Class<?>... stubInterfaces) Gets a stub for the specified object identifier respect to the specified interfaces, representing a remote object on the remote machine.
int	hashCode()
boolean	isDisposed() Gets the disposed status of this peer
boolean	isOwnStub(java.lang.Object stub) Check if the given object is a stub created by this handler
void	removeOwnStubs(java.lang.Iterable<?> objects) Removes all the objects that are stubs created by this handler from the specified iterable object
void	retainOwnStubs(java.lang.Iterable<?> objects) Removes all the objects that are not stubs created by this handler from the specified iterable object
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dispose

public void dispose(boolean signalFault)

Dispose this RMIHandler and frees all the used resources and threads. A call to this method can cause a callback on the RMIFaultHandler instances attached to the RMIRegistry associated to this instance sending them the disposition exception of this handler (See getDispositionException()).

Parameters:

signalFault - set to true if this RMIHandler should send a signal to the RMIFaultHandler instances attached to the RMIRegistry that created this instance

getInetSocketAddress

public java.net.InetSocketAddress getInetSocketAddress()

Gets the address of the remote process (IP address + TCP port)

Returns:

the InetSocketAddress containing remote host address and port

isOwnStub

public boolean isOwnStub(java.lang.Object stub)

Check if the given object is a stub created by this handler

Parameters:

stub - the object to check

Returns:

true if the object is a stub created by this handler, false otherwise

removeOwnStubs

public void removeOwnStubs(java.lang.Iterable<?> objects)

Removes all the objects that are stubs created by this handler from the specified iterable object

Parameters:

objects - the iterable object to analyze

retainOwnStubs

public void retainOwnStubs(java.lang.Iterable<?> objects)

Removes all the objects that are not stubs created by this handler from the specified iterable object

Parameters:

objects - the iterable object to analyze

isDisposed

public boolean isDisposed()

Gets the disposed status of this peer

Returns:

true if this peer has been disposed, false otherwise

getStub

public java.lang.Object getStub(java.lang.String objectId)
                         throws java.net.UnknownHostException,
                                java.io.IOException,
                                java.lang.InterruptedException

Gets a stub for the specified object identifier representing a remote object on the remote machine. This method performs a request to the remote machine to get the remote interfaces of the remote object, then creates its stub. All the remote interfaces of the remote object must be visible by the default class loader and they must be known by the local runtime.

Parameters:

objectId - the object identifier

Returns:

A dynamic proxy object that represents the remote instance. It is an instance for the specified stub interface

Throws:

java.net.UnknownHostException - if the host cannot be resolved

java.io.IOException - if an I/O error occurs

java.lang.InterruptedException - if the current thread is iterrupted during operation

getStub

public java.lang.Object getStub(java.lang.String objectId,
                                java.lang.Class<?>... stubInterfaces)

Gets a stub for the specified object identifier respect to the specified interfaces, representing a remote object on the remote machine. This method performs no network operation, just creates the stub. All the interfaces passed must be visible by the class loader of the first interface.

Parameters:

objectId - the object identifier

stubInterfaces - the interface whose methods must be stubbed, that is the interface used to access the remote object operations

Returns:

A dynamic proxy object that represents the remote instance. It is an instance for the specified stub interface

getDispositionTime

public long getDispositionTime()

Gets the time at which this handler has been disposed.

Returns:

a long value in milliseconds

getDispositionException

public java.lang.Exception getDispositionException()

Gets the exception that caused this handler to be disposed.

Returns:

an Exception

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object