This document covers the following topics:
A session normally ends if the page which was opened with the StartCISPage servlet is closed. This happens for example:
if the user shuts down the browser,
if the user loads a new page into the frame in which the StartCISPage servlet was called previously.
In other words: the session is normally kept alive as long as the user stays in the Application Designer environment.
Why "normally"? If a session is without user interaction for a long time, the session is timed out on the server side. When the user comes back to continue interaction, a corresponding message appears. The duration until a session is timed out is configurable; see the description of the cisconfig.xml file in the Configuration documentation for details.
If a session ends, all its subsessions and all adapters in the subsessions are automatically ended.
A subsession is ended via an API. There are two APIs available:
Via the interface
com.softwareag.cis.server.IInteractionManager
.
Via the method endProcess()
which
your adapters inherit from the Adapter
class.
For further information, see the JavaDoc documentation.
Adapters typically stay alive until the subsession ends in which they are living. There is also an API available to directly end adapters:
Method
Adapter.markThisAdapterForDestroy()
.
Via the interface IInteractionProcess
which you receive inside an adapter via
this.m_interactionProcess
.