1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_TEST_WEBDRIVER_COMMANDS_RESPONSE_H_
#define CHROME_TEST_WEBDRIVER_COMMANDS_RESPONSE_H_
#include <sstream>
#include <string>
#include "base/values.h"
#include "chrome/test/webdriver/error_codes.h"
namespace webdriver {
// All errors in webdriver must use this macro in order to send back
// a proper stack trace to the client
#define SET_WEBDRIVER_ERROR(response, msg, err) \
response->SetError(err, msg, __FILE__, __LINE__); \
LOG(ERROR) << msg
// A simple class that encapsulates the information describing the response to
// a |Command|. In Webdriver all responses must be sent back as a JSON value,
// conforming to the spec found at:
// http://code.google.com/p/selenium/wiki/JsonWireProtocol#Messages
class Response {
public:
// Creates a new |Response| with a default status of |kSuccess| and a
// |NullValue|.
Response();
~Response();
ErrorCode GetStatus() const;
void SetStatus(ErrorCode status);
// Ownership of the returned pointer is kept by this object.
const Value* GetValue() const;
// Sets the |value| of this response, assuming ownership of the object in the
// process.
void SetValue(Value* value);
// Configures this response to report an error. The |file| and |line|
// parameters, which identify where in the source the error occurred, can be
// set using the |SET_WEBDRIVER_ERROR| macro above.
void SetError(ErrorCode error, const std::string& message,
const std::string& file, int line);
// Sets a JSON field in this response. The |key| may be a "." delimitted
// string to indicate the value should be set in a nested object. Any
// previously set value for the |key| will be deleted.
// This object assumes ownership of |value|.
void SetField(const std::string& key, Value* value);
// Returns this response as a JSON string.
std::string ToJSON() const;
private:
DictionaryValue data_;
DISALLOW_COPY_AND_ASSIGN(Response);
};
} // namespace webdriver
#endif // CHROME_TEST_WEBDRIVER_COMMANDS_RESPONSE_H_
|
