Namespace: Ccs.Common
Type: Interface ISessionManager
Parent Classes:
Inherits: Ccs.Common.IManager


This Software is licensed by Progress Software Corporation (licensor)
under the Progress Software Common Component Specification Project
Release License Agreement available at
https://community.progress.com/products/directions/common_component/p/releaselicenseagreement
The Interface definition is part of the Common Component Specification [CCSBE01]. The
file is considered as a Specification Implementation Condition as described
in section 2.1.1.1: If Licensor has made Specification Implementation
Conditions available as of the date Licensee completes its Independent
Implementation, then Licensee must, prior to making any claim that its
Independent Implementation complies with the Specification, ensure that
the Independent Implementation satisfies all of the Specification
Implementation Conditions. If Licensor subsequently makes available or
updates, from time to time, the Specification Implementation Conditions,
then Licensee will verify that its Independent Implementation satisfies the
latest version of the Specification Implementation Conditions within ninety
(90) days following Licensor's release thereof.
Contributors:
Peter Judge, Progress Software Corp [2016]
File:ISessionManager
Purpose:Base Session Manager interface
Author(s):pjudge@progress.com
Created:2017-03-02
/* Holds the reference to the current ClientContext object. This property will be unknown unless there is a valid client request.



Method Summary
  Options Name Purpose
  endRequestEnvironment () /* "End" the server session runtime and return it to a "safe" state. @throws Progress.Lang.SysError, Progress.Lang.AppError */
  establishRequestEnvironment (character) /* Establish the server session runtime. @param character A known string representing the client's session identity @throws Progress.Lang.SysError, Progress.Lang.AppError */
  establishRequestEnvironment (handle) /* Establish the server session runtime. @param handle The handle to the Client Principal object representing the client's session identity @throws Progress.Lang.SysError, Progress.Lang.AppError */

Property Summary
  Options Name Purpose
  Ccs.Common.IClientContext CurrentClientContext


Method Detail
Top

endRequestEnvironment ()

/* "End" the server session runtime and return it to a "safe" state.
@throws Progress.Lang.SysError, Progress.Lang.AppError
Top

establishRequestEnvironment (character)

/* Establish the server session runtime.
@throws Progress.Lang.SysError, Progress.Lang.AppError
Parameters:
pcSessionID CHARACTER
 
Top

establishRequestEnvironment (handle)

/* Establish the server session runtime.
@throws Progress.Lang.SysError, Progress.Lang.AppError
Parameters:
phClientPrincipal HANDLE
 


Property Detail
Top

Ccs.Common.IClientContext CurrentClientContext

Returns Ccs.Common.IClientContext