2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
22 package org.openecomp.appc.adapter.chef.impl;
24 import org.openecomp.appc.Constants;
25 import org.openecomp.appc.configuration.Configuration;
26 import org.openecomp.appc.configuration.ConfigurationFactory;
27 import org.openecomp.sdnc.sli.SvcLogicContext;
30 * This class is used to track and maintain recovery and time-to-live information for a request as it is being
33 public class RequestContext {
35 * The number of seconds of wait time between successive attempts to connect to the provider. This is used to
36 * recover from provider outages or failures. It is not used to recover from logical errors, such as an invalid
37 * request, server not found, etc.
39 private Integer retryDelay;
42 * The number of times we will attempt to connect to the provider. This is used to recover from provider outages or
43 * failures. It is not used to recover from logical errors, such as an invalid request, server not found, etc.
45 private Integer retryLimit;
48 * The total time, in milliseconds, that the provider can have to process this request. If the accumulated time
49 * exceeds the time to live, then the request is failed with a timeout exception, regardless of the state of the
50 * provider. Note that the caller may supply this as a value in seconds, in which case it must be converted to
51 * milliseconds for the request context.
53 private Long timeToLive;
56 * The accumulated time, in milliseconds, that has been used so far to process the request. This is compared to the
57 * time to live each time it is updated. If the accumulated time exceeds the time to live, then the request is
58 * failed with a timeout exception, regardless of the state of the provider.
60 private long accumulatedTime;
63 * The total number of retries attempted so far
68 * The time when the stopwatch was started
70 private long startTime = -1;
73 * The service logic (DG) context from the SLI
75 private SvcLogicContext svcLogicContext;
80 private Configuration configuration = ConfigurationFactory.getConfiguration();
83 * Set to true whenever the retry limit has been exceeded, reset to false when reset() is called.
85 private boolean retryFailed;
88 * Creates the request context
91 * The service logic (SLI) context associated with the current DG
93 public RequestContext(SvcLogicContext context) {
94 setSvcLogicContext(context);
98 * @return The retry delay, in seconds. If zero, then no retry is to be performed
100 public int getRetryDelay() {
101 if (retryDelay == null) {
102 int value = configuration.getIntegerProperty(Constants.PROPERTY_RETRY_DELAY);
103 retryDelay = Integer.valueOf(value);
106 return retryDelay.intValue();
110 * This method is a helper that allows the caller to delay for the retry interval time and not have to handle the
111 * thread interruption, timer handling, etc.
113 public void delay() {
114 long time = getRetryDelay() * 1000L;
115 long future = System.currentTimeMillis() + time;
117 while (System.currentTimeMillis() < future && time > 0) {
120 } catch (InterruptedException e) {
122 * This is rare, but it can happen if another thread interrupts us while we are sleeping. In that
123 * case, the thread is resumed before the delay time has actually expired, so re-calculate the
124 * amount of delay time needed and reenter the sleep until we get to the future time.
126 time = future - System.currentTimeMillis();
133 * @return The number of retries that are allowed per connection
135 public int getRetryLimit() {
136 if (retryLimit == null) {
137 int value = configuration.getIntegerProperty(Constants.PROPERTY_RETRY_LIMIT);
138 retryLimit = Integer.valueOf(value);
141 return retryLimit.intValue();
145 * Check and count the connection attempt.
147 * @return True if the connection should be attempted. False indicates that the number of retries has been exhausted
148 * and it should NOT be attempted.
150 public boolean attempt() {
151 if (retryFailed || attempt >= getRetryLimit()) {
161 * @return The number of retry attempts so far
163 public int getAttempts() {
168 * @return True if the retry limit has been exceeded, false otherwise
170 public boolean isFailed() {
175 * This method both checks the time to live to see if it has been exceeded and accumulates the total time used so
178 * Each time this method is called it accumulates the total duration since the last time it was called to the total
179 * time accumulator. It then checks the total time to the time to live and if greater, it returns false. As long as
180 * the total time used is less than or equal to the time to live limit, the method returns true. It is important to
181 * call this method at the very beginning of the process so that all parts of the process are tracked.
184 * @return True if the total time to live has not been exceeded. False indicates that the total time to live has
185 * been exceeded and no further processing should be performed.
187 public boolean isAlive() {
188 long now = System.currentTimeMillis();
189 if (startTime == -1) {
193 accumulatedTime += (now - startTime);
195 if (accumulatedTime > timeToLive) {
202 * @return The total amount of time used, in milliseconds.
204 public long getTotalDuration() {
205 return accumulatedTime;
209 * This method is called to reset the retry counters. It has no effect on the time to live accumulator.
211 public void reset() {
216 * Sets the time to live to the value, expressed in seconds
219 * The time to live, in seconds
221 public void setTimeToLiveSeconds(int time) {
222 setTimeToLiveMS(time * 1000L);
226 * Sets the time to live to the value, expressed in milliseconds
229 * The time to live, in milliseconds
231 public void setTimeToLiveMS(long time) {
232 this.timeToLive = time;
236 * @return The service logic context associated with this request
238 public SvcLogicContext getSvcLogicContext() {
239 return svcLogicContext;
243 * @param svcLogicContext
244 * The service logic context to be associated with this request
246 public void setSvcLogicContext(SvcLogicContext svcLogicContext) {
247 this.svcLogicContext = svcLogicContext;