summaryrefslogtreecommitdiff
path: root/opendc-web/opendc-web-client/src/main/kotlin/org/opendc/web/client/runner/OpenDCRunnerClient.kt
blob: 98785a55761539dcc8e84fe4b98bf921d703d23c (plain)
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
/*
 * Copyright (c) 2022 AtLarge Research
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.opendc.web.client.runner

import org.opendc.web.client.SchedulerResource
import org.opendc.web.client.TraceResource
import org.opendc.web.client.auth.AuthController
import org.opendc.web.client.transport.HttpTransportClient
import org.opendc.web.client.transport.TransportClient
import java.net.URI

/**
 * Client implementation for the runner-facing OpenDC REST API (version 2).
 *
 * @param client Low-level client for managing the underlying transport.
 */
public class OpenDCRunnerClient(client: TransportClient) {
    /**
     * Construct a new [OpenDCRunnerClient].
     *
     * @param baseUrl The base url of the API.
     * @param auth Helper class for managing authentication.
     */
    public constructor(baseUrl: URI, auth: AuthController? = null) : this(HttpTransportClient(baseUrl, auth))

    /**
     * A resource for the available simulation jobs.
     */
    public val jobs: JobResource = JobResource(client)

    /**
     * A resource for the available schedulers.
     */
    public val schedulers: SchedulerResource = SchedulerResource(client)

    /**
     * A resource for the available workload traces.
     */
    public val traces: TraceResource = TraceResource(client)
}