org.openqa.selenium.server

Class CommandQueue

java.lang.Object

org.openqa.selenium.server.CommandQueue

public class CommandQueue
extends Object

Schedules and coordinates commands to be run.

Version:

$Revision: 734 $

Author:

Paul Hammant, Jennifer Bevan

Constructor Summary

Constructors

Constructor and Description
CommandQueue(String newSessionId, String newUniqueId, int opDelay, RemoteControlConfiguration configuration)
CommandQueue(String newSessionId, String newUniqueId, RemoteControlConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
void	addJsWindowNameVar(String jsWindowNameVar)
void	declareClosed()
String	doCommand(String command, String field, String value) Sends the specified command (to be retrieved by the next call to handle command result), and returns the result of that command.
protected void	doCommandWithoutWaitingForAResponse(String command, String field, String value)
void	endOfLife() clear the contents of the threads, and unblocks polling threads
BrowserResponseSequencer	getBrowserResponseSequencer()
FrameAddress	getFrameAddress()
protected static String	getIdentification(String caller, String queueId)
protected RemoteCommand	getNextCommand() Get, and remove from the command holder, the next command to run
int	getQueueDelay()
protected String	getResult()
static int	getSpeed()
RemoteCommand	handleCommandResult(String commandResult) Accepts a command reply, and retrieves the next command to run.
protected void	handleCommandResultWithoutWaitingForACommand(String commandResult)
boolean	isClosed()
boolean	isResultExpected() Get whether this command queue expects a result instead of just "OK".
boolean	isWindowPointedToByJsVariable(String jsVariableName)
protected RemoteCommand	peekAtCommand()
protected String	peekAtResult()
protected boolean	putCommand(RemoteCommand cmd)
protected boolean	putResult(String result)
void	setFrameAddress(FrameAddress frameAddress)
void	setQueueDelay(int i)
protected void	setResultExpected(boolean resultExpected)
static void	setSpeed(int i)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandQueue

public CommandQueue(String newSessionId,
                    String newUniqueId,
                    RemoteControlConfiguration configuration)

CommandQueue

public CommandQueue(String newSessionId,
                    String newUniqueId,
                    int opDelay,
                    RemoteControlConfiguration configuration)

Method Detail

doCommand

public String doCommand(String command,
                        String field,
                        String value)

Sends the specified command (to be retrieved by the next call to handle command result), and returns the result of that command.

Parameters:

command - - the remote command verb

field - - the first remote argument (meaning depends on the verb)

value - - the second remote argument

Returns:

- the command result, defined by the remote JavaScript. "getX" style commands may return data from the browser; other "doX" style commands may just return "OK" or an error message.

doCommandWithoutWaitingForAResponse

protected void doCommandWithoutWaitingForAResponse(String command,
                                                   String field,
                                                   String value)
                                            throws WindowClosedException

Throws:

WindowClosedException

getResult

protected String getResult()

toString

public String toString()

Overrides:

toString in class Object

handleCommandResult

public RemoteCommand handleCommandResult(String commandResult)

Accepts a command reply, and retrieves the next command to run.

Parameters:

commandResult - - the reply from the previous command, or null

Returns:

- the next command to run

handleCommandResultWithoutWaitingForACommand

protected void handleCommandResultWithoutWaitingForACommand(String commandResult)

getNextCommand

protected RemoteCommand getNextCommand()

Get, and remove from the command holder, the next command to run

Returns:

next command to run

getIdentification

protected static String getIdentification(String caller,
                                          String queueId)

endOfLife

public void endOfLife()

clear the contents of the threads, and unblocks polling threads

getFrameAddress

public FrameAddress getFrameAddress()

setFrameAddress

public void setFrameAddress(FrameAddress frameAddress)

isResultExpected

public boolean isResultExpected()

Get whether this command queue expects a result instead of just "OK".

Returns:

Returns whether this command will expect a command result.

setQueueDelay

public void setQueueDelay(int i)

getQueueDelay

public int getQueueDelay()

setSpeed

public static void setSpeed(int i)

getSpeed

public static int getSpeed()

isWindowPointedToByJsVariable

public boolean isWindowPointedToByJsVariable(String jsVariableName)

addJsWindowNameVar

public void addJsWindowNameVar(String jsWindowNameVar)

declareClosed

public void declareClosed()

isClosed

public boolean isClosed()

getBrowserResponseSequencer

public BrowserResponseSequencer getBrowserResponseSequencer()

setResultExpected

protected void setResultExpected(boolean resultExpected)

peekAtResult

protected String peekAtResult()

peekAtCommand

protected RemoteCommand peekAtCommand()

putResult

protected boolean putResult(String result)

putCommand

protected boolean putCommand(RemoteCommand cmd)