com.sun.n1.sps.model.host
Interface AppInstance

public interface AppInstance

An app instance describes an application installed on a physical host. It includes information about the type of application installed (remote agent, local distribtor, or master server), and how to connect to that application.

Method Summary

ConnectionType	getConnectionType() Returns the connection type that should be used to connect to this this app instance.
HostID	getHostID() Returns the ID of the host that contains this app instance, or null if this app instance is not yet contained on any host.
AppInstanceID	getID() Returns the ID of this object
java.lang.String	getIPAddress() Returns the IP address of the physical machine on which the application corresponding to this app instance resides.
java.lang.String	getParameters() Returns the optional additional parameters used by this app instance.
AppInstanceID	getParentID() Returns the ID of the parent of this app instance, or null if this app instance is the master server.
int	getPort() Returns the port at which the application corresponding to this app instance is listening.
RoxAddress	getRoxAddress() Returns the rox address at which the application associated with this object is listening.
AppType	getType() Returns the type of this app instance.
int	getUpdateCount() Returns the number of times this object has been updated in the repository.

Method Detail

getID

AppInstanceID getID()

Returns the ID of this object

Returns:

The ID of this object.

getType

AppType getType()

Returns the type of this app instance.

Returns:

The type of this app instance.

getConnectionType

ConnectionType getConnectionType()

Returns the connection type that should be used to connect to this this app instance. The default connection type is ConnectionType.RAW .

Returns:

The connection type.

getHostID

HostID getHostID()

Returns the ID of the host that contains this app instance, or null if this app instance is not yet contained on any host.

Returns:

The ID of the host containing this app instance.

getRoxAddress

RoxAddress getRoxAddress()

Returns the rox address at which the application associated with this object is listening. By default the IP Address and port are both 0s.

Returns:

The address at which the application is listening.

getIPAddress

java.lang.String getIPAddress()

Returns the IP address of the physical machine on which the application corresponding to this app instance resides. The result is in string format as %d.%d.%d.%d. The IP address is "0.0.0.0" by default.

Returns:

The IP address of the machine on which the application resides.

getPort

int getPort()

Returns the port at which the application corresponding to this app instance is listening. The port is 0 by default.

Returns:

The port at which the application is listening.

getParameters

java.lang.String getParameters()

Returns the optional additional parameters used by this app instance. The parameters are used to customize ssh connections, as described in the transport subsystem. The parameters are empty (not null) by default.

Returns:

The optional parameters for the app instance.

getParentID

AppInstanceID getParentID()

Returns the ID of the parent of this app instance, or null if this app instance is the master server. The collective ancestors of an app instance determine the network route used to connect from the master server to this app instance. This value is null by default.

Returns:

The ID of the parent of this object.

getUpdateCount

int getUpdateCount()

Returns the number of times this object has been updated in the repository. This field is used to detect write conflicts when this object is saved.

Returns:

The update count.