KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > gargoylesoftware > htmlunit > WaitingRefreshHandler


1 /*
2  * Copyright (c) 2002, 2005 Gargoyle Software Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright notice,
10  * this list of conditions and the following disclaimer in the documentation
11  * and/or other materials provided with the distribution.
12  * 3. The end-user documentation included with the redistribution, if any, must
13  * include the following acknowledgment:
14  *
15  * "This product includes software developed by Gargoyle Software Inc.
16  * (http://www.GargoyleSoftware.com/)."
17  *
18  * Alternately, this acknowledgment may appear in the software itself, if
19  * and wherever such third-party acknowledgments normally appear.
20  * 4. The name "Gargoyle Software" must not be used to endorse or promote
21  * products derived from this software without prior written permission.
22  * For written permission, please contact info@GargoyleSoftware.com.
23  * 5. Products derived from this software may not be called "HtmlUnit", nor may
24  * "HtmlUnit" appear in their name, without prior written permission of
25  * Gargoyle Software Inc.
26  *
27  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30  * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */
38 package com.gargoylesoftware.htmlunit;
39
40 import java.io.IOException JavaDoc;
41 import java.net.URL JavaDoc;
42
43 /**
44  * This refresh handler waits the specified number of seconds (or a user defined maximum)
45  * before refreshing the specified page, using the specified URL. Waiting happens
46  * on the current thread
47  *
48  * If you want a refresh handler that ignores the wait time, see
49  * {@link ImmediateRefreshHandler}.
50  *
51  * @version $Revision: 100 $
52  * @author <a HREF="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
53  * @author Daniel Gredler
54  */
55 public class WaitingRefreshHandler implements RefreshHandler {
56     private final int maxwait_;
57     /**
58      * Create a WaitingRefreshHandler that will wait whatver time the server or
59      * content asks unless it it longer than maxwait.
60      *
61      * @param maxwait The maximum wait time before the refresh (in seconds). A value
62      * less than one (1) will cause WaitingRefreshHandler to wait for
63      * whatever time the server or content asks.
64      */
65     public WaitingRefreshHandler(final int maxwait) {
66         maxwait_ = maxwait;
67     }
68     /**
69      * Create a WaitingRefreshHandler that will always wait whatver time the server or
70      * content asks.
71      */
72     public WaitingRefreshHandler() {
73         maxwait_ = 0;
74     }
75     
76     /**
77      * Refreshes the specified page using the specified URL after the specified number
78      * of seconds.
79      * @param page The page that is going to be refreshed.
80      * @param url The URL where the new page will be loaded.
81      * @param requestedWait The number of seconds to wait before reloading the page. If this is
82      * greater than maxwait than maxwait will be used instead.
83      * @throws IOException if the refresh fails
84      */
85     public void handleRefresh(final Page page, final URL JavaDoc url, final int requestedWait) throws IOException JavaDoc {
86         int seconds = requestedWait;
87         if (seconds > maxwait_ && maxwait_ > 0) {
88             seconds = maxwait_;
89         }
90         try {
91             Thread.sleep( seconds * 1000 );
92         }
93         catch (final InterruptedException JavaDoc e) {
94             throw new RuntimeException JavaDoc("Unknown threading error during refresh", e);
95         }
96         final WebWindow window = page.getEnclosingWindow();
97         if( window == null ) {
98             return;
99         }
100         final WebClient client = window.getWebClient();
101         client.getPage( window, new WebRequestSettings( url ) );
102     }
103
104 }
105
Popular Tags