This repository has been archived by the owner on Apr 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
WXMClientType.java
207 lines (176 loc) · 5.09 KB
/
WXMClientType.java
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
/*
* Copyright © 2020 Mark Raynsford <code@io7m.com> http://io7m.com
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
* IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package com.io7m.waxmill.client.api;
import com.io7m.waxmill.exceptions.WXMException;
import com.io7m.waxmill.machines.WXMBootConfigurationName;
import com.io7m.waxmill.machines.WXMDeviceType;
import com.io7m.waxmill.machines.WXMDryRun;
import com.io7m.waxmill.machines.WXMVirtualMachine;
import com.io7m.waxmill.machines.WXMVirtualMachineSet;
import com.io7m.waxmill.machines.WXMVirtualMachineSets;
import com.io7m.waxmill.process.api.WXMProcessDescription;
import java.util.Optional;
import java.util.UUID;
/**
* A client.
*/
public interface WXMClientType extends AutoCloseable
{
@Override
void close()
throws WXMException;
/**
* List the available virtual machines.
*
* @return A set of machines
*
* @throws WXMException On errors
*/
WXMVirtualMachineSet vmList()
throws WXMException;
/**
* Find a virtual machine with the given ID.
*
* @param id The ID of the machine
*
* @return A virtual machine
*
* @throws WXMException On errors
*/
WXMVirtualMachine vmFind(
UUID id)
throws WXMException;
/**
* Find a virtual machine with the given ID.
*
* @param id The ID of the machine
*
* @return A virtual machine, if one exists
*
* @throws WXMException On errors
*/
Optional<WXMVirtualMachine> vmFindOptional(
UUID id)
throws WXMException;
/**
* Update an existing virtual machine.
*
* @param machine The virtual machine
*
* @throws WXMException On errors
*/
void vmUpdate(
WXMVirtualMachine machine)
throws WXMException;
/**
* @return The configuration used to open the client
*/
WXMClientConfiguration configuration();
/**
* Define a set of new virtual machines.
*
* @param machines The virtual machine
*
* @throws WXMException On errors
*/
void vmDefineAll(
WXMVirtualMachineSet machines)
throws WXMException;
/**
* Define a new virtual machine.
*
* @param machine The virtual machine
*
* @throws WXMException On errors
*/
default void vmDefine(
final WXMVirtualMachine machine)
throws WXMException
{
this.vmDefineAll(WXMVirtualMachineSets.one(machine));
}
/**
* Start a virtual machine. If the startup succeeds, this method never
* returns and the current process is replaced with that of the running
* virtual machine.
*
* @param machine The virtual machine
* @param bootConfigurationName The boot configuration used
* @param dryRun Whether or not the operation is a dry run
*
* @throws WXMException On errors
* @throws InterruptedException If the operation was interrupted
*/
void vmRun(
WXMVirtualMachine machine,
WXMBootConfigurationName bootConfigurationName,
WXMDryRun dryRun)
throws WXMException, InterruptedException;
/**
* Delete the configuration for a virtual machine.
*
* @param id The machine ID
*
* @throws WXMException On errors
*/
void vmDelete(UUID id)
throws WXMException;
/**
* Return the primary console device of the given virtual machine. The method
* will return nothing if the machine has no console device, or if the
* machine has more than one potential console.
*
* @param machine The virtual machine
*
* @return A process execution
*/
Optional<WXMDeviceType> vmConsoleGet(
WXMVirtualMachine machine);
/**
* Return a process description that, when executed, will give access to
* the primary console of the given virtual machine. The method will return
* nothing if the machine has no console device, or if the machine has more
* than one potential console.
*
* @param machine The virtual machine
*
* @return A process execution
*/
Optional<WXMProcessDescription> vmConsole(
WXMVirtualMachine machine);
/**
* Realize a virtual machine.
*
* @param machine The virtual machine
* @param dryRun Whether or not the operation is a dry run
*
* @throws WXMException On errors
*/
void vmRealize(
WXMVirtualMachine machine,
WXMDryRun dryRun)
throws WXMException;
/**
* Kill a running virtual machine.
*
* @param dryRun Whether or not the operation is a dry run
* @param machine The virtual machine
*/
void vmKill(
WXMVirtualMachine machine,
WXMDryRun dryRun)
throws WXMException;
}