org.openqa.selenium.remote.http

Class JsonHttpCommandCodec

java.lang.Object

org.openqa.selenium.remote.http.JsonHttpCommandCodec

All Implemented Interfaces:

CommandCodec<HttpRequest>

public class JsonHttpCommandCodec
extends java.lang.Object
implements CommandCodec<HttpRequest>

A command codec that adheres to the Selenium project's JSON/HTTP wire protocol.

See Also:

JSON wire protocol

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	JsonHttpCommandCodec.CommandSpec

Field Summary

Fields

Modifier and Type	Field and Description
private BeanToJsonConverter	beanToJsonConverter
private JsonToBeanConverter	jsonToBeanConverter
private com.google.common.collect.BiMap<java.lang.String,JsonHttpCommandCodec.CommandSpec>	nameToSpec
private static com.google.common.base.Splitter	PATH_SPLITTER
private static java.lang.String	SESSION_ID_PARAM

Constructor Summary

Constructors

Constructor and Description
JsonHttpCommandCodec()

Method Summary

Modifier and Type	Method and Description
private java.lang.String	buildUri(Command command, JsonHttpCommandCodec.CommandSpec spec)
Command	decode(HttpRequest encodedCommand) Decodes a command.
void	defineCommand(java.lang.String name, HttpMethod method, java.lang.String pathPattern) Defines a new command mapping.
private void	defineCommand(java.lang.String name, JsonHttpCommandCodec.CommandSpec spec)
private static JsonHttpCommandCodec.CommandSpec	delete(java.lang.String path)
HttpRequest	encode(Command command) Encodes a command.
private static JsonHttpCommandCodec.CommandSpec	get(java.lang.String path)
private java.lang.String	getParameter(java.lang.String parameterName, Command command)
private static JsonHttpCommandCodec.CommandSpec	post(java.lang.String path)

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SPLITTER

private static final com.google.common.base.Splitter PATH_SPLITTER

SESSION_ID_PARAM

private static final java.lang.String SESSION_ID_PARAM

See Also:

Constant Field Values

nameToSpec

private final com.google.common.collect.BiMap<java.lang.String,JsonHttpCommandCodec.CommandSpec> nameToSpec

beanToJsonConverter

private final BeanToJsonConverter beanToJsonConverter

jsonToBeanConverter

private final JsonToBeanConverter jsonToBeanConverter

Constructor Detail

JsonHttpCommandCodec

public JsonHttpCommandCodec()

Method Detail

encode

public HttpRequest encode(Command command)

Description copied from interface: CommandCodec

Encodes a command.

Specified by:

encode in interface CommandCodec<HttpRequest>

Parameters:

command - the command to encode.

Returns:

the encoded command.

decode

public Command decode(HttpRequest encodedCommand)

Description copied from interface: CommandCodec

Decodes a command.

Specified by:

decode in interface CommandCodec<HttpRequest>

Parameters:

encodedCommand - the command to decode.

Returns:

the decoded command.

defineCommand

public void defineCommand(java.lang.String name,
                          HttpMethod method,
                          java.lang.String pathPattern)

Defines a new command mapping.

Parameters:

name - The command name.

method - The HTTP method to use for the command.

pathPattern - The URI path pattern for the command. When encoding a command, each path segment prefixed with a ":" will be replaced with the corresponding parameter from the encoded command.

defineCommand

private void defineCommand(java.lang.String name,
                           JsonHttpCommandCodec.CommandSpec spec)

delete

private static JsonHttpCommandCodec.CommandSpec delete(java.lang.String path)

get

private static JsonHttpCommandCodec.CommandSpec get(java.lang.String path)

post

private static JsonHttpCommandCodec.CommandSpec post(java.lang.String path)

buildUri

private java.lang.String buildUri(Command command,
                                  JsonHttpCommandCodec.CommandSpec spec)

getParameter

private java.lang.String getParameter(java.lang.String parameterName,
                                      Command command)