com.wrq.vhi.sconfig
Interface IServerAdminSession


public interface IServerAdminSession

Interface class for working with a VHI server. Use the ServerConfig.newServerAdminSession() methods to create instances of this interface.


Method Summary
 void close()
          Close a connection to a VHI server.
 void open()
          Open a connection to a VHI server for the purpose of reading or updating model variable lists.
 void setConnection(IAADSConnection aadsConn)
          Update our reference to an IAADSConnection instance.
 void setPassword(java.lang.String password)
          Update the password used for authentication.
 void setServerName(java.lang.String name)
          Set the VHI server name.
 void setUsername(java.lang.String username)
          Update the username used for authentication.
 

Method Detail

setConnection

void setConnection(IAADSConnection aadsConn)
Update our reference to an IAADSConnection instance.

Parameters:
aadsConn - Reference to an instance of an IAADSConnection
Throws:
java.lang.IllegalArgumentException - if argument is null.

setServerName

void setServerName(java.lang.String name)
Set the VHI server name.

Parameters:
name - Name of VHI server.
Throws:
java.lang.IllegalArgumentException - if argument is null.

setUsername

void setUsername(java.lang.String username)
Update the username used for authentication.

Parameters:
username - Username for authentication

setPassword

void setPassword(java.lang.String password)
Update the password used for authentication.

Parameters:
password - Password for authentication

open

void open()
          throws SCException
Open a connection to a VHI server for the purpose of reading or updating model variable lists. This method must be called before reading or updating model variable lists.

Throws:
SCException - if there is an error connecting to the VHI Server.

close

void close()
Close a connection to a VHI server.