KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > webcontainer > ActionProcessor


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.webcontainer;
31
32 import org.w3c.dom.Element JavaDoc;
33
34 import nextapp.echo2.app.Component;
35
36 /**
37  * An optional interface for <code>ComponentSynchronizePeer</code>s that provides
38  * the capability to receive <strong>IMMEDIATE</strong> notification of
39  * state updates from the client.
40  * This interface must be implemented by any component that creates
41  * "EchoAction" message parts on the client in a ClientMessage.
42  *
43  * @see nextapp.echo2.webcontainer.PropertyUpdateProcessor
44  */
45 public interface ActionProcessor {
46     
47     /**
48      * The attribute name of XML 'property' elements that specifies
49      * the name of the property.
50      */
51     public static final String JavaDoc ACTION_NAME = "name";
52
53     /**
54      * The attribute name of XML 'property' elements that specifies
55      * the value of the property. Property elements may instead
56      * pass property data in child XML elements, and in such cases
57      * should not have a 'value' attribute.
58      */
59     public static final String JavaDoc ACTION_VALUE = "value";
60
61     /**
62      * Notifies the <code>ComponentSynchronizePeer</code> that a client action
63      * has occurred.
64      *
65      * @param ci the relevant <code>ContainerInstance</code>
66      * @param component the target <code>Component</code>
67      * @param actionElement the XML element describing the action
68      * (the name and value of the action may be obtained
69      * by querying the <code>ACTION_NAME</code> and
70      * <code>ACTION_VALUE</code> attribute values.
71      */
72     public void processAction(ContainerInstance ci, Component component, Element JavaDoc actionElement);
73 }
74
Popular Tags