OpenJDK 27 · sun.rmi.transport.LiveRef · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private transient Channel	ch cached connection service for the object
private final Endpoint	ep wire representation for the object
private final ObjID	id
private final boolean	isLocal flag to indicate whether this ref specifies a local server or is a ref for a remote object (surrogate)

Constructor Summary

Access	Constructor and Description
public	LiveRef(ObjID objID, Endpoint endpoint, boolean If true, indicates this ref specifies a local server in this address space; if false, the ref is for a remote object (hence a surrogate or proxy) in another address space. isLocal) Construct a "well-known" live reference to a remote object
public	LiveRef(int port) Construct a new live reference for a server object in the local address space.
public	LiveRef(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Construct a new live reference for a server object in the local address space, to use sockets of the specified type.
public	LiveRef(ObjID objID, int port) Construct a new live reference for a "well-known" server object in the local address space.
public	LiveRef(ObjID objID, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Construct a new live reference for a "well-known" server object in the local address space, to use sockets of the specified type.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Return a shallow copy of this ref.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public void	exportObject(Target target) Export the object to accept incoming calls.
public Channel	getChannel()
public RMIClientSocketFactory	getClientSocketFactory() Return the client socket factory associated with this ref.
pack-priv Endpoint	getEndpoint()
public ObjID	getObjID()
public int	getPort() Return the port number associated with this ref.
public RMIServerSocketFactory	getServerSocketFactory() Return the server socket factory associated with this ref.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static LiveRef	read(ObjectInput in, boolean useNewFormat)
public boolean	remoteEquals(Object obj)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	write(ObjectOutput out, boolean useNewFormat)

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

Field Detail

ch	back to summary
private transient Channel ch cached connection service for the object

ep	back to summary
private final Endpoint ep wire representation for the object

id	back to summary
private final ObjID id

isLocal	back to summary
private final boolean isLocal flag to indicate whether this ref specifies a local server or is a ref for a remote object (surrogate)

Constructor Detail

LiveRef	back to summary
public LiveRef(ObjID objID, Endpoint endpoint, boolean isLocal) Construct a "well-known" live reference to a remote object Parameters isLocal:boolean If true, indicates this ref specifies a local server in this address space; if false, the ref is for a remote object (hence a surrogate or proxy) in another address space.

LiveRef

back to summary

public LiveRef(ObjID objID, Endpoint endpoint, boolean isLocal)

Construct a "well-known" live reference to a remote object

Parameters

isLocal:boolean: If true, indicates this ref specifies a local server in this address space; if false, the ref is for a remote object (hence a surrogate or proxy) in another address space.

LiveRef	back to summary
public LiveRef(int port) Construct a new live reference for a server object in the local address space.

LiveRef	back to summary
public LiveRef(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Construct a new live reference for a server object in the local address space, to use sockets of the specified type.

LiveRef	back to summary
public LiveRef(ObjID objID, int port) Construct a new live reference for a "well-known" server object in the local address space.

LiveRef	back to summary
public LiveRef(ObjID objID, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Construct a new live reference for a "well-known" server object in the local address space, to use sockets of the specified type.

Method Detail

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Return a shallow copy of this ref.

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

Return a shallow copy of this ref.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

exportObject	back to summary
public void exportObject(Target target) throws RemoteException Export the object to accept incoming calls.

getChannel	back to summary
public Channel getChannel() throws RemoteException

getClientSocketFactory	back to summary
public RMIClientSocketFactory getClientSocketFactory() Return the client socket factory associated with this ref. Note There is a JDK-internal dependency on the existence of this method in the implementation of javax.management.remote.rmi.RMIConnector.

getEndpoint	back to summary
pack-priv Endpoint getEndpoint()

getObjID	back to summary
public ObjID getObjID()

getPort	back to summary
public int getPort() Return the port number associated with this ref.

getServerSocketFactory	back to summary
public RMIServerSocketFactory getServerSocketFactory() Return the server socket factory associated with this ref.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

read	back to summary
public static LiveRef read(ObjectInput in, boolean useNewFormat) throws IOException, ClassNotFoundException

remoteEquals	back to summary
public boolean remoteEquals(Object obj)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

write	back to summary
public void write(ObjectOutput out, boolean useNewFormat) throws IOException

public Class LiveRef

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail