| java.lang.Object
 nextapp.echo2.webrender.service.SynchronizeService
All known Subclasses: nextapp.echo2.webrender.ClientAnalyzerProcessor, nextapp.echo2.webcontainer.ContainerSynchronizeService,
| SynchronizeService | | abstract public class SynchronizeService implements Service(Code) | | A service which synchronizes the state of the client with that of the server.
Requests made to this service are in the form of "ClientMessage" XML
documents which describe the user's actions since the last synchronization,
e.g., the input typed into text fields and the action taken (e.g., a button
press) which caused the server interaction. The service parses this XML input
from the client and performs updates to the server state of the application.
Once the input has been processed by the server application, an output
"ServerMessage" containing instructions to update the client state is
generated as a response.
|
| Inner Class :public static interface ClientMessagePartProcessor | |
| SERVICE_ID | | final public static String SERVICE_ID(Code) | | Service identifier.
|
| SynchronizeService | | public SynchronizeService()(Code) | | Creates a new SynchronizeService.
|
| processClientMessage | | protected void processClientMessage(Connection conn, Document clientMessageDocument)(Code) | | Processes a "ClientMessage" XML document containing application UI state
change information from the client. This method will parse the
message parts of the ClientMessage and invoke the
ClientMessagePartProcessors registered to process them.
Parameters:
conn - the relevant Connection
Parameters:
clientMessageDocument - the ClientMessage XML document to process
See Also: ClientMessagePartProcessor |
| registerClientMessagePartProcessor | | protected void registerClientMessagePartProcessor(ClientMessagePartProcessor processor)(Code) | | Registers a ClientMessagePartProcessor to handle a
specific type of message part.
Parameters:
processor - the ClientMessagePartProcessor to register
throws:
IllegalStateException - if a processor with the same name is already registered |
| renderInit | | abstract protected ServerMessage renderInit(Connection conn, Document clientMessageDocument)(Code) | | Renders a ServerMessage in response to the initial
synchronization.
Parameters:
conn - the relevant Connection
Parameters:
clientMessageDocument - the ClientMessage XML document the generated ServerMessage |
| renderUpdate | | abstract protected ServerMessage renderUpdate(Connection conn, Document clientMessageDocument)(Code) | | Renders a ServerMessage in response to a synchronization
other than the initial synchronization.
Parameters:
conn - the relevant Connection
Parameters:
clientMessageDocument - the ClientMessage XML document the generated ServerMessage |
|
|