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

Platform Symphony 5.0 Java API Reference

com.platform.symphony.symexec
Class ExecutionSessionContext

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

public class ExecutionSessionContext
extends Message

This class is used to give context to all the commands being executed within an ExecutionSession. This class may be used in one of the more advanced forms of the ExecutionSession(...) constructor.

See Also:
ExecutionSession

Constructor Summary
ExecutionSessionContext()
          Constructor for the Execution Session 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 session.
 void setPostCommand(java.lang.String postCommand)
          Sets the command string to be post-executed at the session level.
 void setPreCommand(java.lang.String preCommand)
          Sets the command string to be pre-executed at the session level.
 void setSessionType(java.lang.String type)
          Sets the execution session type The session type argument tells Symphony which type of session to create.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExecutionSessionContext

public ExecutionSessionContext()
Constructor for the Execution Session 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 session.

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 at the session level.

Parameters:
preCommand - The command string to be executed at the session level when the session is being bound. 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 at the session level.

Parameters:
postCommand - The command string to be executed at the session level when the session is being un-bound. A null value will be treated as an empty string.
Throws:
SoamException

setSessionType

public void setSessionType(java.lang.String type)
Sets the execution session type The session type argument tells Symphony which type of session to create. In the application profile, you can define different types of sessions with different attributes. For this argument, specify the name of the session type you would like to use.

Parameters:
type - The type of execution session set before creating a session.
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 5.0
Date Modified: -DREL_DATE=Nov 11 2009
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved.