|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bmc.mainview.nvbapi.HostServer
public abstract class HostServer
Defines a session with a mainframe.
Field Summary | |
---|---|
long |
connectTime
How long we have been connected to the server |
static java.text.SimpleDateFormat |
HOSTFORMAT
Format for decoding host date/time fields |
long |
timeDelta
Time offset between here and the host |
static VersionNumber |
VERSION
The version of NVBAPI |
Constructor Summary | |
---|---|
HostServer(java.lang.Object logger,
java.lang.String hostName,
java.lang.String hostAddress,
int hostPort,
java.lang.String user,
java.lang.String pass)
Creates a session with the mainframe |
Method Summary | |
---|---|
abstract XML |
connect()
Opens the session with the mainframe |
abstract Conversation |
conversationFactory()
Creates a new conversation using this host session |
abstract Conversation |
conversationFactory(java.lang.String monitorID)
Creates a new conversation using this host session |
abstract void |
disconnect()
Ends the session |
java.lang.String |
getAddr()
Get the IP address used in creating this object |
java.lang.String |
getCanonicalHostName()
|
VersionNumber |
getHostLvl()
Get the maintenance level of the host |
java.lang.String |
getName()
Retrieve the host server name |
java.lang.String |
getPassword()
Retrieve the current password |
int |
getPort()
Retrieve the IP port number on the host |
int |
getTimeout()
|
java.lang.String |
getUserID()
Retrieve the login ID |
boolean |
isConnected()
Determine if a connect{} has been previously issued. |
boolean |
isFunctional()
Determine if the host is responding |
java.util.Vector<ServicePoint> |
loadTargets(Conversation conv)
A utility method that retrieves the PLEXMGR view and lists the available MVI-3 targets |
java.util.Vector<ServicePoint> |
loadTargets(Conversation conv,
java.lang.String product)
A utility method that retrieves the PLEXMGR view and lists the available MVI-3 targets |
void |
setName(java.lang.String value)
Set the name of the host for identification in messages |
void |
setNewPassword(java.lang.String password)
Set a new password to be sent to the host when connecting; |
void |
setPassword(java.lang.String password)
Set a password to be used with the user ID in connecting to the host |
void |
setTimeout(int timeoutInterval)
|
void |
setUserID(java.lang.String userID)
Set the login ID to be used in connecting to the host |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public long connectTime
public long timeDelta
public static final java.text.SimpleDateFormat HOSTFORMAT
public static VersionNumber VERSION
Constructor Detail |
---|
public HostServer(java.lang.Object logger, java.lang.String hostName, java.lang.String hostAddress, int hostPort, java.lang.String user, java.lang.String pass)
logger
- A logger to receive trace information for debugging.
It may be either a SLF4J Logger or a JDK1.4 Logger.hostName
- The name which is used to refer to this particular session in log entrieshostAddress
- The IP address of the mainframe.hostPort
- The port number on which the MVI Host Server is runninguser
- A z/OS user IDpass
- The corresponding passwordMethod Detail |
---|
public abstract XML connect() throws java.io.IOException
java.io.IOException
- if the session cannot be established.disconnect()
public java.lang.String getPassword()
public void setPassword(java.lang.String password)
password
- public void setNewPassword(java.lang.String password)
password
- public java.lang.String getUserID()
setUserID(String)
public void setUserID(java.lang.String userID)
userID
- public java.lang.String getAddr()
public java.lang.String getName()
setName(String)
public int getPort()
public int getTimeout()
public void setTimeout(int timeoutInterval)
timeoutInterval
- the timeoutInterval in millisecondspublic java.lang.String getCanonicalHostName()
public VersionNumber getHostLvl()
public boolean isConnected()
true
if connected to the host serverpublic boolean isFunctional()
true
if the server is responding.public abstract void disconnect()
public java.util.Vector<ServicePoint> loadTargets(Conversation conv) throws java.io.IOException
conv
- A conversation with the host.
java.io.IOException
ServicePoint
public java.util.Vector<ServicePoint> loadTargets(Conversation conv, java.lang.String product) throws java.io.IOException
conv
- A conversation with the host.
java.io.IOException
ServicePoint
public abstract Conversation conversationFactory() throws java.io.IOException
java.io.IOException
public abstract Conversation conversationFactory(java.lang.String monitorID) throws java.io.IOException
monitorID
- the related monitor ID
java.io.IOException
public void setName(java.lang.String value)
value
- The namepublic java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |