|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nextapp.echo.webcontainer.ServerMessage
public class ServerMessage
The outgoing XML message which synchronizes the state of the client to that of the server.
Field Summary | |
---|---|
static java.lang.String |
GROUP_ID_INIT
Constant for the "init" message part group. |
static java.lang.String |
GROUP_ID_UPDATE
Constant for the "update" message part group. |
Constructor Summary | |
---|---|
ServerMessage()
Creates a new ServerMessage . |
Method Summary | |
---|---|
org.w3c.dom.Element |
addDirective(java.lang.String groupId,
java.lang.String processor)
Adds a "message-part" to the document that will be processed by the specified client-side processor object. |
org.w3c.dom.Element |
addDirective(java.lang.String groupId,
java.lang.String processor,
java.lang.String directiveName)
Creates and appends a directive element beneath to a message part. |
void |
addLibrary(java.lang.String serviceId)
Adds a JavaScript library service to be dynamically loaded. |
org.w3c.dom.Element |
addPartGroup(java.lang.String groupId)
Adds a "group" to the document. |
org.w3c.dom.Document |
getDocument()
Returns the XML DOM. |
org.w3c.dom.Element |
getPartGroup(java.lang.String groupId)
Retrieves the "message-part-group" element pertaining to a specific group. |
void |
setAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
Sets an arbitrary attribute on the root element. |
void |
setResync()
Sets the "resync" attribute to true, indicating that the server is recovering from a condition where the client has become out of sync. |
void |
setTransactionId(long transactionId)
Sets the numeric identifier for this transaction, which will be returned in next client message. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GROUP_ID_INIT
public static final java.lang.String GROUP_ID_UPDATE
Constructor Detail |
---|
public ServerMessage()
ServerMessage
.
Method Detail |
---|
public void addLibrary(java.lang.String serviceId)
serviceId
- the id of the service to load (the service must return
JavaScript code with content-type "text/javascript")public org.w3c.dom.Element addPartGroup(java.lang.String groupId)
groupId
- the identifier of the group
public org.w3c.dom.Element getPartGroup(java.lang.String groupId)
groupId
- the id of the group
public org.w3c.dom.Element addDirective(java.lang.String groupId, java.lang.String processor)
groupId
- the id of the group to which the "message-part" element
should be addedprocessor
- the name of the client-side processor object which will
process the message part, e.g., "EchoEventUpdate", or
"EchoDomUpdate"
public org.w3c.dom.Element addDirective(java.lang.String groupId, java.lang.String processor, java.lang.String directiveName)
processor
argument. If this is not
possible, a new "message-part" element is created and the directive is
added to it.
groupId
- processor
- the name of the client-side processor object which will
process the message part, e.g., "EchoEventUpdate", or
"EchoDomUpdate"directiveName
- the name of the directive, e.g., "event-add" or
"dom-remove".
public org.w3c.dom.Document getDocument()
public void setAttribute(java.lang.String attributeName, java.lang.String attributeValue)
attributeName
- the attribute nameattributeValue
- the attribute valuepublic void setResync()
public void setTransactionId(long transactionId)
transactionId
- the transaction identifier
|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |