Modifier and Type	Class and Description
private static class	TCPEndpoint.FQDN The class FQDN encapsulates a routine that makes a best effort attempt to retrieve the fully qualified domain name of the local host.

Modifier and Type	Field and Description
private final RMIClientSocketFactory	csf custom client socket factory (null if not custom factory)
private static final int	FORMAT_HOST_PORT
private static final int	FORMAT_HOST_PORT_FACTORY
private String	host IP address or host name
private int	listenPort if local, the port number to listen on
private static final Map<TCPEndpoint, LinkedList<TCPEndpoint>>	localEndpoints maps an endpoint key containing custom socket factories to their own unique endpoint
private static String	localHost the local host name
private static boolean	localHostKnown true if real local host name is known yet
private int	port port number
private final RMIServerSocketFactory	ssf custom server socket factory (null if not custom factory)
private TCPTransport	transport if local, the transport object associated with this endpoint

Access	Constructor and Description
public	TCPEndpoint(String host, int port) Create an endpoint for a specified host and port.
public	TCPEndpoint(String host, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Create a custom socket factory endpoint for a specified host and port.

Method Summary

Modifier and Type	Method and Description
private static Collection<TCPTransport>	allKnownTransports() Returns the current list of known transports.
private static RMISocketFactory	chooseFactory()
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) Implements sun.rmi.transport.Endpoint.exportObject. Export the object to accept incoming calls.
private static boolean	getBoolean(String name)
public Channel	getChannel() Implements sun.rmi.transport.Endpoint.getChannel. Returns a channel for this (remote) endpoint.
public RMIClientSocketFactory	getClientSocketFactory() Get the client socket factory associated with this endpoint.
public String	getHost() Returns address for endpoint
private static String	getHostnameProperty() Returns the value of the java.rmi.server.hostname property.
public Transport	getInboundTransport() Implements sun.rmi.transport.Endpoint.getInboundTransport. Returns the transport for incoming connections to this endpoint, if this endpoint was created as a server endpoint (using getLocalEndpoint).
private static int	getInt(String name, int def)
public int	getListenPort() Returns the port that this endpoint's inbound transport listens on, if this endpoint was created as a server endpoint (using getLocalEndpoint).
public static TCPEndpoint	getLocalEndpoint(int port) Get an endpoint for the local address space on specified port.
public static TCPEndpoint	getLocalEndpoint(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
public Transport	getOutboundTransport() Implements sun.rmi.transport.Endpoint.getOutboundTransport. Returns transport for making connections to remote endpoints; (here, the default transport at port 0 is used).
public int	getPort() Returns the port for this endpoint.
public RMIServerSocketFactory	getServerSocketFactory() Get the server socket factory associated with this endpoint.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv ServerSocket	newServerSocket() Return new server socket to listen for connections on this endpoint.
pack-priv Socket	newSocket() Open and return new client socket connection to endpoint.
public static TCPEndpoint	read(ObjectInput the input stream in) Get the endpoint from the input stream.
public static TCPEndpoint	readHostPortFormat(DataInput the input stream in) Create a new endpoint from input stream data.
private static String	resampleLocalHost() Resamples the local hostname and returns the possibly-updated local hostname.
pack-priv static void	setDefaultPort(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Set the port of the (shared) default endpoint object.
pack-priv static void	setLocalHost(String host) Set the local host name, if currently unknown.
public static void	shedConnectionCaches() Release idle outbound connections to reduce demand on I/O resources.
public String	toString() Overrides java.lang.Object.toString. Return string representation for endpoint.
public void	write(ObjectOutput out) Write endpoint to output stream.
public void	writeHostPortFormat(DataOutput out) Write endpoint to output stream in older format used by UnicastRef for JDK1.1 compatibility.

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

Field Detail

csf	back to summary
private final RMIClientSocketFactory csf custom client socket factory (null if not custom factory)

FORMAT_HOST_PORT	back to summary
private static final int FORMAT_HOST_PORT

FORMAT_HOST_PORT_FACTORY	back to summary
private static final int FORMAT_HOST_PORT_FACTORY

host	back to summary
private String host IP address or host name

listenPort	back to summary
private int listenPort if local, the port number to listen on

localEndpoints	back to summary
private static final Map<TCPEndpoint, LinkedList<TCPEndpoint>> localEndpoints maps an endpoint key containing custom socket factories to their own unique endpoint

localHost	back to summary
private static String localHost the local host name

localHostKnown	back to summary
private static boolean localHostKnown true if real local host name is known yet

port	back to summary
private int port port number

ssf	back to summary
private final RMIServerSocketFactory ssf custom server socket factory (null if not custom factory)

transport	back to summary
private TCPTransport transport if local, the transport object associated with this endpoint

Constructor Detail

TCPEndpoint	back to summary
public TCPEndpoint(String host, int port) Create an endpoint for a specified host and port. This should not be used by external classes to create endpoints for servers in this VM; use getLocalEndpoint instead.

TCPEndpoint	back to summary
public TCPEndpoint(String host, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Create a custom socket factory endpoint for a specified host and port. This should not be used by external classes to create endpoints for servers in this VM; use getLocalEndpoint instead.

Method Detail

allKnownTransports	back to summary
private static Collection<TCPTransport> allKnownTransports() Returns the current list of known transports. The returned list is an unshared collection of Transports, including all transports which may have channels to remote endpoints.

chooseFactory	back to summary
private static RMISocketFactory chooseFactory()

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 Implements sun.rmi.transport.Endpoint.exportObject. Export the object to accept incoming calls.

exportObject

back to summary

public void exportObject(Target target) throws RemoteException

Implements sun.rmi.transport.Endpoint.exportObject.

Export the object to accept incoming calls.

getBoolean	back to summary
private static boolean getBoolean(String name)

getChannel	back to summary
public Channel getChannel() Implements sun.rmi.transport.Endpoint.getChannel. Returns a channel for this (remote) endpoint.

getChannel

back to summary

public Channel getChannel()

Implements sun.rmi.transport.Endpoint.getChannel.

Returns a channel for this (remote) endpoint.

getClientSocketFactory	back to summary
public RMIClientSocketFactory getClientSocketFactory() Get the client socket factory associated with this endpoint.

getHost	back to summary
public String getHost() Returns address for endpoint

getHostnameProperty	back to summary
private static String getHostnameProperty() Returns the value of the java.rmi.server.hostname property.

getInboundTransport	back to summary
public Transport getInboundTransport() Implements sun.rmi.transport.Endpoint.getInboundTransport. Returns the transport for incoming connections to this endpoint, if this endpoint was created as a server endpoint (using getLocalEndpoint).

getInboundTransport

back to summary

public Transport getInboundTransport()

Implements sun.rmi.transport.Endpoint.getInboundTransport.

Returns the transport for incoming connections to this endpoint, if this endpoint was created as a server endpoint (using getLocalEndpoint).

getInt	back to summary
private static int getInt(String name, int def)

getListenPort	back to summary
public int getListenPort() Returns the port that this endpoint's inbound transport listens on, if this endpoint was created as a server endpoint (using getLocalEndpoint). If this endpoint was created for the default/anonymous port, then this method returns zero even if the transport has started listening.

getLocalEndpoint	back to summary
public static TCPEndpoint getLocalEndpoint(int port) Get an endpoint for the local address space on specified port. If port number is 0, it returns shared default endpoint object whose host name and port may or may not have been determined.

getLocalEndpoint	back to summary
public static TCPEndpoint getLocalEndpoint(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)

getOutboundTransport	back to summary
public Transport getOutboundTransport() Implements sun.rmi.transport.Endpoint.getOutboundTransport. Returns transport for making connections to remote endpoints; (here, the default transport at port 0 is used).

getOutboundTransport

back to summary

public Transport getOutboundTransport()

Implements sun.rmi.transport.Endpoint.getOutboundTransport.

Returns transport for making connections to remote endpoints; (here, the default transport at port 0 is used).

getPort	back to summary
public int getPort() Returns the port for this endpoint. If this endpoint was created as a server endpoint (using getLocalEndpoint) for a default/anonymous port and its inbound transport has started listening, this method returns (instead of zero) the actual bound port suitable for passing to clients.

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

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.

newServerSocket	back to summary
pack-priv ServerSocket newServerSocket() throws IOException Return new server socket to listen for connections on this endpoint.

newSocket	back to summary
pack-priv Socket newSocket() throws RemoteException Open and return new client socket connection to endpoint.

read	back to summary
public static TCPEndpoint read(ObjectInput in) throws IOException, ClassNotFoundException Get the endpoint from the input stream. Parameters in:ObjectInput the input stream Exceptions IOException: If id could not be read (due to stream failure)

read

back to summary

public static TCPEndpoint read(ObjectInput in) throws IOException, ClassNotFoundException

Get the endpoint from the input stream.

Parameters

in:ObjectInput: the input stream

Exceptions

IOException:: If id could not be read (due to stream failure)

readHostPortFormat	back to summary
public static TCPEndpoint readHostPortFormat(DataInput in) throws IOException Create a new endpoint from input stream data. Parameters in:DataInput the input stream

readHostPortFormat

back to summary

public static TCPEndpoint readHostPortFormat(DataInput in) throws IOException

Create a new endpoint from input stream data.

Parameters

in:DataInput: the input stream

resampleLocalHost	back to summary
private static String resampleLocalHost() Resamples the local hostname and returns the possibly-updated local hostname.

setDefaultPort	back to summary
pack-priv static void setDefaultPort(int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) Set the port of the (shared) default endpoint object. When first created, it contains port 0 because the transport hasn't tried to listen to get assigned a port, or if listening failed, a port hasn't been assigned from the server.

setLocalHost	back to summary
pack-priv static void setLocalHost(String host) Set the local host name, if currently unknown.

shedConnectionCaches	back to summary
public static void shedConnectionCaches() Release idle outbound connections to reduce demand on I/O resources. All transports are asked to release excess connections.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return string representation for endpoint.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return string representation for endpoint.

write	back to summary
public void write(ObjectOutput out) throws IOException Write endpoint to output stream.

writeHostPortFormat	back to summary
public void writeHostPortFormat(DataOutput out) throws IOException Write endpoint to output stream in older format used by UnicastRef for JDK1.1 compatibility.

sun.rmi.transport.tcp back to summary

private Class TCPEndpoint.FQDN

Class Inheritance

extends Object
implements Runnable

java.lang.Object
sun.rmi.transport.tcp.TCPEndpoint.FQDN

All Implemented Interfaces

java.lang.Runnable

The class FQDN encapsulates a routine that makes a best effort attempt to retrieve the fully qualified domain name of the local host.

Author: Laird Dornin

Field Summary

Modifier and Type	Field and Description
private String	hostAddress
private String	reverseLookup strings in which we can store discovered fqdn

Constructor Summary

Access	Constructor and Description
private	FQDN(String hostAddress)

Method Summary

Modifier and Type	Method and Description
pack-priv static String	attemptFQDN(InetAddress localAddr) Do our best to obtain a fully qualified hostname for the local host.
private void	getFQDN() Method that that will start a thread to wait to retrieve a fully qualified domain name from a name service.
private synchronized String	getHost()
public void	run() Implements java.lang.Runnable.run. thread to query a name service for the fqdn of this host.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

hostAddress	back to summary
private String hostAddress

reverseLookup	back to summary
private String reverseLookup strings in which we can store discovered fqdn

Constructor Detail

FQDN	back to summary
private FQDN(String hostAddress)

Method Detail

attemptFQDN

back to summary

pack-priv static String attemptFQDN(InetAddress localAddr) throws UnknownHostException

Do our best to obtain a fully qualified hostname for the local host. Perform the following steps to get a localhostname: 1. InetAddress.getLocalHost().getHostName() - if contains '.' use as FQDN 2. if no '.' query name service for FQDN in a thread

Note

We query the name service for an FQDN by creating an InetAddress via a stringified copy of the local ip address; this creates an InetAddress with a null hostname. Asking for the hostname of this InetAddress causes a name service lookup. 3. if name service takes too long to return, use ip address 4. if name service returns but response contains no '.' default to ipaddress.

getFQDN	back to summary
private void getFQDN() Method that that will start a thread to wait to retrieve a fully qualified domain name from a name service. The spawned thread may never return but we have marked it as a daemon so the vm will terminate appropriately.

getHost	back to summary
private synchronized String getHost()

run

back to summary

public void run()

Implements java.lang.Runnable.run.

thread to query a name service for the fqdn of this host.

public Class TCPEndpoint

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TCPEndpoint.FQDN

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail