001: /*
002: * This file is part of the Echo Web Application Framework (hereinafter "Echo").
003: * Copyright (C) 2002-2005 NextApp, Inc.
004: *
005: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
006: *
007: * The contents of this file are subject to the Mozilla Public License Version
008: * 1.1 (the "License"); you may not use this file except in compliance with
009: * the License. You may obtain a copy of the License at
010: * http://www.mozilla.org/MPL/
011: *
012: * Software distributed under the License is distributed on an "AS IS" basis,
013: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
014: * for the specific language governing rights and limitations under the
015: * License.
016: *
017: * Alternatively, the contents of this file may be used under the terms of
018: * either the GNU General Public License Version 2 or later (the "GPL"), or
019: * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
020: * in which case the provisions of the GPL or the LGPL are applicable instead
021: * of those above. If you wish to allow use of your version of this file only
022: * under the terms of either the GPL or the LGPL, and not to allow others to
023: * use your version of this file under the terms of the MPL, indicate your
024: * decision by deleting the provisions above and replace them with the notice
025: * and other provisions required by the GPL or the LGPL. If you do not delete
026: * the provisions above, a recipient may use your version of this file under
027: * the terms of any one of the MPL, the GPL or the LGPL.
028: */
029:
030: package nextapp.echo2.app.update;
031:
032: import java.io.Serializable;
033:
034: import nextapp.echo2.app.ApplicationInstance;
035:
036: /**
037: * Primary interface to update management architecture.
038: */
039: public class UpdateManager implements Serializable {
040:
041: private ClientUpdateManager clientUpdateManager;
042: private ServerUpdateManager serverUpdateManager;
043: private ApplicationInstance applicationInstance;
044:
045: /**
046: * Creates a new <code>UpdateManager</code>.
047: * <strong>Warning:</strong> the creator must take care to invoke the
048: * <code>dispose()</code> method before dereferencing this object.
049: *
050: * @param applicationInstance the <code>ApplicationInstance</code> which
051: * this manager will service
052: */
053: public UpdateManager(ApplicationInstance applicationInstance) {
054: super ();
055: this .applicationInstance = applicationInstance;
056: clientUpdateManager = new ClientUpdateManager(
057: applicationInstance);
058: serverUpdateManager = new ServerUpdateManager(
059: applicationInstance);
060: serverUpdateManager.init(clientUpdateManager);
061: }
062:
063: /**
064: * Returns the <code>ClientUpdateManager</code>, which is responsible for
065: * queuing and processing updates received from the client.
066: *
067: * @return the <code>ClientUpdateManager</code>
068: */
069: public ClientUpdateManager getClientUpdateManager() {
070: return clientUpdateManager;
071: }
072:
073: /**
074: * Returns the <code>ServerUpdateManager</code>, which is responsible for
075: * queuing server-side updates and rendering them to the client.
076: *
077: * @return the <code>ServerUpdateManager</code>
078: */
079: public ServerUpdateManager getServerUpdateManager() {
080: return serverUpdateManager;
081: }
082:
083: /**
084: * Processes client updates.
085: * Processes any queued tasks.
086: * Validates the component hierarchy for rendering in response to updates.
087: */
088: public void processClientUpdates() {
089: // Process client state updates.
090: clientUpdateManager.process();
091:
092: // Processed queued asynchronous tasks.
093: applicationInstance.processQueuedTasks();
094:
095: // Validate the state of the hierarchy prior to rendering.
096: applicationInstance.doValidation();
097: }
098:
099: /**
100: * Purges all client and server updates.
101: */
102: public void purge() {
103: clientUpdateManager.purge();
104: serverUpdateManager.purge();
105: }
106: }
|