ZCS 6.0:Zimlet Developers Guide:Examples:Simple JSP via Ajax Async

1. Zimbra Tech Center
2. Community Sandbox
3. ZCS 6.0:Zimlet Developers Guide:Examples:Simple JSP via Ajax Async

ZCS 6.0: Zimlet Developer Guide:Examples:Simple JSP via AJAX Async

 - This article is a Work in Progress, and may be unfinished or missing sections.

You are looking at legacy Zimlet documentation. For Zimbra Modern UI Zimlet development go to: https://wiki.zimbra.com/wiki/DevelopersGuide#Zimlet_Development_Guide.

Introduction

Getting Started

Dev Environment Setup

Developing Zimlets

Advanced Concepts

API Specifications

Example Zimlets

Description

This zimlet shows how to launch a JSP from within the Zimlet Handler Object using Ajax and read the response asynchronously.

Definition File

<zimlet name="com_zimbra_example_simplejspasync" version="1.0" description="An example zimlet using a JSP file.">
    <include>com_zimbra_example_simplejspasync.js</include>
    <handlerObject>com_zimbra_example_simplejspasync_HandlerObject</handlerObject>
    <zimletPanelItem label="JSP Example (via Ajax)" icon="zimbraIcon">
      <toolTipText>Click to launch the JSP Example</toolTipText>
   </zimletPanelItem>
</zimlet>

Handler Object

The following code snippet from the zimlet JavaScript Handler Object show making the Ajax call to the JSP file and setting the callback method to read the response asyncrhonously:

/**
 * Displays the zimlet jsp page.
 * 
 */
com_zimbra_example_simplejspasyncHandlerObject.prototype._displayDialog = 
function() {
    var jspUrl = this.getResource("jspfile.jsp");

    var callback = new AjxCallback(this, this._rpcCallback, ["param1", "param2"])

    AjxRpc.invoke(null, jspUrl, null, callback, true);	
};

When the JSP page response is received, the callback method is executed:

/**
 * Called from the ajax callback.
 * 
 */
com_zimbra_example_simplejspasyncHandlerObject.prototype._rpcCallback =
function(p1, p2, response) {
    if (response.success == true) {
      appCtxt.getAppController().setStatusMsg(response.text);		
    }
};

Download

Zimlet Package

com_zimbra_example_simplejspasync.zip