Eclipse RSE Development Guide (Galileo) - RemoteCmdSubSystem (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.subsystems.shells.core.subsystems
Class RemoteCmdSubSystem


java.lang.Object
  

org.eclipse.rse.core.model.RSEPersistableObject
      

org.eclipse.rse.core.model.PropertySetContainer
          

org.eclipse.rse.core.model.RSEModelObject
              

org.eclipse.rse.core.subsystems.SubSystem
                  
org.eclipse.rse.subsystems.shells.core.subsystems.RemoteCmdSubSystem

All Implemented Interfaces:: IAdaptable, ISchedulingRule, ISystemFilterPoolReferenceManagerProvider, IPropertySetContainer, IRSEModelObject, IRSEPersistableContainer, ICommunicationsListener, IRemoteObjectResolver, ISubSystem, IRemoteCmdSubSystem

Direct Known Subclasses:: ShellServiceSubSystem

public abstract class RemoteCmdSubSystem
extends SubSystem
implements IRemoteCmdSubSystem, ICommunicationsListener
extends SubSystem
implements IRemoteCmdSubSystem, ICommunicationsListener

This is the abstraction of a subsystem specialized for remote execution of commands.

Field Detail

_cmdShells

protected 
ArrayList _cmdShells

_defaultShell

protected 
IRemoteCommandShell _defaultShell

_fileSubSystem

protected 
IRemoteFileSubSystem _fileSubSystem

Constructor Detail

RemoteCmdSubSystem

public RemoteCmdSubSystem(
IHost host,
                          
IConnectorService connectorService)

Method Detail

initializeSubSystem

public void initializeSubSystem(
IProgressMonitor monitor)
                         throws 
SystemMessageException

Description copied from class: SubSystem

Initialize this subsystem instance after the corresponding IConnectorService connect method finishes. This method should be overridden if any initialization for the subsystem needs to occur at this time.

The default implementation currently does nothing, but overriding methods should call super before doing any other work.

Specified by:: initializeSubSystem in interface ISubSystem
Overrides:: initializeSubSystem in class SubSystem

Parameters:: monitor - a progress monitor that can be used to show progress during long-running operation. Cancellation is typically not supported since it might leave the system in an inconsistent state.
Throws:: SystemMessageException - if an error occurs during initialization.

getParentRemoteCmdSubSystemConfiguration

public 
IRemoteCmdSubSystemConfiguration getParentRemoteCmdSubSystemConfiguration()

Return parent subsystem factory, cast to a RemoteCmdSubSystemConfiguration

Specified by:: getParentRemoteCmdSubSystemConfiguration in interface IRemoteCmdSubSystem

checkForCancel

public boolean checkForCancel(
IProgressMonitor monitor)

Long running list processing calls this method to check for a user-cancel event. If user did cancel, an exception is thrown.

Returns:: true if caller wants to cancel

getEnvironmentVariableList

public 
IRemoteSystemEnvVar[] getEnvironmentVariableList()

Get the initial environment variable list as a string of RemoteSystemEnvVar objects. Array returned may be size zero but will not be null.

Specified by:: getEnvironmentVariableList in interface IRemoteCmdSubSystem

setEnvironmentVariableList

public void setEnvironmentVariableList(
String[] names,
                                       
String[] values)

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.

Specified by:: setEnvironmentVariableList in interface IRemoteCmdSubSystem

Parameters:: names - the array of names; values - the array of string values

addEnvironmentVariable

public void addEnvironmentVariable(
String name,
                                   
String value)

Add environment variable entry, given a name and value

Specified by:: addEnvironmentVariable in interface IRemoteCmdSubSystem

addEnvironmentVariable

public void addEnvironmentVariable(
IRemoteSystemEnvVar rsev)

Add environment variable entry, given a RemoteSystemEnvVar object

Specified by:: addEnvironmentVariable in interface IRemoteCmdSubSystem

removeEnvironmentVariable

public void removeEnvironmentVariable(
IRemoteSystemEnvVar rsev)

Remove environment variable entry given its RemoteSystemEnvVar object

Specified by:: removeEnvironmentVariable in interface IRemoteCmdSubSystem

Parameters:: rsev - the remote system environment variable to remove

removeEnvironmentVariable

public void removeEnvironmentVariable(
String name)

Remove environment variable entry given only its environment variable name

Specified by:: removeEnvironmentVariable in interface IRemoteCmdSubSystem

getEnvironmentVariable

public 
IRemoteSystemEnvVar getEnvironmentVariable(
String name)

Given an environment variable name, find its RemoteSystemEnvVar object. Returns null if not found.

Specified by:: getEnvironmentVariable in interface IRemoteCmdSubSystem

getEnvironmentVariableValue

public 
String getEnvironmentVariableValue(
String name)

Given an environment variable name, find its value. Returns null if not found.

Specified by:: getEnvironmentVariableValue in interface IRemoteCmdSubSystem

getEnvVarsAsStringArray

protected 
String[] getEnvVarsAsStringArray()

isUniqueVariable

protected boolean isUniqueVariable(
List variables,
                                   
String varName)

getUserAndHostEnvVarsAsStringArray

protected 
String[] getUserAndHostEnvVarsAsStringArray()

isWindows

public boolean isWindows()

getCandidateCommands

public 
ICandidateCommand[] getCandidateCommands(
Object context)

Lists the possible commands for the given context

Specified by:: getCandidateCommands in interface IRemoteCmdSubSystem

Parameters:: context - the context for a command
Returns:: the list of possible commands

parsePathEnvironmentVariable

protected 
List parsePathEnvironmentVariable(
String path)

getFileSubSystem

public 
IRemoteFileSubSystem getFileSubSystem()

getInvalidEnvironmentVariableNameCharacters

public 
String getInvalidEnvironmentVariableNameCharacters()

Default implementation of getInvalidEnvironmentVariableNameCharacters. This default implementation just returns "=" (the only invalid character is the = sign.) Subclasses can override this to provide a more comprehensive list.

Specified by:: getInvalidEnvironmentVariableNameCharacters in interface IRemoteCmdSubSystem

See Also:: IRemoteCmdSubSystem.getInvalidEnvironmentVariableNameCharacters()

getCommandSubSystem

public 
IRemoteCmdSubSystem getCommandSubSystem()

Return the associated command subsystem. By default, returns the first command subsystem found for this connection, but can be refined by each subsystem implementation. For command subsystems, returns "this".

internalResolveFilterString

protected 
Object[] internalResolveFilterString(
String filterString,
                                               
IProgressMonitor monitor)
                                        throws 
InvocationTargetException,
                                               
InterruptedException

Actually resolve an absolute filter string. This is called by the run(IProgressMonitor monitor) method, which in turn is called by resolveFilterString.

Overrides:: internalResolveFilterString in class SubSystem

Throws:: InvocationTargetException; InterruptedException
See Also:: SubSystem.internalResolveFilterString(String,IProgressMonitor)

getChildren

public 
Object[] getChildren()

Description copied from class: SubSystem

Return the children of this subsystem, to populate the GUI subtree of this subsystem. By default, this method:

Returns the filter pool references of this subsystem, if supportsFilters() is true for our factory.
If supportsFilters() is false from our factory, returns null

So, be sure to override this method IF you do not support filters. Lazy Loading: Note that if your subsystem does not support connecting, and you do not support filters, here is a good point to ensure that the bundles which declare your UI adapters get loaded, since the default code which overriders usually place in SubSystem.initializeSubSystem(IProgressMonitor) is not called in that case. Similarly, if your subsystem declares custom images for filters or filter pools, overriding the getChildren() call here to first load your filter adapters and THEN super.getChildren() is a good idea.

Specified by:: getChildren in interface ISubSystem
Overrides:: getChildren in class SubSystem

hasChildren

public boolean hasChildren()

Description copied from class: SubSystem

CHILD CLASSES MAY OVERRIDE THIS. By default it returns true iff we support filters and there are filter pool references.

Specified by:: hasChildren in interface ISubSystem
Overrides:: hasChildren in class SubSystem

getDefaultShell

public 
IRemoteCommandShell getDefaultShell()
                                    throws 
Exception

Get the default running command shell for this command subsystem. If no such shell exists or is running, a new one is launched.

Specified by:: getDefaultShell in interface IRemoteCmdSubSystem

Returns:: the default running command shell
Throws:: Exception

getShells

public 
IRemoteCommandShell[] getShells()

Get all command shells and transient commands that have been run or are running for this command subsystem.

Specified by:: getShells in interface IRemoteCmdSubSystem

Returns:: the list of running command shells and commands

canRunShell

public boolean canRunShell()

Determine whether the command subsystem can run a shell

Specified by:: canRunShell in interface IRemoteCmdSubSystem

Returns:: whether a shell can be run or not

canRunCommand

public boolean canRunCommand()

Determine whether the command subsystem can run a command

Specified by:: canRunCommand in interface IRemoteCmdSubSystem

Returns:: whether a command can be run or not

getObjectWithAbsoluteName

public 
Object getObjectWithAbsoluteName(
String key,
                                        
IProgressMonitor monitor)
                                 throws 
Exception

Return the object within the subsystem that corresponds to the specified unique ID. For remote command, the key is determined by the command ID and the output ID.

Specified by:: getObjectWithAbsoluteName in interface IRemoteObjectResolver
Overrides:: getObjectWithAbsoluteName in class SubSystem

Parameters:: key - the unique id of the remote object. Must not be null.; monitor - the progress monitor
Returns:: the remote object instance, or null if no object is found with the given id.
Throws:: Exception - in case an error occurs contacting the remote system while retrieving the requested remote object. Extenders are encouraged to throw SystemMessageException in order to support good user feedback in case of errors. Since exceptions should only occur while retrieving new remote objects during startup, clients are typically allowed to ignore these exceptions and treat them as if the remote object were simply not there.
See Also:: IRemoteObjectResolver.getObjectWithAbsoluteName(String, IProgressMonitor)

saveShellState

protected void saveShellState(
List cmdShells)

internalRemoveShell

protected void internalRemoveShell(
Object command)
                            throws 
InvocationTargetException,
                                   
InterruptedException

Throws:: InvocationTargetException; InterruptedException

restoreShellState

public 
IRemoteCommandShell[] restoreShellState(
Shell shellWindow)

Description copied from interface: IRemoteCmdSubSystem

Restore all the command shells that were open before disconnecting during the previous session

Specified by:: restoreShellState in interface IRemoteCmdSubSystem

Parameters:: shellWindow - a window used for notification
Returns:: the command shells that were restored

cancelAllShells

public void cancelAllShells()

isPassiveCommunicationsListener

public boolean isPassiveCommunicationsListener()

Description copied from interface: ICommunicationsListener

This method determines if the communications listener is a passive or active listener. Typically a passive listener registers with the communications system and responds to events as they occur. An active listener typically registers with the communications system only for the duration of the task (i.e. user editing a file, or outstanding communications request.) The user will be prompted on a disconnect if there are any active communication listeners registered.

Specified by:: isPassiveCommunicationsListener in interface ICommunicationsListener

Returns:: false if the communications listener is an active listener, true if the communications listener is a passive listener.
See Also:: ICommunicationsListener.isPassiveCommunicationsListener()

communicationsStateChange

public void communicationsStateChange(
CommunicationsEvent e)

Description copied from interface: ICommunicationsListener

This method is invoked whenever the communications state is invoked immediately before and after the state of the communications changes. The state field in CommunicationsEvent determines which state change is about to or has occurred.

Specified by:: communicationsStateChange in interface ICommunicationsListener

createPropertySet

public 
IPropertySet createPropertySet(
String name)

Description copied from interface: IPropertySetContainer

Creates a new property set of a particular name in this container. If one already exists by this name, it is replaced with a new empty property set. In order to have the property set persisted, the implementing class should also implement IRSEPersistableContainer. The IRSEPersistableContainer.commit() method must then be used to commit any changes into persistent storage.

Specified by:: createPropertySet in interface IPropertySetContainer
Overrides:: createPropertySet in class PropertySetContainer

Parameters:: name - the name of the property set.
Returns:: The property set.

runCommand

public 
Object[] runCommand(
String command,
                           
Object context,
                           boolean interpretOutput)
                    throws 
Exception

Deprecated. use runCommand(String, Object, boolean, IProgressMonitor)

overridden so that for universal we don't need to do in modal thread

Throws:: Exception

runCommand

public 
Object[] runCommand(
String command,
                           
Object context,
                           boolean interpretOutput,
                           
IProgressMonitor monitor)
                    throws 
Exception

overridden so that for universal we don't need to do in modal thread

Specified by:: runCommand in interface IRemoteCmdSubSystem

Parameters:: 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 not; monitor - the progress monitor
Returns:: Array of objects that are the result of running this command. In a typical use, such as a command run from a shell, there is only one result in the array and that is the IRemoteCommandShell object. In that cause, the lines of output for the shell are contained as children under the IRemoteCommandShell object.
Throws:: Exception

runShell

public 
IRemoteCommandShell runShell(
Object context)
                             throws 
Exception

Deprecated. use runShell(Object, IProgressMonitor)

overridden so that for universal we don't need to do in modal thread

Throws:: Exception

runShell

public 
IRemoteCommandShell runShell(
Object context,
                                    
IProgressMonitor monitor)
                             throws 
Exception

overridden so that for universal we don't need to do in modal thread

Specified by:: runShell in interface IRemoteCmdSubSystem

Parameters:: context - context of a shell (i.e. working directory). Null is valid and means to use the default context.; monitor - the progress monitor
Returns:: An object that represents the command and it's output.
Throws:: Exception

runCommand

public 
Object[] runCommand(
String command,
                           
Object context)
                    throws 
Exception

Deprecated. use runCommand(String, Object, IProgressMonitor)

Execute a remote command. This is only applicable if the subsystem factory reports true for supportsCommands().

Parameters:: command - Command to be executed remotely.; context - context of a command (i.e. working directory). null is valid and means to use the default context.
Returns:: Array of objects that are the result of running this command. Typically, these are messages logged by the command.
Throws:: Exception

runCommand

public 
Object[] runCommand(
String command,
                           
Object context,
                           
IProgressMonitor monitor)
                    throws 
Exception

Execute a remote command. This is only applicable if the subsystem factory reports true for supportsCommands().

Specified by:: runCommand in interface IRemoteCmdSubSystem

Parameters:: command - Command to be executed remotely.; context - context of a command (i.e. working directory). null is valid and means to use the default context.; monitor - the progress monitor
Returns:: Array of objects that are the result of running this command. Typically, these are messages logged by the command.
Throws:: Exception

sendCommandToShell

public void sendCommandToShell(
String input,
                               
Object commandObject,
                               
IProgressMonitor monitor)
                        throws 
Exception

Send a command as input to a running command shell.

Specified by:: sendCommandToShell in interface IRemoteCmdSubSystem

Parameters:: input - the command to invoke in the shell.; commandObject - the shell or command to send the invocation to.; monitor - the progress monitor
Throws:: Exception

cancelShell

public void cancelShell(
Object commandObject)
                 throws 
Exception

Cancel a shell or running command.

Parameters:: commandObject - the shell or command to cancel.
Throws:: Exception

cancelShell

public void cancelShell(
Object commandObject,
                        
IProgressMonitor monitor)
                 throws 
Exception

Cancel a shell or running command.

Specified by:: cancelShell in interface IRemoteCmdSubSystem

Parameters:: commandObject - the shell or command to cancel.; monitor - the progress monitor
Throws:: Exception

removeShell

public void removeShell(
Object commandObject)
                 throws 
Exception

Remove and Cancel a shell or running command.

Specified by:: removeShell in interface IRemoteCmdSubSystem

Parameters:: commandObject - the shell or command to cancel.
Throws:: Exception

internalRunCommand

protected 
Object[] internalRunCommand(
String cmd,
                                      
Object context,
                                      
IProgressMonitor monitor)
                               throws 
InvocationTargetException,
                                      
InterruptedException,
                                      
SystemMessageException

Runs a remote command. This method must be overridden by implementers of command subsystems.

Parameters:: cmd - The command to execute.; context - The IServiceCommandShell that provides the context in which to run this command.; monitor - a monitor for progress and cancellation, the caller is expected to call monitor.done()
Returns:: an array of 1 object, the IServiceCommandShell, which can be queried for output.
Throws:: InterruptedException - if the user cancels the operation; SystemMessageException - if the command results in an error on the target system; InvocationTargetException - if something else bad happens

internalRunCommand

protected 
Object[] internalRunCommand(
String cmd,
                                      
Object context,
                                      boolean interpretOutput,
                                      
IProgressMonitor monitor)
                               throws 
InvocationTargetException,
                                      
InterruptedException,
                                      
SystemMessageException

Runs a remote command and interprets any resulting output. This method must be overridden by implementers of command subsystems.

Parameters:: cmd - The command to execute.; context - The IServiceCommandShell that provides the context in which to run this command.; monitor - a monitor for progress and cancellation, the caller is expected to call monitor.done()
Returns:: an array of 1 object, the IServiceCommandShell, which can be queried for output.
Throws:: InterruptedException - if the user cancels the operation; SystemMessageException - if the command results in an error on the target system; InvocationTargetException - if something else bad happens

internalRunShell

protected 
IRemoteCommandShell internalRunShell(
Object context,
                                               
IProgressMonitor monitor)
                                        throws 
InvocationTargetException,
                                               
InterruptedException,
                                               
SystemMessageException

Establishes a new shell. This causes the shell to start and establish its initial environment. This method must be overridden by implementers of command subsystems.

Parameters:: context - the current directory for this shell. Can be a String containing a path name to be used as the current directory or an IRemoteFile representing a directory. If null or "null", the home directory is used.; monitor - a monitor for progress and cancellation, the caller is expected to call monitor.done()
Returns:: the newly established shell.
Throws:: InterruptedException - if the user cancels the operation; SystemMessageException - if the command results in an error on the target system; InvocationTargetException - if something else bad happens

internalCancelShell

protected void internalCancelShell(
Object command,
                                   
IProgressMonitor monitor)
                            throws 
InvocationTargetException,
                                   
InterruptedException

Cancels a running shell. This method must be overridden by implementers of command subsystems.

Parameters:: command - the IServiceCommandShell to cancel.; monitor - a monitor for progress and cancellation, the caller is expected to call monitor.done()
Throws:: InterruptedException - if the user cancels the operation; InvocationTargetException - if something else bad happens

internalSendCommandToShell

protected void internalSendCommandToShell(
String cmd,
                                          
Object command,
                                          
IProgressMonitor monitor)
                                   throws 
InvocationTargetException,
                                          
InterruptedException

Sends a command to a shell for execution. This method must be overridden by implementers of command subsystems.

Parameters:: cmd - the command to execute.; command - the IServiceCommandShell that provides the context in which to execute the command.; monitor - a monitor for progress and cancellation, the caller is expected to call monitor.done()
Throws:: InterruptedException - if the user cancels the operation; InvocationTargetException - if something else bad happens

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.subsystems.shells.core.subsystems Class RemoteCmdSubSystem

_cmdShells

_defaultShell

_fileSubSystem

RemoteCmdSubSystem

initializeSubSystem

getParentRemoteCmdSubSystemConfiguration

checkForCancel

getEnvironmentVariableList

setEnvironmentVariableList

addEnvironmentVariable

addEnvironmentVariable

removeEnvironmentVariable

removeEnvironmentVariable

getEnvironmentVariable

getEnvironmentVariableValue

getEnvVarsAsStringArray

isUniqueVariable

getUserAndHostEnvVarsAsStringArray

isWindows

getCandidateCommands

parsePathEnvironmentVariable

getFileSubSystem

getInvalidEnvironmentVariableNameCharacters

getCommandSubSystem

internalResolveFilterString

getChildren

hasChildren

getDefaultShell

getShells

canRunShell

canRunCommand

getObjectWithAbsoluteName

saveShellState

internalRemoveShell

restoreShellState

cancelAllShells

isPassiveCommunicationsListener

communicationsStateChange

createPropertySet

runCommand

runCommand

runShell

runShell

runCommand

runCommand

sendCommandToShell

cancelShell

cancelShell

removeShell

internalRunCommand

internalRunCommand

internalRunShell

internalCancelShell

internalSendCommandToShell

org.eclipse.rse.subsystems.shells.core.subsystems
Class RemoteCmdSubSystem