Package org.openqa.selenium.remote

Class HttpCommandExecutor

java.lang.Object

org.openqa.selenium.remote.HttpCommandExecutor

All Implemented Interfaces:

org.openqa.selenium.logging.NeedsLocalLogs, CommandExecutor

Direct Known Subclasses:

DriverCommandExecutor

public class HttpCommandExecutor
extends Object
implements CommandExecutor, org.openqa.selenium.logging.NeedsLocalLogs

Field Summary

Fields

Modifier and Type	Field	Description
final org.openqa.selenium.remote.http.HttpClient	client
protected CommandCodec<org.openqa.selenium.remote.http.HttpRequest>	commandCodec
protected ResponseCodec<org.openqa.selenium.remote.http.HttpResponse>	responseCodec

Constructor Summary

Constructors

Constructor	Description
HttpCommandExecutor(URL addressOfRemoteServer)
HttpCommandExecutor(Map<String,CommandInfo> additionalCommands, URL addressOfRemoteServer)	Creates an HttpCommandExecutor that supports non-standard additionalCommands in addition to the standard.
HttpCommandExecutor(Map<String,CommandInfo> additionalCommands, URL addressOfRemoteServer, org.openqa.selenium.remote.http.ClientConfig config)
HttpCommandExecutor(Map<String,CommandInfo> additionalCommands, URL addressOfRemoteServer, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory)
HttpCommandExecutor(Map<String,CommandInfo> additionalCommands, org.openqa.selenium.remote.http.ClientConfig config, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory)
HttpCommandExecutor(org.openqa.selenium.remote.http.ClientConfig config)

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalCommand(String commandName, CommandInfo info)	Adds or updates additional commands.
protected void	defineCommand(String commandName, CommandInfo info)	It may be useful to extend the commands understood by this HttpCommandExecutor at run time, and this can be achieved via this method.
Response	execute(Command command)
Map<String,CommandInfo>	getAdditionalCommands()	Returns an immutable view of the additional commands.
URL	getAddressOfRemoteServer()
static org.openqa.selenium.remote.http.HttpClient.Factory	getDefaultClientFactory()
void	setLocalLogs(org.openqa.selenium.logging.LocalLogs logs)

Methods inherited from class java.lang.Object

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

Field Details

client

public final org.openqa.selenium.remote.http.HttpClient client

commandCodec

protected CommandCodec<org.openqa.selenium.remote.http.HttpRequest> commandCodec

responseCodec

protected ResponseCodec<org.openqa.selenium.remote.http.HttpResponse> responseCodec

Constructor Details

HttpCommandExecutor

public HttpCommandExecutor(URL addressOfRemoteServer)

HttpCommandExecutor

public HttpCommandExecutor(org.openqa.selenium.remote.http.ClientConfig config)

HttpCommandExecutor

public HttpCommandExecutor(Map<String,CommandInfo> additionalCommands,
 URL addressOfRemoteServer)

Creates an HttpCommandExecutor that supports non-standard additionalCommands in addition to the standard.

Parameters:

additionalCommands - additional commands to allow the command executor to process

addressOfRemoteServer - URL of remote end Selenium server

HttpCommandExecutor

public HttpCommandExecutor(Map<String,CommandInfo> additionalCommands,
 URL addressOfRemoteServer,
 org.openqa.selenium.remote.http.ClientConfig config)

HttpCommandExecutor

public HttpCommandExecutor(Map<String,CommandInfo> additionalCommands,
 URL addressOfRemoteServer,
 org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory)

HttpCommandExecutor

public HttpCommandExecutor(Map<String,CommandInfo> additionalCommands,
 org.openqa.selenium.remote.http.ClientConfig config,
 org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory)

Method Details

getDefaultClientFactory

public static org.openqa.selenium.remote.http.HttpClient.Factory getDefaultClientFactory()

getAdditionalCommands

public Map<String,CommandInfo> getAdditionalCommands()

Returns an immutable view of the additional commands.

Returns:

an unmodifiable map of additional commands.

addAdditionalCommand

protected void addAdditionalCommand(String commandName,
 CommandInfo info)

Adds or updates additional commands. This method is protected to allow subclasses to define their commands.

Parameters:

commandName - the name of the command to add or update.

info - the CommandInfo for the command.

defineCommand

protected void defineCommand(String commandName,
 CommandInfo info)

It may be useful to extend the commands understood by this HttpCommandExecutor at run time, and this can be achieved via this method. Note, this is protected, and expected usage is for subclasses only to call this.

Parameters:

commandName - The name of the command to use.

info - CommandInfo for the command name provided

setLocalLogs

public void setLocalLogs(org.openqa.selenium.logging.LocalLogs logs)

Specified by:

setLocalLogs in interface org.openqa.selenium.logging.NeedsLocalLogs

getAddressOfRemoteServer

public URL getAddressOfRemoteServer()

execute

public Response execute(Command command)
                 throws IOException

Specified by:

execute in interface CommandExecutor

Throws:

IOException