public class Ssh2Exec extends TypedAtomicActor
Modifier and Type | Class and Description |
---|---|
static class |
Ssh2Exec.MyUserInfo |
Entity.ContainedObjectsIterator
Modifier and Type | Field and Description |
---|---|
TypedIOPort |
command
The command to be executed on the remote host.
|
TypedIOPort |
errors
The string representation of all the errors that happened during the
execution of the actor, if there are any.
|
static java.util.Hashtable |
hash |
PortParameter |
host
Host to connect to.
|
TypedIOPort |
identity
The string representation of the file path for userName's ssh
identity file if the user wants to connect without having to enter the
password all the time.
|
FileParameter |
paramIdentity
The file path for userName's ssh identity file if the user wants
to connect without having to enter the password all the time.
|
TypedIOPort |
returncode
The return code of the execution.
|
TypedIOPort |
stderr
The error that were reported by the remote execution or while connecting.
|
TypedIOPort |
stdout
Output of the command as it would output to the standard shell output.
|
Parameter |
streamingMode
Specifying whether the output should be sent in a streaming mode.
|
PortParameter |
user
Username on the SSH host to be connected to.
|
_typesValid
_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
COMPLETED, NOT_READY, STOP_ITERATING
Constructor and Description |
---|
Ssh2Exec(CompositeEntity container,
java.lang.String name)
Construct an SSH2 actor with the given container and name.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
_sendStreamOutput(java.lang.String currentStream)
This function streams the output line by line.
|
void |
attributeChanged(Attribute at)
Callback for changes in attribute values Get the WSDL from the given URL.
|
void |
fire()
Send the token in the value parameter to the output.
|
void |
wrapup()
Terminate any sessions.
|
_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints
_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName
_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList
isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate
addInitializable, initialize, preinitialize, removeInitializable
description, getContainer, getDisplayName, getFullName, getName, getName, setName
getDerivedLevel, getDerivedList, propagateValue
public PortParameter user
public PortParameter host
public FileParameter paramIdentity
The user can browse this file as it is a parameter.
public TypedIOPort identity
This is the input option for the identity file.
public TypedIOPort command
It needs to be provided as a string.
public TypedIOPort stdout
public TypedIOPort stderr
public TypedIOPort returncode
This port will return 0 (zero) if the execution is not succesfull, and a positive integer if it is successful.
public TypedIOPort errors
public Parameter streamingMode
public static java.util.Hashtable hash
public Ssh2Exec(CompositeEntity container, java.lang.String name) throws NameDuplicationException, IllegalActionException
container
- The container.name
- The name of this actor.IllegalActionException
- If the entity cannot be contained by the proposed
container.NameDuplicationException
- If the container already has an actor with this name.public void attributeChanged(Attribute at) throws IllegalActionException
attributeChanged
in class NamedObj
at
- The attribute that changed.IllegalActionException
public void fire() throws IllegalActionException
fire
in interface Executable
fire
in class AtomicActor<TypedIOPort>
IllegalActionException
- If it is thrown by the send() method sending out the
token.public void wrapup() throws IllegalActionException
wrapup
in interface Initializable
wrapup
in class AtomicActor<TypedIOPort>
IllegalActionException
- Not thrown in this base class.public java.lang.String _sendStreamOutput(java.lang.String currentStream) throws IllegalActionException
currentStream
- IllegalActionException