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
|
/*-
* ============LICENSE_START=======================================================
* ONAP : APPC
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Copyright (C) 2017 Amdocs
* =============================================================================
* 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.
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
* ============LICENSE_END=========================================================
*/
package org.openecomp.appc.oam.processor;
import com.att.eelf.configuration.EELFLogger;
import org.openecomp.appc.exceptions.APPCException;
import org.openecomp.appc.i18n.Msg;
import org.openecomp.appc.oam.AppcOam;
import org.openecomp.appc.oam.util.AsyncTaskHelper;
import org.openecomp.appc.oam.util.ConfigurationHelper;
import org.openecomp.appc.oam.util.OperationHelper;
import org.openecomp.appc.oam.util.StateHelper;
import org.openecomp.appc.requesthandler.LCMStateManager;
import org.openecomp.appc.statemachine.impl.readers.AppcOamStates;
/**
* Processor to handle restart OAM API.
*/
public class OamRestartProcessor extends BaseProcessor {
/**
* Action phases:
* <br> -ToStop: call bundles stop
* <br> -Stopped: check if all bundle state reached stopped
* <br> -ToStart: call bundles start
* <br> -Started: action is full completed
* <br> -Timeout: indication of timeout reached
*/
private enum ActionPhases {
ToStop,
Stopped,
ToStart,
Started,
Timeout
}
/**
* Constructor
*
* @param eelfLogger for logging
* @param configurationHelper for property reading
* @param stateHelper for APP-C OAM state checking
* @param asyncTaskHelper for scheduling async task
* @param operationHelper for operational helper
*/
public OamRestartProcessor(EELFLogger eelfLogger,
ConfigurationHelper configurationHelper,
StateHelper stateHelper,
AsyncTaskHelper asyncTaskHelper,
OperationHelper operationHelper) {
super(eelfLogger, configurationHelper, stateHelper, asyncTaskHelper, operationHelper);
rpc = AppcOam.RPC.restart;
auditMsg = Msg.OAM_OPERATION_RESTARTING;
}
@Override
protected void scheduleAsyncTask() {
runnable = new MyRunnable(this);
super.scheduleAsyncTask();
}
/**
* This runnable does the async handling for the restart REST API. And it will be scheduled to run one time.
*
* <p>This runnable will the following operations: <br>
* - do APP-C OAM bundle stop and then start through BundlerHelper<br>
* - and always enable LCM operation handling (which can be disabled through maintenance mode API).<br>
* <p>Once above operations are done, the runnale will <br>
* - post message through operatonHelper <br>
* - set APP-C OAM state to started <br>
* - audit log the state <br>
*/
class MyRunnable extends BaseActionRunnable {
ActionPhases currentPhase = ActionPhases.ToStop;
private LCMStateManager lcmStateManager;
MyRunnable(BaseProcessor parent) {
super(parent);
actionName = "OAM Restart";
auditMsg = Msg.OAM_OPERATION_RESTARTED;
finalState = AppcOamStates.Started;
}
/**
* Do restart action, include stop then start and always enable LCM operation.
* @return true if action is successful, false when aciton is failed or aborted
*/
@Override
boolean doAction() {
logDebug(String.format("Executing %s task at phase (%s)",
actionName, currentPhase == null ? "null" : currentPhase.name()));
boolean isBundleOperationCompleted = true;
try {
switch (currentPhase) {
case ToStop:
isBundleOperationCompleted = bundleHelper.bundleOperations(
AppcOam.RPC.stop, bundleNameToFuture, myParent.asyncTaskHelper);
currentPhase = ActionPhases.Stopped;
break;
case Stopped:
// check state
AppcOamStates currentState = stateHelper.getBundlesState();
if (currentState == AppcOamStates.Stopped) {
currentPhase = ActionPhases.ToStart;
} else {
logDebug(String.format("%s task is waiting in stopped phase, current state is %s",
actionName, currentState));
}
break;
case ToStart:
isBundleOperationCompleted = bundleHelper.bundleOperations(
AppcOam.RPC.start, bundleNameToFuture, myParent.asyncTaskHelper);
currentPhase = ActionPhases.Started;
break;
case Timeout:
// do nothing
break;
default:
// Should not reach log it and return false;
logger.error("%s task doAction reached %s phase. not supported. return false.",
actionName, currentPhase.name());
stateHelper.setState(AppcOamStates.Error);
return false;
}
if (isTimeout("restart doAction")) {
currentPhase = ActionPhases.Timeout;
return true;
}
if (isBundleOperationCompleted) {
return true;
}
setAbortStatus();
} catch (APPCException e) {
setErrorStatus(e);
stateHelper.setState(AppcOamStates.Error);
}
return false;
}
/**
* With additional to get the LCMStateManager service
* @see BaseActionRunnable#checkState()
*/
@Override
boolean checkState() {
switch (currentPhase) {
case Started:
try {
lcmStateManager = operationHelper.getService(LCMStateManager.class);
return super.checkState();
} catch (APPCException e) {
logDebug("LCMStateManager is not available.");
}
break;
default:
// in all the other ActionPhase, we want the run go back to doAction
return true;
}
return false;
}
/**
* Final handling. The thread is cancelled.
* @param setState boolean to indicate if set OAM state or not
*/
@Override
void postDoAction(boolean setState) {
AppcOamStates newState = null;
if (setState) {
logDebug("Always enable LCM operation");
lcmStateManager.enableLCMOperations();
newState = finalState;
}
postAction(newState);
super.postDoAction(setState);
}
}
}
|
