-
Notifications
You must be signed in to change notification settings - Fork 8
/
Client.ts
168 lines (144 loc) · 5.29 KB
/
Client.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
import * as axios from 'axios';
import {log, catRoot} from './api/Log';
import {Category} from 'typescript-logging';
import {IHasHTTP} from './api/IHasHTTP';
import {IOnmsHTTP} from './api/IOnmsHTTP';
import {OnmsAuthConfig} from './api/OnmsAuthConfig';
import {OnmsHTTPOptions} from './api/OnmsHTTPOptions';
import {OnmsError} from './api/OnmsError';
import {OnmsResult} from './api/OnmsResult';
import {OnmsVersion} from './api/OnmsVersion';
import {ServerType, ServerTypes} from './api/ServerType';
import {TicketerConfig} from './api/TicketerConfig';
import {OnmsServer} from './api/OnmsServer';
import {ServerMetadata} from './api/ServerMetadata';
import {AlarmDAO} from './dao/AlarmDAO';
import {EventDAO} from './dao/EventDAO';
import {FlowDAO} from './dao/FlowDAO';
import {NodeDAO} from './dao/NodeDAO';
import {AxiosHTTP} from './rest/AxiosHTTP';
/** @hidden */
export const cat = new Category('client', catRoot);
/**
* The OpenNMS client. This is the primary interface to OpenNMS servers.
* @module Client
*/
export class Client implements IHasHTTP {
/**
* Given an OnmsServer object, check that it can be connected to.
*
* @param server - the server to check
* @param httpImpl - the [[IOnmsHTTP]] implementation to use
* @param timeout - how long to wait before giving up when making ReST calls
*/
public static async checkServer(server: OnmsServer, httpImpl?: IOnmsHTTP, timeout?: number): Promise<boolean> {
const opts = new OnmsHTTPOptions(timeout, server.auth, server);
if (!httpImpl) {
if (!Client.defaultHttp) {
throw new OnmsError('No HTTP implementation is configured!');
}
httpImpl = Client.defaultHttp;
}
opts.headers.accept = 'text/plain';
const infoUrl = server.resolveURL('rest/alarms/count');
log.debug('checkServer: checking URL: ' + infoUrl, cat);
await httpImpl.get(infoUrl, opts);
return true;
}
/**
* Given an OnmsServer object, query what capabilities it has, and return the capabilities
* associated with that server.
*
* @param server - the server to check
* @param httpImpl - the [[IOnmsHTTP]] implementation to use
* @param timeout - how long to wait before giving up when making ReST calls
*/
public static async getMetadata(server: OnmsServer, httpImpl?: IOnmsHTTP, timeout?: number):
Promise<ServerMetadata> {
const opts = new OnmsHTTPOptions(timeout, server.auth, server);
opts.headers.accept = 'application/json';
if (!httpImpl) {
if (!Client.defaultHttp) {
throw new OnmsError('No default HTTP implementation is configured!');
}
httpImpl = Client.defaultHttp;
}
if (!timeout && httpImpl.options.timeout) {
opts.timeout = httpImpl.options.timeout;
}
const infoUrl = server.resolveURL('rest/info');
log.debug('getMetadata: checking URL: ' + infoUrl, cat);
const response = await httpImpl.get(infoUrl, opts);
const version = new OnmsVersion(response.data.version, response.data.displayVersion);
const metadata = new ServerMetadata(version);
if (response.data.packageName) {
if (response.data.packageName.toLowerCase() === 'meridian') {
metadata.type = ServerTypes.MERIDIAN;
}
}
if (metadata.ticketer()) {
metadata.ticketerConfig = new TicketerConfig();
metadata.ticketerConfig.enabled = false;
if (response.data.ticketerConfig) {
metadata.ticketerConfig.plugin = response.data.ticketerConfig.plugin;
metadata.ticketerConfig.enabled = response.data.ticketerConfig.enabled === true;
}
}
return metadata;
}
/** The default OnmsHTTP implementation to be used when making requests */
private static defaultHttp: IOnmsHTTP;
/** the OnmsHTTP implementation that will be used when making requests */
public http: IOnmsHTTP;
/** The remote server to connect to */
public server: OnmsServer;
/**
* Construct a new OpenNMS client.
* @constructor
* @param httpImpl - The OnmsHTTP implementation to use. Normally
* this will automatically choose the best implementation
* based on the environment.
*/
constructor(httpImpl?: IOnmsHTTP) {
if (httpImpl) {
Client.defaultHttp = httpImpl;
} else {
Client.defaultHttp = new AxiosHTTP();
}
this.http = Client.defaultHttp;
}
/**
* Connect to an OpenNMS server, check what capabilities it has, and return an [[OnmsServer]]
* for that connection.
*/
public async connect(name: string, url: string, username: string, password: string, timeout?: number) {
const self = this;
const server = new OnmsServer(name, url, username, password);
await Client.checkServer(server, undefined, timeout);
server.metadata = await Client.getMetadata(server, undefined, timeout);
if (!self.http) {
self.http = Client.defaultHttp;
}
if (!self.http.server) {
self.http.server = server;
}
self.server = server;
return self;
}
/** Get an alarm DAO for querying alarms. */
public alarms() {
return new AlarmDAO(this);
}
/** Get an event DAO for querying events. */
public events() {
return new EventDAO(this);
}
/** Get a node DAO for querying nodes. */
public nodes() {
return new NodeDAO(this);
}
/** Get a flow DAO for querying flows. */
public flows() {
return new FlowDAO(this);
}
}