com.transjam.util
Class ProtocolWriter

java.lang.Object
  |
  +--com.transjam.util.ProtocolWriter

public class ProtocolWriter

extends java.lang.Object

Title: Generate XML protocol for Transjam ClientServer communication. Description: Multi-Player collaboration server.

Version:

1.0

Author:

Phil Burk, (C) 2000 SoftSynth.com

Constructor Summary

ProtocolWriter()

Method Summary

java.lang.String	addMeeting(java.util.Date when, int numClients)
java.lang.String	addRoom(java.lang.String name, int maxClients, int numClients)
java.lang.String	addThing(java.lang.String name)
java.lang.String	addUser(java.lang.String name, int userID)
void	beginMessage(java.lang.String command) Create a StringBuffer to hold the message.
java.lang.String	deleteRoom(java.lang.String name)
java.lang.String	deleteThing(java.lang.String name)
java.lang.String	deleteUser(java.lang.String name, int userID)
java.lang.String	denyLock(java.lang.String name)
java.lang.String	denyLogin(java.lang.String reason)
java.lang.String	denyRoom(java.lang.String name)
java.lang.String	denyThing(java.lang.String name)
java.lang.String	endList()
java.lang.String	enterRoom(int level, java.lang.String name)
java.lang.String	exitRoom(int level, java.lang.String name)
java.lang.String	finishMessage() Finish the command and return it as a string.
java.lang.String	finishMessage(java.lang.String command) Finish the command and return it as a string.
java.lang.String	finishMessage(java.lang.String command, java.lang.String content)
java.lang.String	grantLock(java.lang.String name)
java.lang.String	grantLock(java.lang.String name, int uid)
java.lang.String	grantLogin(int userID)
java.lang.String	joinMeeting(java.util.Date when)
java.lang.String	joinNewRoom(java.lang.String name)
java.lang.String	joinNewRoom(java.lang.String name, int currentLevel, int maxClients, int flags)
java.lang.String	joinOldRoom(java.lang.String name)
java.lang.String	joinOldRoom(java.lang.String name, int currentLevel)
java.lang.String	joinRoom(java.lang.String name)
java.lang.String	joinRoom(java.lang.String name, int currentLevel, int maxClients, int flags)
java.lang.String	leaveRoom(int currentLevel)
java.lang.String	lockNewThing(java.lang.String name, java.lang.String contents)
java.lang.String	lockOldThing(java.lang.String name)
java.lang.String	lockThing(java.lang.String name)
java.lang.String	lockThing(java.lang.String name, int uid)
java.lang.String	makeMessage(java.lang.String command)
java.lang.String	makeMessage(java.lang.String command, java.lang.String content)
java.lang.String	makeMessage(java.lang.String command, java.lang.String name, int value)
java.lang.String	makeMessage(java.lang.String command, java.lang.String name, int value, java.lang.String content)
java.lang.String	makeMessage(java.lang.String command, java.lang.String name, java.lang.String value)
java.lang.String	makeMessage(java.lang.String command, java.lang.String name, java.lang.String value, java.lang.String content)
java.lang.String	modifyThing(java.lang.String name, java.lang.String contents)
java.lang.String	noThing(java.lang.String name)
java.lang.String	requestEcho(java.lang.String content)
java.lang.String	requestLogin(java.lang.String userName)
java.lang.String	requestLogout()
java.lang.String	requestMeetingList()
java.lang.String	requestRoomList()
java.lang.String	requestThingList()
java.lang.String	requestTime()
java.lang.String	requestUserList()
java.lang.String	requestUserLocations()
java.lang.String	requestValidation()
java.lang.String	sendAll(int userID, java.lang.String msg)
java.lang.String	sendAll(java.lang.String msg)
java.lang.String	sendChat(int userID, int flags, java.lang.String msg)
java.lang.String	sendChat(java.lang.String msg, int flags)
java.lang.String	sendEcho(java.lang.String content) Send a complete TransjamMessage in XML format.
java.lang.String	sendInfo(int version, java.lang.String info)
java.lang.String	sendLocation(int uid, ClientLocation location)
java.lang.String	sendOthers(int userID, java.lang.String msg)
java.lang.String	sendSelf(java.lang.String msg)
java.lang.String	sendSync(java.lang.String content)
java.lang.String	sendTime(long currentMillis)
java.lang.String	sendUser(int userID, java.lang.String msg)
java.lang.String	unlockThing(java.lang.String name)
java.lang.String	updateRoom(java.lang.String name, int maxClients, int numClients)
void	writeAttribute(java.lang.String name, double value)
void	writeAttribute(java.lang.String name, int value)
void	writeAttribute(java.lang.String name, java.lang.String value) Append the name and value to the message buffer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtocolWriter

public ProtocolWriter()

Method Detail

beginMessage

public void beginMessage(java.lang.String command)

Create a StringBuffer to hold the message. Start by writing command to buffer.

writeAttribute

public void writeAttribute(java.lang.String name,
                           java.lang.String value)

Append the name and value to the message buffer.

writeAttribute

public void writeAttribute(java.lang.String name,
                           int value)

writeAttribute

public void writeAttribute(java.lang.String name,
                           double value)

finishMessage

public java.lang.String finishMessage()

Finish the command and return it as a string.

finishMessage

public java.lang.String finishMessage(java.lang.String command)

Finish the command and return it as a string.

finishMessage

public java.lang.String finishMessage(java.lang.String command,
                                      java.lang.String content)

