|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRemoteCmdSubSystem
interface RemoteCmdSubSystem extends SubSystem {}
Field Summary |
---|
Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
NO_CHILDREN |
Method Summary | |
---|---|
void |
addEnvironmentVariable(IRemoteSystemEnvVar rsev)
Add environment variable entry, given a RemoteSystemEnvVar object |
void |
addEnvironmentVariable(String name,
String value)
Add environment variable entry, given a name and value |
void |
cancelShell(Object commandObject,
IProgressMonitor monitor)
Cancel a shell or running command. |
boolean |
canRunCommand()
Determine whether the command subsystem can run a command |
boolean |
canRunShell()
Determine whether the command subsystem can run a shell |
ICandidateCommand[] |
getCandidateCommands(Object context)
Provide a list of possible commands for the specified context. |
IRemoteCommandShell |
getDefaultShell()
Get the default running command shell for this command subsystem. |
IRemoteSystemEnvVar |
getEnvironmentVariable(String name)
Given an environment variable name, find its RemoteSystemEnvVar object. |
IRemoteSystemEnvVar[] |
getEnvironmentVariableList()
Get the initial environment variable list as a string of RemoteSystemEnvVar objects. |
String |
getEnvironmentVariableValue(String name)
Given an environment variable name, find its value. |
String[] |
getExecutedCommands()
Provide list of executed commands on subsystem.This is only applicable if the subsystem factory reports true for supportsCommands(). |
List |
getHostEnvironmentVariables()
|
String |
getInvalidEnvironmentVariableNameCharacters()
Get the invalid characters for an environment variable name. |
IRemoteCmdSubSystemConfiguration |
getParentRemoteCmdSubSystemConfiguration()
Return parent subsystem factory, cast to a RemoteCmdSubSystemConfiguration |
IRemoteCommandShell[] |
getShells()
Get all command shells and transient commands that have been run or are running for this command subsystem. |
void |
removeEnvironmentVariable(IRemoteSystemEnvVar rsev)
Remove environment variable entry given its RemoteSystemEnvVar object |
void |
removeEnvironmentVariable(String name)
Remove environment variable entry given only its environment variable name |
void |
removeShell(Object commandObject)
Remove a shell. |
IRemoteCommandShell[] |
restoreShellState(Shell shell)
Restore all the command shells that were open before disconnecting during the previous session |
Object[] |
runCommand(String command,
Object context,
boolean interpretOutput,
IProgressMonitor monitor)
Execute a remote command. |
Object[] |
runCommand(String command,
Object context,
IProgressMonitor monitor)
Execute a remote command. |
IRemoteCommandShell |
runShell(Object context,
IProgressMonitor monitor)
Launch a new command shell. |
void |
sendCommandToShell(String input,
Object commandObject,
IProgressMonitor monitor)
Send a command as input to a running command shell. |
void |
setEnvironmentVariableList(String[] envVarNames,
String[] envVarValues)
Set the initial environment variable list entries, all in one shot, using a pair of String arrays: the first is the environment variable names, the second is the corresponding environment variable values. |
Methods inherited from interface org.eclipse.rse.core.subsystems.IRemoteObjectResolver |
---|
getObjectWithAbsoluteName, getObjectWithAbsoluteName |
Methods inherited from interface org.eclipse.core.runtime.jobs.ISchedulingRule |
---|
contains, isConflicting |
Methods inherited from interface org.eclipse.rse.core.model.IRSEModelObject |
---|
getDescription |
Methods inherited from interface org.eclipse.rse.core.model.IPropertySetContainer |
---|
addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet |
Methods inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored |
Method Detail |
---|
IRemoteCmdSubSystemConfiguration getParentRemoteCmdSubSystemConfiguration()
Object[] runCommand(String command, Object context, IProgressMonitor monitor) throws Exception
command
- Command to be executed remotely.context
- context of a command (i.e. working directory). Null is valid and means to run the
command as a shell command in the default shell.monitor
- the progress monitor
Exception
Object[] runCommand(String command, Object context, boolean interpretOutput, IProgressMonitor monitor) throws Exception
command
- Command to be executed remotely.context
- context of a command (i.e. working directory). Null is valid and means to run the
command as a shell command in the default shell.interpretOutput
- whether to interpret the output or notmonitor
- the progress monitor
Exception
IRemoteCommandShell runShell(Object context, IProgressMonitor monitor) throws Exception
context
- context of a shell (i.e. working directory). Null is valid and means to use the default context.monitor
- the progress monitor
Exception
void sendCommandToShell(String input, Object commandObject, IProgressMonitor monitor) throws Exception
input
- the command to invoke in the shell.commandObject
- the shell or command to send the invocation to.monitor
- the progress monitor
Exception
void cancelShell(Object commandObject, IProgressMonitor monitor) throws Exception
commandObject
- the shell or command to cancelmonitor
- the progress monitor
Exception
void removeShell(Object commandObject) throws Exception
commandObject
- the shell or command to cancel & remove.
Exception
IRemoteCommandShell getDefaultShell() throws Exception
Exception
IRemoteCommandShell[] getShells()
IRemoteCommandShell[] restoreShellState(Shell shell)
shell
- a window used for notification
boolean canRunShell()
boolean canRunCommand()
String[] getExecutedCommands()
ICandidateCommand[] getCandidateCommands(Object context)
context
- the context for the possible commands
IRemoteSystemEnvVar[] getEnvironmentVariableList()
void setEnvironmentVariableList(String[] envVarNames, String[] envVarValues)
void addEnvironmentVariable(String name, String value)
void addEnvironmentVariable(IRemoteSystemEnvVar rsev)
void removeEnvironmentVariable(IRemoteSystemEnvVar rsev)
void removeEnvironmentVariable(String name)
IRemoteSystemEnvVar getEnvironmentVariable(String name)
String getEnvironmentVariableValue(String name)
String getInvalidEnvironmentVariableNameCharacters()
List getHostEnvironmentVariables()
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |