KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > app > update > UpdateManager


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.app.update;
31
32 import java.io.Serializable JavaDoc;
33
34 import nextapp.echo2.app.ApplicationInstance;
35
36 /**
37  * Primary interface to update management architecture.
38  */
39 public class UpdateManager
40 implements Serializable JavaDoc {
41
42     private ClientUpdateManager clientUpdateManager;
43     private ServerUpdateManager serverUpdateManager;
44     private ApplicationInstance applicationInstance;
45     
46     /**
47      * Creates a new <code>UpdateManager</code>.
48      * <strong>Warning:</strong> the creator must take care to invoke the
49      * <code>dispose()</code> method before dereferencing this object.
50      *
51      * @param applicationInstance the <code>ApplicationInstance</code> which
52      * this manager will service
53      */
54     public UpdateManager(ApplicationInstance applicationInstance) {
55         super();
56         this.applicationInstance = applicationInstance;
57         clientUpdateManager = new ClientUpdateManager(applicationInstance);
58         serverUpdateManager = new ServerUpdateManager(applicationInstance);
59         serverUpdateManager.init(clientUpdateManager);
60     }
61     
62     /**
63      * Returns the <code>ClientUpdateManager</code>, which is responsible for
64      * queuing and processing updates received from the client.
65      *
66      * @return the <code>ClientUpdateManager</code>
67      */
68     public ClientUpdateManager getClientUpdateManager() {
69         return clientUpdateManager;
70     }
71     
72     /**
73      * Returns the <code>ServerUpdateManager</code>, which is responsible for
74      * queuing server-side updates and rendering them to the client.
75      *
76      * @return the <code>ServerUpdateManager</code>
77      */
78     public ServerUpdateManager getServerUpdateManager() {
79         return serverUpdateManager;
80     }
81     
82     /**
83      * Processes client updates.
84      * Processes any queued tasks.
85      * Validates the component hierarchy for rendering in response to updates.
86      */
87     public void processClientUpdates() {
88         // Process client state updates.
89 clientUpdateManager.process();
90         
91         // Processed queued asynchronous tasks.
92 applicationInstance.processQueuedTasks();
93         
94         // Validate the state of the hierarchy prior to rendering.
95 applicationInstance.doValidation();
96     }
97     
98     /**
99      * Purges all client and server updates.
100      */
101     public void purge() {
102         clientUpdateManager.purge();
103         serverUpdateManager.purge();
104     }
105 }
106
Popular Tags