unsw.cse.mica.util
Class XMLProtocolUtils

java.lang.Object
  extended by unsw.cse.mica.util.XMLProtocolUtils
All Implemented Interfaces:
XMLProtocolConstants

public class XMLProtocolUtils
extends java.lang.Object
implements XMLProtocolConstants

Utility functions for the XML protocol

Author:
jhw
See Also:
XMLAgentProtocol, XMLBlackboardProtocol

Field Summary
static java.lang.String BBPREFIX
           
 
Fields inherited from interface unsw.cse.mica.util.XMLProtocolConstants
AGENTMESSAGE_CLOSE, AGENTMESSAGE_OPEN, ATTRIBUTE_AGENTNAME, ATTRIBUTE_MOBNAME, ATTRIBUTE_MOBTYPE, ATTRIBUTE_NUMMOBS, ATTRIBUTE_PASSWORD, ATTRIBUTE_QUERY, ATTRIBUTE_RESULT, BBMESSAGE_CLOSE, BBMESSAGE_OPEN, ELEMENT_CONNECT, ELEMENT_CONNECTREPLY, ELEMENT_DELETEDMOB, ELEMENT_DELETEMOB, ELEMENT_DISCONNECT, ELEMENT_MOBSEARCH, ELEMENT_MOBSEARCHREPLY, ELEMENT_NEWMOB, ELEMENT_READMOB, ELEMENT_READMOBREPLY, ELEMENT_REGISTER, ELEMENT_REPLACEDMOB, ELEMENT_REPLACEMOB, ELEMENT_STATUS, ELEMENT_TYPEMANAGER, ELEMENT_TYPEMANAGERCHANGED, ELEMENT_TYPEMANAGERREPLY, ELEMENT_UNREGISTER, ELEMENT_WRITEMOB, ELEMENT_WRITEMOBREPLY
 
Constructor Summary
XMLProtocolUtils()
           
 
Method Summary
static java.lang.String closeAgentXML()
           
static java.lang.String closeBBXML()
           
static java.lang.String connectMsg(java.lang.String agentName)
           
static java.lang.String connectMsg(java.lang.String agentName, java.lang.String password)
           
static java.lang.String connectReplyMsg(java.lang.String agentName)
           
static java.lang.String deletedMobMsg(Mob mob)
           
static java.lang.String deleteMobMsg(java.lang.String mobName)
           
static java.lang.String deleteMobReplyMsg(java.lang.String status)
           
static java.lang.String disconnectMsg()
           
static java.lang.String disconnectReplyMsg(java.lang.String status)
           
static java.lang.String mobSearchMsg(java.lang.String query)
           
static java.lang.String mobSearchReplyMsg(java.util.List mobs)
           
static java.lang.String newMobMsg(Mob mob)
           
static java.lang.String openAgentXML()
           
static java.lang.String openBBXML()
           
static java.lang.String readMobMsg(java.lang.String mobName)
           
static java.lang.String readMobReplyMsg(Mob mob)
           
static java.lang.String registerMsg(java.lang.String mobType)
           
static java.lang.String registerReplyMsg(java.lang.String status)
           
static java.lang.String replacedMobMsg(Mob oldMob, Mob newMob)
           
static java.lang.String replaceMobMsg(Mob mob)
           
static java.lang.String replaceMobReplyMsg(java.lang.String status)
           
static java.lang.String statusReplyMsg(java.lang.String status)
           
static java.lang.String typeManagerChangedMsg()
           
static java.lang.String typeManagerMsg()
           
static java.lang.String typeManagerReplyMsg(TypeManager types)
           
static java.lang.String unregisterMsg(java.lang.String mobType)
           
static java.lang.String unregisterReplyMsg(java.lang.String status)
           
static java.lang.String writeMobMsg(Mob mob)
           
static java.lang.String writeMobReplyMsg(java.lang.String mobName)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BBPREFIX

public static final java.lang.String BBPREFIX
See Also:
Constant Field Values
Constructor Detail

XMLProtocolUtils

public XMLProtocolUtils()
Method Detail

openAgentXML

public static final java.lang.String openAgentXML()

closeAgentXML

public static final java.lang.String closeAgentXML()

openBBXML

public static final java.lang.String openBBXML()

closeBBXML

public static final java.lang.String closeBBXML()

statusReplyMsg

public static java.lang.String statusReplyMsg(java.lang.String status)

connectMsg

public static java.lang.String connectMsg(java.lang.String agentName)

connectMsg

public static java.lang.String connectMsg(java.lang.String agentName,
                                          java.lang.String password)

connectReplyMsg

public static java.lang.String connectReplyMsg(java.lang.String agentName)

disconnectMsg

public static java.lang.String disconnectMsg()

disconnectReplyMsg

public static java.lang.String disconnectReplyMsg(java.lang.String status)

typeManagerMsg

public static java.lang.String typeManagerMsg()

typeManagerReplyMsg

public static java.lang.String typeManagerReplyMsg(TypeManager types)

registerMsg

public static java.lang.String registerMsg(java.lang.String mobType)

registerReplyMsg

public static java.lang.String registerReplyMsg(java.lang.String status)

unregisterMsg

public static java.lang.String unregisterMsg(java.lang.String mobType)

unregisterReplyMsg

public static java.lang.String unregisterReplyMsg(java.lang.String status)

readMobMsg

public static java.lang.String readMobMsg(java.lang.String mobName)

readMobReplyMsg

public static java.lang.String readMobReplyMsg(Mob mob)

writeMobMsg

public static java.lang.String writeMobMsg(Mob mob)

writeMobReplyMsg

public static java.lang.String writeMobReplyMsg(java.lang.String mobName)

deleteMobMsg

public static java.lang.String deleteMobMsg(java.lang.String mobName)

deleteMobReplyMsg

public static java.lang.String deleteMobReplyMsg(java.lang.String status)

replaceMobMsg

public static java.lang.String replaceMobMsg(Mob mob)

replaceMobReplyMsg

public static java.lang.String replaceMobReplyMsg(java.lang.String status)

mobSearchMsg

public static java.lang.String mobSearchMsg(java.lang.String query)

mobSearchReplyMsg

public static java.lang.String mobSearchReplyMsg(java.util.List mobs)

newMobMsg

public static java.lang.String newMobMsg(Mob mob)

deletedMobMsg

public static java.lang.String deletedMobMsg(Mob mob)

replacedMobMsg

public static java.lang.String replacedMobMsg(Mob oldMob,
                                              Mob newMob)

typeManagerChangedMsg

public static java.lang.String typeManagerChangedMsg()