This is archived documentation for an older version of Nirvana (v3.1). Please refer to documentation for the latest version if required.

Nirvana Enterprise Manager - WebExpress Plugin (Ajax / Comet)

Introduction

The webExpress plugin enables the Nirvana Realm Server to serve pure JavaScript clients asynchronously. As with all Nirvana plugins, the webExpress plugin is vended from a specific URL path on the server.

This is registered at the time the plugin is created. In the example below the path "/sv" is used. Any requests to the interface that this plugin belons to

This enables the Realm Server to act as a webserver and can even be used to vend applets to client browsers that may directly communicate with the Realm Server and publish and consume events from channels.

Addding a webExpress Plugin

Select the interface you wish to add the plugin to. In this case we are using he HTTP interface yo uhave just added. Then select the Add Plugin button.

When the dialog appears choose webExpress and assign a path that you will use all webExpress communications associated with this plugin. In the example below a path of "/sv" has been chosen.

Configuring the webExpress Plugin

Parameter Name
Description
Default Value
AddUserAsCookie Add the username to the session cookie. This is only relevant if Nirvana authentication is being used. false
AuthParameters List of key value pairs that are passed to the Authentictor classes init function. This is only relevant if Nirvana authentication is being used.  
Authenticator Classname for Authenticator class to be used. This should be left blank unless Nirvana authentication is being used.  
BackgroundImage Name of the image to be used if the webExpress plugin will be used for chat generation  
EnableStatus Determines whether the Nirvana webExpress status will be vended. The page gives details on all connected webExpress users . This property is disabled by default for security reasons. false
GroupNames Name of the groups which users must be a member of in order to access this webExpress plugin. This is only relevant if Nirvana authentication is being used.  
InitJavascript An initial body of JavaScript code which will be sent to clients on who request the webExpress plugin. This allows administrators to push bootstrap script tags to clients. None.
MimeType
Name of the file to load the mime type information from. The format of this file is :
<mimetype> <fileExtension> 		Built in types used.
ReloadUserFileDynamically Specify whether the plugin shoudl reload any user changes after initialisation or only at startup. This is only relevant if Nirvana authentication is being used. false
RoleNames A comma separated list of Roles that authenticated users must have in order to access the plugin. This is only relevant if Nirvana authentication is being used. false
SecurityRealm Name of the authentication realm. This is only relevant if Nirvana authentication is being used.  
SessionManagementClass Name of the class to use for session management. This allows you to mange session timeouts etc.  
SessionManagementConfig A comma separated list o fkey value pairs which are passed to the SessionManagementClass at initialistion. These are specified in the key=value format.  

After the plugin has been configured all requests to this interface (which in this example is running HTTP on port 80) for the path /sv will be processed by the webExpress plugin.

Please note that the interface should be stopped prior to making any subsequent changes to the configurations of any plugins after they are initally created.