nextapp.echo2.app.update.UpdateManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
There is a newer version: 2.0.4
/* 
 * This file is part of the Echo Web Application Framework (hereinafter "Echo").
 * Copyright (C) 2002-2009 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

package nextapp.echo2.app.update;

import java.io.Serializable;

import nextapp.echo2.app.ApplicationInstance;

/**
 * Primary interface to update management architecture.
 */
public class UpdateManager 
implements Serializable {

    private ClientUpdateManager clientUpdateManager;
    private ServerUpdateManager serverUpdateManager;
    private ApplicationInstance applicationInstance;
    
    /**
     * Creates a new UpdateManager.
     * Warning: the creator must take care to invoke the
     * dispose() method before dereferencing this object.
     * 
     * @param applicationInstance the ApplicationInstance which
     *        this manager will service
     */
    public UpdateManager(ApplicationInstance applicationInstance) {
        super();
        this.applicationInstance = applicationInstance;
        clientUpdateManager = new ClientUpdateManager(applicationInstance);
        serverUpdateManager = new ServerUpdateManager(applicationInstance);
        serverUpdateManager.init(clientUpdateManager);
    }
    
    /**
     * Returns the ClientUpdateManager, which is responsible for 
     * queuing and processing updates received from the client. 
     * 
     * @return the ClientUpdateManager
     */
    public ClientUpdateManager getClientUpdateManager() {
        return clientUpdateManager;
    }
    
    /**
     * Returns the ServerUpdateManager, which is responsible for
     * queuing server-side updates and rendering them to the client.
     * 
     * @return the ServerUpdateManager
     */
    public ServerUpdateManager getServerUpdateManager() {
        return serverUpdateManager;
    }
    
    /**
     * Processes client updates.
     * Processes any queued tasks.
     * Validates the component hierarchy for rendering in response to updates.
     */
    public void processClientUpdates() {
        // Process client state updates.
        clientUpdateManager.process();
        
        // Processed queued asynchronous tasks.
        applicationInstance.processQueuedTasks();
        
        // Validate the state of the hierarchy prior to rendering.
        applicationInstance.doValidation();
    }
    
    /**
     * Purges all client and server updates.
     */
    public void purge() {
        clientUpdateManager.purge();
        serverUpdateManager.purge();
    }
}