-
Notifications
You must be signed in to change notification settings - Fork 8
/
AbstractHTTP.ts
250 lines (218 loc) · 7.5 KB
/
AbstractHTTP.ts
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
// tslint:disable-next-line
/// <reference path="../../typings/index.d.ts" />
import {IOnmsHTTP} from '../api/IOnmsHTTP';
import {IFilterProcessor} from '../api/IFilterProcessor';
import {OnmsError} from '../api/OnmsError';
import {OnmsHTTPOptions} from '../api/OnmsHTTPOptions';
import {OnmsResult} from '../api/OnmsResult';
import {OnmsServer} from '../api/OnmsServer';
import {XmlTransformer} from './XmlTransformer';
import {JsonTransformer} from './JsonTransformer';
/** @hidden */
const xmlTransformer = new XmlTransformer();
/** @hidden */
const jsonTransformer = new JsonTransformer();
const OPTIONS_PROP = Symbol.for('options');
/**
* Abstract implementation of the OnmsHTTP interface meant to be extended by a concrete class.
* @module AbstractHTTP
* @implements IOnmsHTTP
*/
export abstract class AbstractHTTP implements IOnmsHTTP {
private OPTIONS_PROP = new OnmsHTTPOptions();
/** The default set of HTTP options associated with this ReST client. */
public get options(): OnmsHTTPOptions {
if (this[OPTIONS_PROP]) {
return this[OPTIONS_PROP];
}
return {} as OnmsHTTPOptions;
}
public set options(o: OnmsHTTPOptions) {
this[OPTIONS_PROP] = o;
}
/**
* The default amount of time to wait before giving up on a request.
* @deprecated Set `timeout` on the [[OnmsHTTPOptions]] object instead. This will go away in OpenNMS.js 2.0.
*/
public get timeout(): number {
return this.options.timeout;
}
public set timeout(t: number) {
/* tslint:disable:no-console */
console.warn('The "timeout" property on OnmsHTTP implementations is deprecated ' +
'and will be removed in OpenNMS.js 2. Use "options.timeout" instead.');
this.options.timeout = t;
}
/**
* The server metadata we'll use for constructing ReST calls.
* @hidden
*/
private serverObj: OnmsServer;
/** The server associated with this HTTP implementation. */
public get server() {
return this.serverObj;
}
public set server(server: OnmsServer) {
this.serverObj = server;
this.onSetServer();
}
/**
* Create a new HTTP instance.
* @constructor
* @param server - A server object for immediate configuration.
* @param timeout - How long to wait until timing out requests.
*/
constructor(server?: OnmsServer, timeout?: number) {
if (server) {
this.serverObj = server;
}
if (timeout) {
this.options.timeout = timeout;
}
}
/** Make an HTTP GET call. This must be implemented by the concrete implementation. */
public abstract get(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>;
/** Make an HTTP PUT call. This must be overridden by the concrete implementation. */
public abstract put(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>;
/** Make an HTTP POST call. This must be overridden by the concrete implementation. */
public abstract post(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>;
/** Make an HTTP DELETE call. This must be overridden by the concrete implementation. */
public abstract httpDelete(url: string, options?: OnmsHTTPOptions): Promise<OnmsResult<any>>;
/**
* A convenience method for implementers to use to turn JSON into a javascript object.
* Use this to process a JSON response before returning it in an [[OnmsResult]] object.
*/
protected transformJSON(data: any) {
return jsonTransformer.transform(data);
}
/**
* A convenience method for implementers to use to turn XML into a javascript object.
* Use this to process an XML response before returning it in an [[OnmsResult]] object.
*/
protected transformXML(data: any) {
return xmlTransformer.transform(data);
}
/** Attempt to extract the data from a response. */
protected getData(response: any) {
const type = this.getType(response);
if (type === 'json') {
return this.transformJSON(response.data);
} else if (type === 'xml') {
return this.transformXML(response.data);
} else {
return response.data;
}
}
/**
* Attempt to determine the type of response.
* @hidden
*/
protected getType(response: any) {
if (response.headers['content-type'] === 'application/json') {
return 'json';
} else if (response.config.responseType === 'json') {
return 'json';
} else if (response.config.headers.accept === 'application/json') {
return 'json';
} else if (response.responseType === 'json') {
return 'json';
} else if (response.config.headers.accept === 'application/xml') {
return 'xml';
} else if (response.headers['content-type'] === 'application/xml') {
return 'xml';
}
return 'text';
}
/**
* Get the [[OnmsServer]] object that should be used for making requests. Favors the one
* passed in the [[OnmsHTTPOptions]], otherwise it falls back to the default server associated
* with the HTTP implementation.
*/
protected getServer(options?: OnmsHTTPOptions) {
if (options && options.server) {
return options.server;
}
return this.serverObj;
}
/**
* Get the union of [[OnmsHTTPOptions]] based on the passed options, defaults,
* and options in the [[OnmsServer]] associated with this request. Order of
* precedence is passed options -> server options -> default options.
*/
protected getOptions(options?: OnmsHTTPOptions): OnmsHTTPOptions {
const ret = new OnmsHTTPOptions();
Object.assign(ret, this.options);
const server = this.getServer(options);
ret.server = server;
if (server && server.auth) {
ret.auth = Object.assign(ret.auth, server.auth);
}
Object.assign(ret, options);
if (!ret.headers.hasOwnProperty('X-Requested-With')) {
ret.headers['X-Requested-With'] = 'XMLHttpRequest';
}
return ret;
}
/**
* Implementers should override this method if they have actions that need to be performed
* (like clearing a cache) when server settings change.
*/
protected onSetServer() {
// do nothing by default
}
/**
* Create an [[OnmsError]] from an error response.
* @hidden
*/
protected handleError(err: any, options?: any): OnmsError {
const message = AbstractHTTP.extractMessage(err);
const status = AbstractHTTP.extractStatus(err);
const data = AbstractHTTP.extractData(err);
return new OnmsError(message, status, options, data);
}
/* tslint:disable:member-ordering */
/**
* Attempt to determine an error message from an error response.
* @hidden
*/
protected static extractMessage(err: any): string {
if (err) {
if (err.message) {
return err.message;
} else if (err.response) {
return this.extractMessage(err.response);
} else if (err.data && Object.prototype.toString.call(err) === '[object String]') {
return err.data;
} else if (err.statusText) {
return err.statusText;
}
return JSON.stringify(err);
}
return 'no error message';
}
/**
* Attempt to determine an error status code from an error response.
* @hidden
*/
protected static extractStatus(err: any): number {
let status = -1;
if (err.code) {
status = err.code;
} else if (err.status) {
status = err.status;
} else if (err.response && err.response.status) {
status = err.response.status;
}
return status;
}
/**
* Attempt to determine the data in an error response.
* @hidden
*/
protected static extractData(err: any): any {
if (err && err.response && err.response.data) {
return err.response.data;
}
return undefined;
}
}