001: /*
002: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * 1. Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: * 2. Redistributions in binary form must reproduce the above copyright notice,
010: * this list of conditions and the following disclaimer in the documentation
011: * and/or other materials provided with the distribution.
012: * 3. The end-user documentation included with the redistribution, if any, must
013: * include the following acknowledgment:
014: *
015: * "This product includes software developed by Gargoyle Software Inc.
016: * (http://www.GargoyleSoftware.com/)."
017: *
018: * Alternately, this acknowledgment may appear in the software itself, if
019: * and wherever such third-party acknowledgments normally appear.
020: * 4. The name "Gargoyle Software" must not be used to endorse or promote
021: * products derived from this software without prior written permission.
022: * For written permission, please contact info@GargoyleSoftware.com.
023: * 5. Products derived from this software may not be called "HtmlUnit", nor may
024: * "HtmlUnit" appear in their name, without prior written permission of
025: * Gargoyle Software Inc.
026: *
027: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
028: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
029: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
030: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
031: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
032: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
033: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
034: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
035: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
036: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
037: */
038: package com.gargoylesoftware.htmlunit;
039:
040: import java.lang.ref.WeakReference;
041:
042: import org.apache.commons.logging.Log;
043: import org.apache.commons.logging.LogFactory;
044:
045: import com.gargoylesoftware.htmlunit.html.HtmlPage;
046:
047: /**
048: * This {@link AjaxController} resynchronizes calls calling from the main thread.
049: * The idea is that asynchron AJAX calls performed directly in response to a user
050: * action (therefore in the "main" thread and not in the thread of a background task)
051: * are directly useful for the user. To easily have a testable state, these calls
052: * are performed synchron.
053: *
054: * <span style="color:red">EXPERIMENTAL - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br/>
055: *
056: * @version $Revision: 1165 $
057: * @author Marc Guillemot
058: */
059: public class NicelyResynchronizingAjaxController extends AjaxController {
060:
061: private static final long serialVersionUID = -5406000795046341395L;
062:
063: private final WeakReference originatedThread_;
064:
065: /**
066: * Create an instance.
067: */
068: public NicelyResynchronizingAjaxController() {
069: originatedThread_ = new WeakReference(Thread.currentThread());
070: }
071:
072: /**
073: * Return the log
074: * @return The log.
075: */
076: protected final Log getLog() {
077: return LogFactory.getLog(getClass());
078: }
079:
080: /**
081: * Resynchronizes calls performed from the thread where this instance has
082: * been created.
083: * {@inheritDoc}
084: */
085: public boolean processSynchron(final HtmlPage page,
086: final WebRequestSettings requestSettings,
087: final boolean async) {
088:
089: if (async && isInOriginalThread()) {
090: getLog().info(
091: "Re-synchronized call to "
092: + requestSettings.getURL());
093: return true;
094: } else {
095: return !async;
096: }
097: }
098:
099: /**
100: * Indicates if currently executing thread is the one in which this instance has been
101: * created
102: * @return <code>true</code> if it's the same thread
103: */
104: boolean isInOriginalThread() {
105: return Thread.currentThread() == originatedThread_.get();
106: }
107: }
|