This repository has been archived by the owner on Sep 23, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 82
/
Manager.java
247 lines (192 loc) · 9.67 KB
/
Manager.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
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
/*
* Copyright 1999-2008 University of Chicago
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package org.nimbustools.api.services.rm;
import java.util.Calendar;
import org.nimbustools.api.NimbusModule;
import org.nimbustools.api.repr.Advertised;
import org.nimbustools.api.repr.AsyncCreateRequest;
import org.nimbustools.api.repr.Caller;
import org.nimbustools.api.repr.CreateRequest;
import org.nimbustools.api.repr.CreateResult;
import org.nimbustools.api.repr.RequestInfo;
import org.nimbustools.api.repr.ShutdownTasks;
import org.nimbustools.api.repr.SpotCreateRequest;
import org.nimbustools.api.repr.SpotPriceEntry;
import org.nimbustools.api.repr.SpotRequestInfo;
import org.nimbustools.api.repr.Usage;
import org.nimbustools.api.repr.vm.VM;
/**
* <p><img src="http://www.nimbusproject.org/images/sh.png" alt="[Start here] " />
* The main RM interface.</p>
*
* <p>Better documentation/diagrams coming, the best way to learn right now is to
* see how it is invoked in one of the message layer implementations.</p>
*
* <p>The main documentation task is to document the tricky areas like 'legal
* inputs' etc. From looking at the method names you should be able to
* see the basic usage:</p>
*
* <ul>
* <li>create VMs</li>
* <li>request spot instances</li>
* <li>manage VMs by instance handle or group handle</li>
* <li>destroy VMs by instance handle or group handle</li>
* <li>query for up to date information</li>
* <li>register callbacks for state changes or terminations events</li>
* </ul>
*
* <p>Click on the "Manager" link above to see the source code which has
* a more natural grouping of the methods.</p>
*
* <p><b>todo</b>: document each method independently</p>
* <p><b>todo</b>: richer exceptions/hiearchy</p>
*/
public interface Manager extends NimbusModule {
// -------------------------------------------------------------------------
// CONSTANTS
// -------------------------------------------------------------------------
public static final int INSTANCE = 0;
public static final int GROUP = 1;
public static final int COSCHEDULED = 2;
// -------------------------------------------------------------------------
// LIFECYCLE
// -------------------------------------------------------------------------
/**
* <p>This informs the implementation that its container (or whatever is
* instantiating it) has just recovered from a failure or restart.</p>
*
* <p>If it is left up to normal initialization mechanisms, then there is
* no chance for change/destruction listeners to be registered <i>before</i>
* something happens.</p>
*
* @throws Exception problem, cannot continue
*/
public void recover_initialize() throws Exception;
/**
* Dying.
*/
public void shutdownImmediately();
// -------------------------------------------------------------------------
// EVENTS CAUSED BY USER OPERATIONS - MUTATIVE
// -------------------------------------------------------------------------
public CreateResult create(CreateRequest req, Caller caller)
throws AuthorizationException,
CoSchedulingException,
CreationException,
MetadataException,
ResourceRequestDeniedException,
SchedulingException;
public void setDestructionTime(String id, int type, Calendar time)
throws DoesNotExistException, ManageException;
public void trash(String id, int type, Caller caller)
throws DoesNotExistException, ManageException;
public void start(String id, int type, Caller caller)
throws DoesNotExistException, ManageException, OperationDisabledException;
public void shutdown(String id, int type,
ShutdownTasks tasks, Caller caller)
throws DoesNotExistException, ManageException, OperationDisabledException;
public void shutdownSave(String id, int type,
ShutdownTasks tasks, Caller caller)
throws DoesNotExistException, ManageException, OperationDisabledException;
public void cleanup(String id, int type, Caller caller)
throws DoesNotExistException, ManageException, OperationDisabledException;
public void pause(String id, int type,
ShutdownTasks tasks, Caller caller)
throws DoesNotExistException, ManageException, OperationDisabledException;
public void serialize(String id, int type,
ShutdownTasks tasks, Caller caller)
throws DoesNotExistException, ManageException, OperationDisabledException;
public void reboot(String id, int type,
ShutdownTasks tasks, Caller caller)
throws DoesNotExistException, ManageException, OperationDisabledException;
public void coscheduleDone(String id, Caller caller)
throws DoesNotExistException, ManageException, CoSchedulingException;
// -------------------------------------------------------------------------
// INFORMATION QUERIES
// -------------------------------------------------------------------------
public boolean exists(String id, int type);
public Advertised getAdvertised();
public Calendar getDestructionTime(String id, int type)
throws DoesNotExistException, ManageException;
public Caller[] getAuthorizedManagers(String id, int type)
throws DoesNotExistException, ManageException;
public VM getInstance(String id)
throws DoesNotExistException, ManageException;
public VM[] getAll(String id, int type)
throws DoesNotExistException, ManageException;
public VM[] getAllByCaller(Caller caller)
throws ManageException;
public VM[] getAllByIPAddress(String ip)
throws ManageException;
public VM[] getGlobalAll()
throws ManageException;
public Usage getCallerUsage(Caller caller)
throws ManageException;
public void registerStateChangeListener(String id,
int type,
StateChangeCallback listener)
throws ManageException, DoesNotExistException;
public void registerDestructionListener(String id,
int type,
DestructionCallback listener)
throws ManageException, DoesNotExistException;
/* Human readable VMM insight */
public String getVMMReport();
public String[] getResourcePools();
// -------------------------------------------------------------------------
// SPOT INSTANCES OPERATIONS
// -------------------------------------------------------------------------
public SpotRequestInfo requestSpotInstances(SpotCreateRequest req, Caller caller)
throws AuthorizationException,
CoSchedulingException,
CreationException,
MetadataException,
ResourceRequestDeniedException,
SchedulingException;
public SpotRequestInfo getSpotRequest(String requestID, Caller caller)
throws DoesNotExistException, ManageException, AuthorizationException;
public SpotRequestInfo[] getSpotRequests(String[] ids, Caller caller)
throws DoesNotExistException, ManageException, AuthorizationException;
public SpotRequestInfo[] getSpotRequestsByCaller(Caller caller)
throws ManageException;
public SpotRequestInfo[] cancelSpotInstanceRequests(String[] ids,
Caller caller)
throws DoesNotExistException, AuthorizationException, ManageException;
public Double getSpotPrice();
public SpotPriceEntry[] getSpotPriceHistory()
throws ManageException;
public SpotPriceEntry[] getSpotPriceHistory(Calendar startDate, Calendar endDate)
throws ManageException;
// -------------------------------------------------------------------------
// BACKFILL OPERATIONS
// -------------------------------------------------------------------------
public RequestInfo addBackfillRequest(AsyncCreateRequest req, Caller caller)
throws AuthorizationException,
CoSchedulingException,
CreationException,
MetadataException,
ResourceRequestDeniedException,
SchedulingException;
public RequestInfo getBackfillRequest(String requestID, Caller caller)
throws DoesNotExistException, ManageException, AuthorizationException;
public RequestInfo[] getBackfillRequests(String[] ids, Caller caller)
throws DoesNotExistException, ManageException, AuthorizationException;
public RequestInfo[] getBackfillRequestsByCaller(Caller caller)
throws ManageException;
public RequestInfo[] cancelBackfillRequests(String[] ids,
Caller caller)
throws DoesNotExistException, AuthorizationException, ManageException;
}