nextapp.echo2.webcontainer.PropertyUpdateProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
There is a newer version: 2.0.4
/* 
 * 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.echo2.webcontainer;

import org.w3c.dom.Element;

import nextapp.echo2.app.Component;

/**
 * An optional interface for ComponentSynchronizePeers that provides
 * the capability to receive DELAYED notification of
 * state updates from the client.   The delayed state notifications will
 * be provided to the server when a state change occurs to a component
 * which requires immediate notification.  The delayed state notifications
 * will be provided to the application before the immediate notification,
 * though they will be processed in no particular order.
 * This interface must be implemented by any component that creates
 * "EchoPropertyUpdate" message parts on the client in a ClientMessage.
 * 
 * @see nextapp.echo2.webcontainer.ActionProcessor
 */
public interface PropertyUpdateProcessor {
    
    /**
     * The attribute name of XML 'property' elements that specifies
     * the name of the property.
     */
    public String PROPERTY_NAME = "name";

    /**
     * The attribute name of XML 'property' elements that specifies
     * the value of the property.  Property elements may instead
     * pass property data in child XML elements, and in such cases
     * should not have a 'value' attribute.
     */
    public String PROPERTY_VALUE = "value";
    
    /**
     * Notifies the ComponentSynchronizePeer that a client property 
     * update has occurred.
     * 
     * @param ci the relevant ContainerInstance
     * @param component the target Component
     * @param propertyElement the XML element describing the property update
     *        (the name and value of the changed property may be obtained
     *        by querying the PROPERTY_NAME and 
     *        PROPERTY_VALUE attribute values. 
     */
    public void processPropertyUpdate(ContainerInstance ci, Component component, Element propertyElement);
}