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 Object
implements CommandCodec<HttpRequest>

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

See Also:

JSON wire protocol

Constructor Summary

Constructors

Constructor and Description
JsonHttpCommandCodec()

Method Summary

Methods

Modifier and Type	Method and Description
Command	decode(HttpRequest encodedCommand) Decodes a command.
void	defineCommand(String name, HttpMethod method, String pathPattern) Defines a new command mapping.
HttpRequest	encode(Command command) Encodes a command.

Methods inherited from class java.lang.Object

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

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(String name,
                 HttpMethod method,
                 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.