se.entra.phantom.server.http

Class HtmlApplicationCGI

java.lang.Object

se.entra.phantom.server.http.HtmlApplicationCGI

All Implemented Interfaces:

CgiHtmlResourceInterface

public class HtmlApplicationCGI
extends Object
implements CgiHtmlResourceInterface

The class that runs a NetPhantom application.

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPERROR_APPEXIT Application exit message.
static int	APPERROR_CLIENTDISPOSED Client is disposed message.
static int	APPERROR_CLIENTTIMEOUT Client session timed out.
static int	APPERROR_HOSTSCRNOTFOUND Host screen not recognized.
static int	APPERROR_HOSTSESSIONFAILED Host session failed.
static int	APPERROR_INVALIDCOOKIE Invalid cookie session ID.
static int	APPERROR_INVALIDSESSION Invalid session ID.
static int	APPERROR_MAXCURRUSERS Maximum current user count reached.
static int	APPERROR_MSGBOXREPLY Invalid messagebox reply.
static String	NPAPP_SESSIONID Form data NetPhantom application session ID when cookie not used.

Constructor Summary

Constructors

Constructor and Description
HtmlApplicationCGI()

Method Summary

Modifier and Type	Method and Description
static HtmlResource	applicationError(HttpSession session, int errMsg, String errTextExtra) Sends the application error document.
protected void	initializeUserExitSession(HttpSession httpSession) User exit for session initialization.
HtmlResource	performAction(HttpSession newSession) This method should return an HtmlResourceData instance with the document that should be sent to the client.
protected HtmlResource	validateUserExitSession(HttpSession httpSession) Overload this method for User exit session validation.

Methods inherited from class java.lang.Object

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

Field Detail

APPERROR_MAXCURRUSERS

public static final int APPERROR_MAXCURRUSERS

Maximum current user count reached.

See Also:

Constant Field Values

APPERROR_INVALIDCOOKIE

public static final int APPERROR_INVALIDCOOKIE

Invalid cookie session ID.

See Also:

Constant Field Values

APPERROR_INVALIDSESSION

public static final int APPERROR_INVALIDSESSION

Invalid session ID.

See Also:

Constant Field Values

APPERROR_MSGBOXREPLY

public static final int APPERROR_MSGBOXREPLY

Invalid messagebox reply.

See Also:

Constant Field Values

APPERROR_HOSTSESSIONFAILED

public static final int APPERROR_HOSTSESSIONFAILED

Host session failed.

See Also:

Constant Field Values

APPERROR_HOSTSCRNOTFOUND

public static final int APPERROR_HOSTSCRNOTFOUND

Host screen not recognized.

See Also:

Constant Field Values

APPERROR_CLIENTTIMEOUT

public static final int APPERROR_CLIENTTIMEOUT

Client session timed out.

See Also:

Constant Field Values

APPERROR_APPEXIT

public static final int APPERROR_APPEXIT

Application exit message.

See Also:

Constant Field Values

APPERROR_CLIENTDISPOSED

public static final int APPERROR_CLIENTDISPOSED

Client is disposed message.

See Also:

Constant Field Values

NPAPP_SESSIONID

public static final String NPAPP_SESSIONID

Form data NetPhantom application session ID when cookie not used.

See Also:

Constant Field Values

Constructor Detail

HtmlApplicationCGI

public HtmlApplicationCGI()

Method Detail

performAction

public HtmlResource performAction(HttpSession newSession)
                           throws IOException

This method should return an HtmlResourceData instance with the document that should be sent to the client.

The current directory of the CGI for the client agent is defined in the HttpSession class instance.

Specified by:

performAction in interface CgiHtmlResourceInterface

Throws:

IOException - for IO errors.

validateUserExitSession

protected HtmlResource validateUserExitSession(HttpSession httpSession)

Overload this method for User exit session validation.

Returns:

error HtmlResource if validation failed, otherwise null.

initializeUserExitSession

protected void initializeUserExitSession(HttpSession httpSession)

User exit for session initialization.

applicationError

public static HtmlResource applicationError(HttpSession session,
                                            int errMsg,
                                            String errTextExtra)
                                     throws IOException

Sends the application error document.

Throws:

IOException - for IO errors.