flux
Interface Rmi

All Known Subinterfaces:

DynamicRmiAction, RmiAction

public interface Rmi

Identifies an RMI server object.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.String	getBindName() Returns the name that the RMI server object is bound to in the RMI registry.
java.lang.String	getHost() Returns the host where the RMI server object is located.
java.net.URL	getHostAsUrl() Returns the host, registry port, and bind name where the RMI server object is located.
int	getPort() Returns the RMI registry port where the RMI server object is located.
void	setBindName(java.lang.String bindName) Sets the name that the RMI server object is bound to in the RMI registry.
void	setHost(java.lang.String host) Sets the host where the RMI server object is located.
void	setHost(java.net.URL host) Sets the host, registry port, and bind name where the RMI server object is located.
void	setPort(int port) Sets the registry port where the RMI server object is located.

Method Detail

getBindName

java.lang.String getBindName()

Returns the name that the RMI server object is bound to in the RMI registry.

Returns:

The name that the RMI server object is bound to in the RMI registry.

getHost

java.lang.String getHost()

Returns the host where the RMI server object is located.

Returns:

The host where the RMI server object is located.

getHostAsUrl

java.net.URL getHostAsUrl()
                          throws EngineException

Returns the host, registry port, and bind name where the RMI server object is located. This information is returned as a URL.

Returns:

The host, registry port and bind name where the RMI server object is located.

Throws:

EngineException - If a system error occurs.

getPort

int getPort()

Returns the RMI registry port where the RMI server object is located.

Returns:

The RMI registry port where the RMI server object is located.

setBindName

void setBindName(java.lang.String bindName)

Sets the name that the RMI server object is bound to in the RMI registry. A non-null and non-empty bind name value is required.

Parameters:

bindName - The name that the RMI server object is bound to in the RMI registry.

Throws:

java.lang.IllegalArgumentException - If bindName is null or empty.

setHost

void setHost(java.lang.String host)

Sets the host where the RMI server object is located. A null host value will result in a lookup of the registry on the local host.

Parameters:

host - The host where the RMI server object is located. registry.

Throws:

java.lang.IllegalArgumentException - If bindName is null or empty.

setHost

void setHost(java.net.URL host)
             throws EngineException

Sets the host, registry port, and bind name where the RMI server object is located. This information is contained in a URL. A null host value will result in a lookup of the registry on the local host. Port values of 0 and -1 will result in a lookup of the registry on port 1099. A non-null and non-empty bind name value is required.

Parameters:

host - The host, registry port and bind name where the RMI server object is located.

Throws:

EngineException - If a system error occurs.

setPort

void setPort(int port)
             throws EngineException

Sets the registry port where the RMI server object is located. Port values of 0 and -1 will result in a lookup of the registry on port 1099.

Parameters:

port - Sets the registry port where the RMI server object is located.

Throws:

EngineException - If a system error occurs.