-
Notifications
You must be signed in to change notification settings - Fork 2k
/
RoleEnvironmentChangingEvent.java
76 lines (69 loc) · 2.63 KB
/
RoleEnvironmentChangingEvent.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
/**
* Copyright Microsoft Corporation
*
* 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 com.microsoft.windowsazure.serviceruntime;
import java.util.Collection;
/**
*
* Occurs before a change to the service configuration is applied to the running
* instances of the role.
* <p>
* Service configuration changes are applied on-the-fly to running role instances. Configuration changes include changes
* to the service configuration changes and changes to the number of instances in the service.
* <p>
* This event occurs after the new configuration file has been submitted to Windows Azure but before the changes have
* been applied to each running role instance. This event can be cancelled for a given instance to prevent the
* configuration change.
* <p>
* Note that cancelling this event causes the instance to be automatically recycled. When the instance is recycled, the
* configuration change is applied when it restarts.
*
* @see RoleEnvironmentChangingListener
* @see RoleEnvironmentChangedEvent
*/
public class RoleEnvironmentChangingEvent {
private final Collection<RoleEnvironmentChange> changes;
private boolean cancelled;
RoleEnvironmentChangingEvent(Collection<RoleEnvironmentChange> changes) {
this.changes = changes;
cancelled = false;
}
/**
* Cancel the configuration change.
* <p>
* Cancellation causes the role instance to be immediately recycled. The configuration changes are applied when the
* instance restarts.
*
*/
public void cancel() {
cancelled = true;
}
boolean isCancelled() {
return cancelled;
}
/**
* Returns a collection of the configuration changes that are about to be
* applied to the role instance.
*
* @return A <code>java.util.Collection</code> object containing {@link RoleEnvironmentChange} objects that
* represent the
* configuration changes that are about to be applied to the role
* instance.
*
* @see RoleEnvironmentChange
*/
public Collection<RoleEnvironmentChange> getChanges() {
return changes;
}
}