nextapp.echo.webcontainer.Synchronization Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of echo3-webcontainer Show documentation
Echo Web Framework Servlet
The newest version!
/* 
 * This file is part of the Echo Web Application Framework (hereinafter "Echo").
 * Copyright (C) 2002-2009 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

package nextapp.echo.webcontainer;

import java.io.IOException;

import javax.servlet.http.HttpServletResponse;

import nextapp.echo.app.util.Log;
import nextapp.echo.webcontainer.util.XmlRequestParser.InvalidXmlException;

/**
 * The high-level object which encapsulates the core of the client-server synchronization process for 
 * server-side applications.
 */
public class Synchronization 
implements SynchronizationState {

    /** The Connection being processed. */
    private Connection conn;
    
    /** The relevant UserInstance. */
    private UserInstance userInstance;
    
    /** Flag indicating whether synchronization is coming from an out-of-sync client. */
    private boolean outOfSync = false;
    
    private InputProcessor inputProcessor;

    /**
     * Creates a new Synchronization.
     * 
     * @param conn the synchronization Connection 
     */
    public Synchronization(Connection conn) 
    throws IOException {
        super();
        this.conn = conn;
    }
    
    /**
     * @see nextapp.echo.webcontainer.SynchronizationState#isOutOfSync()
     */
    public boolean isOutOfSync() {
        return outOfSync;
    }
    
    /**
     * @see nextapp.echo.webcontainer.SynchronizationState#setOutOfSync()
     */
    public void setOutOfSync() {
        outOfSync = true;
    }

    /**
     * Processes input from the connection and renders output.
     * 
     * Performs the following operations:
     * 
     *  Initializes the UserInstance if it is new.
     *  Activates the ApplicationInstance.
     *  Processes input to the connection using an InputProcessor.
     *  Generates output for the connection using an OutputProcessor.
     *  Purges updates from the UpdateManager (which were processed by the OutputProcessor.
     *  Deactivates the ApplicationInstance.
     * 
     * 
     * @throws IOException
     */
    public void process() 
    throws IOException {
        try {
            inputProcessor = new InputProcessor(this, conn);
        } catch (InvalidXmlException ex) {
            // Invalid request made.
            Log.log("Invalid XML Received, returning 400/Bad Request.", ex);
            conn.getResponse().sendError(HttpServletResponse.SC_BAD_REQUEST, "Invalid XML");
            return;
        }
        
        userInstance = conn.getUserInstance(inputProcessor.getWindowId(), inputProcessor.getInitId());

        synchronized(userInstance) {
            boolean initRequired = !userInstance.isInitialized();
            
            if (initRequired) {
                // Initialize user instance.
                userInstance.initHTTP(conn);
            }

            userInstance.setActive(true);
            try {
                // Process client input.
                inputProcessor.process();
                
                // Manage render states.
                if (userInstance.getUpdateManager().getServerUpdateManager().isFullRefreshRequired()) {
                    userInstance.clearRenderStates();
                } else {
                    userInstance.purgeRenderStates();
                }
                
                // Render updates.
                OutputProcessor outputProcessor = new OutputProcessor(this, conn);
                outputProcessor.process();
                
                // Purge updates.
                userInstance.getUpdateManager().purge();
            } finally {
                userInstance.setActive(false);
            }
        }
    }
}