KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > webrender > ServerDelayMessage


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.webrender;
31
32 import java.io.IOException JavaDoc;
33 import java.io.InputStream JavaDoc;
34 import java.io.Serializable JavaDoc;
35
36 import javax.xml.parsers.DocumentBuilder JavaDoc;
37 import javax.xml.parsers.DocumentBuilderFactory JavaDoc;
38 import javax.xml.parsers.ParserConfigurationException JavaDoc;
39
40 import org.w3c.dom.Document JavaDoc;
41 import org.w3c.dom.Element JavaDoc;
42 import org.xml.sax.SAXException JavaDoc;
43
44 /**
45  * Representation of a client/server-interaction delay message.
46  * Client/server-interaction delay messages are presented to the user
47  * while the client is communicating synchronously with the server.
48  */
49 public abstract class ServerDelayMessage
50 implements Serializable JavaDoc {
51
52     /**
53      * The element id of the "main delay message" element which will be made
54      * visible when the any client/server interaction occurs.
55      */
56     public static final String JavaDoc ELEMENT_ID_MESSAGE = "serverDelayMessage";
57     
58     /**
59      * The element id of the "long delay message" element which will be made
60      * visible when the delay pane has been displayed for a set amount
61      * of time.
62      */
63     public static final String JavaDoc ELEMENT_ID_LONG_MESSAGE = "serverDelayMessageLong";
64
65     /**
66      * Creates a new concrete <code>ServerDelayMessage</code> implementation
67      * based on the HTML fragment contained in the specified
68      * <code>CLASSPATH</code> resource
69      *
70      * @param resourceName the <code>CLASSPATH</code> resource containing the
71      * HTML fragment
72      * @return the created <code>ServerDelayMessage</code>
73      * @throws IOException if the resource cannot be found or parsed
74      */
75     public static ServerDelayMessage createFromResource(String JavaDoc resourceName)
76     throws IOException JavaDoc {
77         Document JavaDoc document;
78         InputStream JavaDoc in = null;
79         try {
80             DocumentBuilderFactory JavaDoc factory = DocumentBuilderFactory.newInstance();
81             DocumentBuilder JavaDoc builder = factory.newDocumentBuilder();
82             in = ServerDelayMessage.class.getResourceAsStream(resourceName);
83             if (in == null) {
84                 throw new IOException JavaDoc("Resource not found: " + resourceName + ".");
85             }
86             document = builder.parse(in);
87         } catch (ParserConfigurationException JavaDoc ex) {
88             throw new IOException JavaDoc("Failed to parse InputStream.");
89         } catch (SAXException JavaDoc ex) {
90             throw new IOException JavaDoc("Failed to parse InputStream.");
91         } finally {
92             if (in != null) {
93                 try { in.close(); } catch (IOException JavaDoc ex) { }
94             }
95         }
96         
97         final Element JavaDoc messageElement = document.getDocumentElement();
98         return new ServerDelayMessage() {
99         
100             /**
101              * @see nextapp.echo2.webrender.ServerDelayMessage#getMessage()
102              */
103             public Element JavaDoc getMessage() {
104                 return messageElement;
105             }
106         };
107     }
108     
109     /**
110      * Returns the message content as an HTML element
111      *
112      * @return the HTML element
113      */
114     public abstract Element JavaDoc getMessage();
115  }
116
Popular Tags