Visit Platform at http://www.platform.com

Platform Symphony 4.1 Java API Reference

com.platform.symphony.symexec
Class ExecutionCommandContext

java.lang.Object
  extended by com.platform.symphony.soam.Message
      extended by com.platform.symphony.symexec.ExecutionCommandContext

public class ExecutionCommandContext
extends Message

This class is used to give context to the command being executed. This class may be used in the more advanced form of the ExecutionSession.sendTaskCmd(...) call.

See Also:
ExecutionSession.sendTaskCmd(String , ExecutionCommandContext)

Constructor Summary
ExecutionCommandContext()
          Constructor for the Execution Command Context object.
 
Method Summary
 void onDeserialize(InputStream stream)
          Invoked when this Message object needs to be deserialized.
 void onSerialize(OutputStream stream)
          Invoked when this Message object needs to be serialized.
 void setEnvironment(java.lang.String name, java.lang.String value)
          Sets an environment variable (i.e a name/value string pair) within the context of a command.
 void setPostCommand(java.lang.String postCommand)
          Sets the command string to be post-executed.
 void setPreCommand(java.lang.String preCommand)
          Sets the command string to be pre-executed.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExecutionCommandContext

public ExecutionCommandContext()
Constructor for the Execution Command Context object.

Method Detail

setEnvironment

public void setEnvironment(java.lang.String name,
                           java.lang.String value)
                    throws SoamException
Sets an environment variable (i.e a name/value string pair) within the context of a command.

Parameters:
name - The name of the environment variable being set.
value - The value to be assigned to this environment variable.
Throws:
SoamException

setPreCommand

public void setPreCommand(java.lang.String preCommand)
Sets the command string to be pre-executed.

Parameters:
preCommand - The command string to be executed prior to the actual command. A null value will be treated as an empty string.
Throws:
SoamException

setPostCommand

public void setPostCommand(java.lang.String postCommand)
Sets the command string to be post-executed.

Parameters:
postCommand - The command string to be executed after the actual command. A null value will be treated as an empty string.
Throws:
SoamException

onSerialize

public void onSerialize(OutputStream stream)
                 throws SoamException
Description copied from class: Message
Invoked when this Message object needs to be serialized. This method is to be implemented by the application developer, such that. Its implementation should serialize the content of this Message to the stream object provided.

Specified by:
onSerialize in class Message
Parameters:
stream - The output stream to be written
Throws:
SoamException

onDeserialize

public void onDeserialize(InputStream stream)
                   throws SoamException
Description copied from class: Message
Invoked when this Message object needs to be deserialized. This method is to be implemented by the application developer. Its implementation should read the contents of the provided stream and populate this Message object.

Specified by:
onDeserialize in class Message
Parameters:
stream - The input stream to be read
Throws:
SoamException

Version 4.1
Date Modified: -DREL_DATE=Nov 03 2008
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2008 Platform Computing Corporation. All rights reserved.