|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Connection
Represents a connection using the Remote Execution and Access Library
Method Summary | |
---|---|
com.ibm.tivoli.remoteaccess.RemoteAccess |
beginSession()
Begin a session with the target machine |
void |
createDir(java.lang.String dir)
Create a directory on the target machine |
java.lang.String |
createRandomDir(java.lang.String p)
Create a random directory on the target machine |
void |
endSession()
End the session with the target machine |
java.lang.String |
getHost()
Return the name of the target machine |
char |
getOSSeparator()
Return the character that the target uses to separate path information |
com.ibm.tivoli.remoteaccess.RemoteAccess |
getRXAProtocol()
Return the internal RXA connection object |
java.lang.String |
getType()
Return the connection protocol used for this connection |
java.lang.String |
getUser()
Return the username being used to connect to the target |
void |
initializeProps(java.util.Properties p)
Initialize the connection properties |
boolean |
isExists(java.lang.String path)
Returns true/false to check a given file exists or not |
java.util.ArrayList<java.lang.String> |
list(java.lang.String path)
Retrieves the list of files |
void |
receiveFile(java.lang.String remote,
java.lang.String local)
Receives the specified file from the specified target machine to local machine |
void |
removeDir(java.lang.String dir)
Remove a directory on the target machine |
Entry |
runCommand(java.lang.String cmd)
Execute the command on the target |
void |
setCmdArgsCharEncode(java.lang.String enc)
Sets encoding for the command arguments before executing the actual command |
void |
setHost(java.lang.String h)
Set the hostname of the target |
void |
setUser(java.lang.String u)
Set the username being used to connect to the target |
void |
transferFile(java.lang.String local,
java.lang.String remote)
Transfer the specified file from the local machine to a specified destination on the remote target |
Method Detail |
---|
java.lang.String getHost()
void setHost(java.lang.String h)
h
- Hostname of target machinejava.lang.String getUser()
void setUser(java.lang.String u)
u
- The name of the uservoid initializeProps(java.util.Properties p)
p
- The configurable attributes for the connectioncom.ibm.tivoli.remoteaccess.RemoteAccess beginSession() throws RemoteConnectException
RemoteConnectException
- Thrown if starting the session is unsuccessfulEntry runCommand(java.lang.String cmd) throws GeneralCLFCException
cmd
- The command to be executed
GeneralCLFCException
- If errors are encountered when attempting to run the commandchar getOSSeparator() throws RemoteConnectException
RemoteConnectException
void createDir(java.lang.String dir) throws GeneralCLFCException
dir
- The path to the folder to be created
GeneralCLFCException
- if the folder cannot be successfully created on the targetvoid removeDir(java.lang.String dir) throws GeneralCLFCException
dir
- The path to the folder to be deleted
GeneralCLFCException
- if the folder cannot be successfully removed from the targetvoid transferFile(java.lang.String local, java.lang.String remote) throws GeneralCLFCException
local
- Path to the source file on the local machineremote
- Path to where the file is to be stored on the remote machine
GeneralCLFCException
- if the transfer failsvoid receiveFile(java.lang.String remote, java.lang.String local) throws GeneralCLFCException
remote
- Path to the source file on the remote machinelocal
- Path to where the file is to be stored on the local machine
GeneralCLFCException
- if the transfer failsboolean isExists(java.lang.String path) throws GeneralCLFCException
path
- path of the file on the remote machine
GeneralCLFCException
java.util.ArrayList<java.lang.String> list(java.lang.String path) throws GeneralCLFCException
path
- path on the remote machine
GeneralCLFCException
java.lang.String createRandomDir(java.lang.String p) throws GeneralCLFCException, RemoteConnectException
p
- The path to the parent directory where the random directory is
to be created
GeneralCLFCException
RemoteConnectException
void endSession()
com.ibm.tivoli.remoteaccess.RemoteAccess getRXAProtocol()
java.lang.String getType()
void setCmdArgsCharEncode(java.lang.String enc)
enc
- encoding to be used
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |