com.ibm.eNetwork.HOD.customizable
Class HODSessionManager

java.lang.Object
  |
  +--com.ibm.eNetwork.HOD.customizable.HODSessionManager

public class HODSessionManager

extends java.lang.Object

Constructor Summary

HODSessionManager()
Constructor for the HODSessionManager object

Method Summary

CustomDesktop	createCustomDesktop(com.ibm.eNetwork.HOD.common.Environment env, java.lang.String readDirectory) Method used to create a CustomDesktop for a custom Java applet.
CustomDesktop	createCustomDesktop(java.awt.Frame parentFrame, java.io.File file, java.lang.String readDirectory) Method used to create a CustomDesktop for a custom Java application where the session definitions reside on the local workstation.
CustomDesktop	createCustomDesktop(java.awt.Frame parentFrame, java.lang.String url, java.lang.String readDirectory) Method used to create a CustomDesktop for a custom Java application where the session definitions reside on a webserver.
HODDesktop	createHODDesktop(com.ibm.eNetwork.HOD.common.Environment env, java.lang.String readDirectory) Method used to create a HODDesktop for a custom Java applet.
HODDesktop	createHODDesktop(java.awt.Frame parentFrame, java.io.File file, java.lang.String readDirectory) Method used to create a HODDesktop for a custom Java application where the session definitions reside on the local workstation.
HODDesktop	createHODDesktop(java.awt.Frame parentFrame, java.lang.String url, java.lang.String readDirectory) Method used to create a HODDesktop for a custom Java application where the session definitions reside on a webserver.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HODSessionManager

public HODSessionManager()

Constructor for the HODSessionManager object

Method Detail

createHODDesktop

public HODDesktop createHODDesktop(com.ibm.eNetwork.HOD.common.Environment env,
                                   java.lang.String readDirectory)
                            throws HODSessionException

Method used to create a HODDesktop for a custom Java applet. The Environment object must be created by the applet.

When using a custom applet, the HTML page must have the following applet parameter
PARAM NAME="ParameterFile" VALUE="HODData\\readDirectory\\params.txt"
where "readDirectory" is the same as the second parameter.

If you are also entered "Additional Parameters" for the Host On-Demand code through the Deployment Wizard, you must also have the following applet parameter
PARAM NAME="UserDefinedParameterFile" VALUE="HODData\\readDirectory\\udparams.txt"
where "readDirectory" is the same as the second parameter.

Parameters:

env - Environment object used by the custom applet

readDirectory - Directory name of the subdirectory under the HODData directory

Throws:

HODSessionException - Thrown if a desktop has already been opened

createHODDesktop

public HODDesktop createHODDesktop(java.awt.Frame parentFrame,
                                   java.io.File file,
                                   java.lang.String readDirectory)
                            throws HODSessionException

Method used to create a HODDesktop for a custom Java application where the session definitions reside on the local workstation.

Parameters:

parentFrame - Frame created as part of the java application.

file - A File object of the directory containing the HODData subdirectory.

readDirectory - Directory name of the subdirectory under the HODData directory

Throws:

HODSessionException - Thrown if a desktop has already been opened

createHODDesktop

public HODDesktop createHODDesktop(java.awt.Frame parentFrame,
                                   java.lang.String url,
                                   java.lang.String readDirectory)
                            throws HODSessionException

Method used to create a HODDesktop for a custom Java application where the session definitions reside on a webserver. The web server used must not require authentication. Also, if the web server uses https, the JVM being used must be capable of supporting https.

Parameters:

parentFrame - Frame created as part of the java application.

url - A URL of the web server where the session definitions reside. Must be in the form of "http://host/alias".

readDirectory - Directory matching the name of the HTML page created by Deployment Wizard and matching the name of the subdirectory under HODData on the web server

Throws:

HODSessionException - Thrown if a desktop has already been opened

createCustomDesktop

public CustomDesktop createCustomDesktop(com.ibm.eNetwork.HOD.common.Environment env,
                                         java.lang.String readDirectory)
                                  throws HODSessionException

Method used to create a CustomDesktop for a custom Java applet. The Environment object must be created by the applet.

When using a custom applet, the HTML page must have the following applet parameter
PARAM NAME="ParameterFile" VALUE="HODData\\readDirectory\\params.txt" where "readDirectory" is the same as the second parameter.

If you are also entered "Additional Parameters" for the Host On-Demand code through the Deployment Wizard, you must also have the following applet parameter
PARAM NAME="UserDefinedParameterFile" VALUE="HODData\\readDirectory\\udparams.txt"
where "readDirectory" is the same as the second parameter.

Parameters:

env - Environment object used by the custom applet

readDirectory - Directory name of the subdirectory under the HODData directory

Throws:

HODSessionException - Thrown if a desktop has already been opened

createCustomDesktop

public CustomDesktop createCustomDesktop(java.awt.Frame parentFrame,
                                         java.io.File file,
                                         java.lang.String readDirectory)
                                  throws HODSessionException

Method used to create a CustomDesktop for a custom Java application where the session definitions reside on the local workstation.

Parameters:

parentFrame - Frame created as part of the java application.

file - A File object of the directory containing the HODData subdirectory.

readDirectory - Directory name of the subdirectory under the HODData directory

Throws:

HODSessionException - Thrown if a desktop has already been opened

createCustomDesktop

public CustomDesktop createCustomDesktop(java.awt.Frame parentFrame,
                                         java.lang.String url,
                                         java.lang.String readDirectory)
                                  throws HODSessionException

Method used to create a CustomDesktop for a custom Java application where the session definitions reside on a webserver.

Parameters:

parentFrame - Frame created as part of the java application.

url - A URL of the web server where the session definitions reside. Must be in the form of "http://host/alias".

readDirectory - Directory matching the name of the HTML page created by Deployment Wizard and matching the name of the subdirectory under HODData on the web server

Throws:

HODSessionException - Thrown if a desktop has already been opened