com.ibm.ftt.resources.core.physical
Interface IOSImage

All Known Subinterfaces:
ZOSSystemImage

public interface IOSImage

The IOSImage provides generic interface for a system image.

A system image contains a file subsystem and file resource tree. The root object of the file resource tree can be obtained using getRoot() method. This interface also provides methods to connect to the system, get IP address, etc.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 void connect()
          Connects to the remote file subsystem.
 boolean equals(Object object)
          Tests this system image for equality with the given object.
 IRemoteCommand getCommandObject()
          Gets a remote command object to execute a command on the remote system.
 String getIpAddress()
          Returns the IP address or host name of this system.
 String getName()
          Returns the display name of this system image.
 IResourceRoot getRoot()
          Returns the root object of the file resource tree of the file subsystem.
 String getUserId()
          Returns the user id of the user who is currently connected to this system image.
 int hashCode()
          Returns a hash code value for the object.
 boolean isConnected()
          Determines whether the remote file subsystem of this system image is connected.
 void setRoot(IResourceRoot value)
          Sets the root object of the file resource tree of the file subsystem.
 

Field Detail

COPY_RIGHT

static final String COPY_RIGHT
See Also:
Constant Field Values
Method Detail

getRoot

IResourceRoot getRoot()
Returns the root object of the file resource tree of the file subsystem. For example, a catalog for a z/OS system.

Returns:
the root resource of the resource tree
See Also:
setRoot(IResourceRoot)

setRoot

void setRoot(IResourceRoot value)
Sets the root object of the file resource tree of the file subsystem. For example, a catalog for a z/OS system.

Parameters:
value - the resource root object
See Also:
getRoot()

getName

String getName()
Returns the display name of this system image.

Returns:
the display name of this system image
See Also:
setName(String)

getIpAddress

String getIpAddress()
Returns the IP address or host name of this system.

Returns:
the string containing the IP address or host name of this system image
See Also:
setIpAddress(String)

getUserId

String getUserId()
Returns the user id of the user who is currently connected to this system image.

Returns:
the userid, or NULL if the system image is not connected

equals

boolean equals(Object object)
Tests this system image for equality with the given object. Two system images are equal if and only if their names are both equal, and they are of the same type.

Overrides:
equals in class Object
Parameters:
object - the other object
Returns:
true if objects are equal, false otherwise

hashCode

int hashCode()
Returns a hash code value for the object.

Overrides:
hashCode in class Object
Returns:
a hash code value for this object
See Also:
Object.hashCode()

isConnected

boolean isConnected()
Determines whether the remote file subsystem of this system image is connected.

Returns:
true if connected; false otherwise

connect

void connect()
             throws Exception
Connects to the remote file subsystem.

Throws:
Exception - if any exception occurred when connecting.

getCommandObject

IRemoteCommand getCommandObject()
Gets a remote command object to execute a command on the remote system.

Returns:
a new remote command object, or null if it is not supported by the system.