org.openqa.selenium.remote.http

Class AbstractHttpCommandCodec

java.lang.Object

org.openqa.selenium.remote.http.AbstractHttpCommandCodec

All Implemented Interfaces:

CommandCodec<HttpRequest>

Direct Known Subclasses:

JsonHttpCommandCodec, W3CHttpCommandCodec

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

A command codec that adheres to the W3C's WebDriver wire protocol.

See Also:

W3C WebDriver spec

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractHttpCommandCodec.CommandSpec

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.String>	aliases
private BeanToJsonConverter	beanToJsonConverter
private JsonToBeanConverter	jsonToBeanConverter
private java.util.concurrent.ConcurrentHashMap<java.lang.String,AbstractHttpCommandCodec.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
AbstractHttpCommandCodec()

Method Summary

Modifier and Type	Method and Description
void	alias(java.lang.String commandName, java.lang.String isAnAliasFor) Allow commands to have aliases.
protected abstract java.util.Map<java.lang.String,?>	amendParameters(java.lang.String name, java.util.Map<java.lang.String,?> parameters)
private java.lang.String	buildUri(java.lang.String commandName, SessionId sessionId, java.util.Map<java.lang.String,?> parameters, AbstractHttpCommandCodec.CommandSpec spec)
Command	decode(HttpRequest encodedCommand) Decodes a command.
protected void	defineCommand(java.lang.String name, AbstractHttpCommandCodec.CommandSpec spec)
void	defineCommand(java.lang.String name, HttpMethod method, java.lang.String pathPattern) Defines a new command mapping.
protected static AbstractHttpCommandCodec.CommandSpec	delete(java.lang.String path)
HttpRequest	encode(Command command) Encodes a command.
protected static AbstractHttpCommandCodec.CommandSpec	get(java.lang.String path)
private java.lang.String	getParameter(java.lang.String parameterName, java.lang.String commandName, SessionId sessionId, java.util.Map<java.lang.String,?> parameters)
protected static AbstractHttpCommandCodec.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 java.util.concurrent.ConcurrentHashMap<java.lang.String,AbstractHttpCommandCodec.CommandSpec> nameToSpec

aliases

private final java.util.Map<java.lang.String,java.lang.String> aliases

beanToJsonConverter

private final BeanToJsonConverter beanToJsonConverter

jsonToBeanConverter

private final JsonToBeanConverter jsonToBeanConverter

Constructor Detail

AbstractHttpCommandCodec

public AbstractHttpCommandCodec()

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.

amendParameters

protected abstract java.util.Map<java.lang.String,?> amendParameters(java.lang.String name,
                                                                     java.util.Map<java.lang.String,?> parameters)

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.

Specified by:

defineCommand in interface CommandCodec<HttpRequest>

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.

alias

public void alias(java.lang.String commandName,
                  java.lang.String isAnAliasFor)

Description copied from interface: CommandCodec

Allow commands to have aliases.

Specified by:

alias in interface CommandCodec<HttpRequest>

Parameters:

commandName - The command being added.

isAnAliasFor - The command name that this is an alias for.

defineCommand

protected void defineCommand(java.lang.String name,
                             AbstractHttpCommandCodec.CommandSpec spec)

delete

protected static AbstractHttpCommandCodec.CommandSpec delete(java.lang.String path)

get

protected static AbstractHttpCommandCodec.CommandSpec get(java.lang.String path)

post

protected static AbstractHttpCommandCodec.CommandSpec post(java.lang.String path)

buildUri

private java.lang.String buildUri(java.lang.String commandName,
                                  SessionId sessionId,
                                  java.util.Map<java.lang.String,?> parameters,
                                  AbstractHttpCommandCodec.CommandSpec spec)

getParameter

private java.lang.String getParameter(java.lang.String parameterName,
                                      java.lang.String commandName,
                                      SessionId sessionId,
                                      java.util.Map<java.lang.String,?> parameters)