SessionEvents Class Reference

Abstract class which defines the interfaces that are called during the lifetime of a <class>CSP.Session</class> object. More...

Inheritance diagram for SessionEvents:

Collaboration diagram for SessionEvents:

Static Public Member Functions
_.Library.Status	OnApplicationChange (_.Library.String oldapp, _.Library.String newapp)
	Called when a session that was in CSP application oldapp is now going to run a page in. More...
_.Library.Status	OnEndRequest ()
	Called when we have finished processing this request.
	OnEndSession ()
	Called when the session is about to be deleted, either because of a timeout (in which case. More...
_.Library.Status	OnLogin ()
	Called when a login occurs that changed the $username or the roles this user is running with. More...
_.Library.Status	OnLogout ()
	Called when a logout. More...
_.Library.Status	OnStartRequest ()
	Called when we start getting data from the CSP gateway for a request.
	OnStartSession ()
	Called when a new session is created and its values are initialised. More...
	OnTimeout ()
	Called when the CSP Daemon times out out this session before calling <method>EndSession</method>. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

Abstract class which defines the interfaces that are called during the lifetime of a <class>CSP.Session</class> object.

In order to use this you should subclass this and implement the method code you wish to be executed. Then within the CSP application configuration set the event class to the class you have created.

Member Function Documentation

OnApplicationChange()

_.Library.Status OnApplicationChange ( _.Library.String  oldapp, _.Library.String  newapp  )

static

Called when a session that was in CSP application oldapp is now going to run a page in.

CSP application newapp. If this returns an error value then instead of running the page in the new application it will redirect to the error page (error page looked up from old application).

Reimplemented in SessionEvents.

OnEndSession()

OnEndSession ( )

static

Called when the session is about to be deleted, either because of a timeout (in which case.

<method>OnTimeout</method> is called first) or because the application has explicitly closed this session. Use the session object to examine this session. If you wish to abort this deletion then:

Set session.EndSession=0

Reimplemented in SessionEvents, and StudioTemplateEvent.

OnLogin()

_.Library.Status OnLogin ( )

static

Called when a login occurs that changed the $username or the roles this user is running with.

If this returns an error status then this is reported via the standard error page.

OnLogout()

_.Library.Status OnLogout ( )

static

Called when a logout.

The current authentication for the session is invalidated. occurs that changed the $username or the roles this user is running with.

If this returns an error status then the logout will be stopped. If you wish to end the session after the logout then:

Set session.EndSession=1

OnStartSession()

OnStartSession ( )

static

Called when a new session is created and its values are initialised.

This is called before the license for this session is allocated, and if you wish to abort this session and return the standard out of licenses error page then:

Set session.EndSession=1

Reimplemented in SessionEvents.

OnTimeout()

OnTimeout ( )

static

Called when the CSP Daemon times out out this session before calling <method>EndSession</method>.

Use the session object to examine this session. If you wish to abort this deletion then:

Set session.EndSession=0

Reimplemented in SessionEvents.