makeMessage

public java.lang.String makeMessage(java.lang.String command)

makeMessage

public java.lang.String makeMessage(java.lang.String command,
                                    java.lang.String content)

makeMessage

public java.lang.String makeMessage(java.lang.String command,
                                    java.lang.String name,
                                    java.lang.String value)

makeMessage

public java.lang.String makeMessage(java.lang.String command,
                                    java.lang.String name,
                                    int value)

makeMessage

public java.lang.String makeMessage(java.lang.String command,
                                    java.lang.String name,
                                    java.lang.String value,
                                    java.lang.String content)

makeMessage

public java.lang.String makeMessage(java.lang.String command,
                                    java.lang.String name,
                                    int value,
                                    java.lang.String content)

sendEcho

public java.lang.String sendEcho(java.lang.String content)

Send a complete TransjamMessage in XML format. public void sendMessage( TransjamMessage message ) { beginMessage( message.command ); if( message.attributes != null) { Enumeration e = message.attributes.keys(); while( e.hasMoreElements() ) { Object name = e.nextElement(); String value = (String) message.attributes.get( name ); } } }

requestTime

public java.lang.String requestTime()

sendTime

public java.lang.String sendTime(long currentMillis)

requestEcho

public java.lang.String requestEcho(java.lang.String content)

sendSync

public java.lang.String sendSync(java.lang.String content)

deleteThing

public java.lang.String deleteThing(java.lang.String name)

denyThing

public java.lang.String denyThing(java.lang.String name)

modifyThing

public java.lang.String modifyThing(java.lang.String name,
                                    java.lang.String contents)

denyRoom

public java.lang.String denyRoom(java.lang.String name)

addRoom

public java.lang.String addRoom(java.lang.String name,
                                int maxClients,
                                int numClients)

updateRoom

public java.lang.String updateRoom(java.lang.String name,
                                   int maxClients,
                                   int numClients)

deleteRoom

public java.lang.String deleteRoom(java.lang.String name)

endList

public java.lang.String endList()

addUser

public java.lang.String addUser(java.lang.String name,
                                int userID)

deleteUser

public java.lang.String deleteUser(java.lang.String name,
                                   int userID)

grantLogin

public java.lang.String grantLogin(int userID)

denyLogin

public java.lang.String denyLogin(java.lang.String reason)

sendChat

public java.lang.String sendChat(int userID,
                                 int flags,
                                 java.lang.String msg)

sendAll

public java.lang.String sendAll(int userID,
                                java.lang.String msg)

sendOthers

public java.lang.String sendOthers(int userID,
                                   java.lang.String msg)

sendUser

public java.lang.String sendUser(int userID,
                                 java.lang.String msg)

requestMeetingList

public java.lang.String requestMeetingList()

joinMeeting

public java.lang.String joinMeeting(java.util.Date when)

addMeeting

public java.lang.String addMeeting(java.util.Date when,
                                   int numClients)

lockNewThing

public java.lang.String lockNewThing(java.lang.String name,
                                     java.lang.String contents)

lockThing

public java.lang.String lockThing(java.lang.String name)

lockThing

public java.lang.String lockThing(java.lang.String name,
                                  int uid)

lockOldThing

public java.lang.String lockOldThing(java.lang.String name)

unlockThing

public java.lang.String unlockThing(java.lang.String name)

addThing

public java.lang.String addThing(java.lang.String name)

noThing

public java.lang.String noThing(java.lang.String name)

grantLock

public java.lang.String grantLock(java.lang.String name,
                                  int uid)

grantLock

public java.lang.String grantLock(java.lang.String name)

denyLock

public java.lang.String denyLock(java.lang.String name)

requestLogin

public java.lang.String requestLogin(java.lang.String userName)

requestLogout

public java.lang.String requestLogout()

requestRoomList

public java.lang.String requestRoomList()

requestUserList

public java.lang.String requestUserList()

requestUserLocations

public java.lang.String requestUserLocations()

requestThingList

public java.lang.String requestThingList()

joinNewRoom

public java.lang.String joinNewRoom(java.lang.String name,
                                    int currentLevel,
                                    int maxClients,
                                    int flags)

joinNewRoom

public java.lang.String joinNewRoom(java.lang.String name)

joinRoom

public java.lang.String joinRoom(java.lang.String name,
                                 int currentLevel,
                                 int maxClients,
                                 int flags)

joinRoom

public java.lang.String joinRoom(java.lang.String name)

joinOldRoom

public java.lang.String joinOldRoom(java.lang.String name,
                                    int currentLevel)

joinOldRoom

public java.lang.String joinOldRoom(java.lang.String name)

leaveRoom

public java.lang.String leaveRoom(int currentLevel)

enterRoom

public java.lang.String enterRoom(int level,
                                  java.lang.String name)

exitRoom

public java.lang.String exitRoom(int level,
                                 java.lang.String name)

sendAll

public java.lang.String sendAll(java.lang.String msg)

sendSelf

public java.lang.String sendSelf(java.lang.String msg)

sendChat

public java.lang.String sendChat(java.lang.String msg,
                                 int flags)

requestValidation

public java.lang.String requestValidation()
                                   throws java.io.IOException

sendInfo

public java.lang.String sendInfo(int version,
                                 java.lang.String info)
                          throws java.io.IOException

sendLocation

public java.lang.String sendLocation(int uid,
                                     ClientLocation location)

Parameters:

location -

Returns: