Remote Systems
v6.4.1

com.ibm.etools.systems.dstore.miners.command
Class CommandMiner

java.lang.Object
  extended bycom.ibm.etools.systems.dstore.core.miners.miner.Miner
      extended bycom.ibm.etools.systems.dstore.miners.command.CommandMiner
All Implemented Interfaces:
ISchemaExtender

public class CommandMiner
extends Miner

The CommandMiner provides the ability to run remote interactive shell commands via the DataStore.


Nested Class Summary
 class CommandMiner.CommandMinerDescriptors
           
 
Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.systems.dstore.core.miners.miner.Miner
_dataStore, _dependencies, _minerData, _minerElement, _minerTransient, _name, _resourceBundle, _value
 
Constructor Summary
CommandMiner()
           
 
Method Summary
 void extendSchema(DataElement schemaRoot)
          Add this tool's schema to the global DataStore schema.
protected  ArrayList getDependencies()
           
 void getPossibleCommands(DataElement status)
           
 String getVersion()
          Returns the version of this miner The expected format for this is ".
 DataElement handleCommand(DataElement theElement)
          Handle commands that are routed to this miner.
 void launchCommand(DataElement subject, String invocation, DataElement status)
           
 void load()
          Default method that gets called on a Miner when it is loaded.
 
Methods inherited from class com.ibm.etools.systems.dstore.core.miners.miner.Miner
command, createAbstractCommandDescriptor, createAbstractObjectDescriptor, createAbstractObjectDescriptor, createAbstractRelationship, createCommandDescriptor, createCommandDescriptor, createObjectDescriptor, createObjectDescriptor, createReference, createRelationDescriptor, finish, getCommandArgument, getCommandName, getCommandStatus, getExternalLoader, getLocalizedString, getMinerData, getMinerDependencies, getMinerElement, getMinerTransient, getName, getNumberOfCommandArguments, getResourceBundle, getSchemaRoot, getValue, isConnected, isInitialized, load, makeTransient, setDataStore, setExternalLoader, updateMinerInfo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

CommandMiner

public CommandMiner()
Method Detail

load

public void load()
Description copied from class: Miner
Default method that gets called on a Miner when it is loaded. Override this function to perform some initialization at miner loading time.

Overrides:
load in class Miner

getDependencies

protected ArrayList getDependencies()
Overrides:
getDependencies in class Miner

extendSchema

public void extendSchema(DataElement schemaRoot)
Description copied from interface: ISchemaExtender
Add this tool's schema to the global DataStore schema. This interface must be implemented by each miner in order to populate the DataStore schema with information about this tool's object model and information about how to communicate with the tool from objects available to the user interface.

Parameters:
schemaRoot - the descriptor root

handleCommand

public DataElement handleCommand(DataElement theElement)
Description copied from class: Miner
Handle commands that are routed to this miner. This interface must be implemented by each miner in order to perform tool actions driven from user interface interaction.

Specified by:
handleCommand in class Miner
Parameters:
theElement - an instance of a command containing a tree of arguments

getPossibleCommands

public void getPossibleCommands(DataElement status)

launchCommand

public void launchCommand(DataElement subject,
                          String invocation,
                          DataElement status)

getVersion

public String getVersion()
Description copied from class: Miner
Returns the version of this miner The expected format for this is ".." This MUST be overridden if version support is required FIXME make this abstract next release

Overrides:
getVersion in class Miner

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.