2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Copyright (C) 2017 Amdocs
8 * =============================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 * ============LICENSE_END=========================================================
26 package org.onap.appc.adapter.iaas.impl;
28 import org.onap.appc.Constants;
29 import org.onap.appc.configuration.Configuration;
30 import org.onap.appc.configuration.ConfigurationFactory;
31 import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
34 * This class is used to track and maintain recovery and time-to-live information for a request as it is being
37 public class RequestContext {
39 * The number of seconds of wait time between successive attempts to connect to the provider. This is used to
40 * recover from provider outages or failures. It is not used to recover from logical errors, such as an invalid
41 * request, server not found, etc.
43 private Integer retryDelay;
46 * The number of times we will attempt to connect to the provider. This is used to recover from provider outages or
47 * failures. It is not used to recover from logical errors, such as an invalid request, server not found, etc.
49 private Integer retryLimit;
52 * The total time, in milliseconds, that the provider can have to process this request. If the accumulated time
53 * exceeds the time to live, then the request is failed with a timeout exception, regardless of the state of the
54 * provider. Note that the caller may supply this as a value in seconds, in which case it must be converted to
55 * milliseconds for the request context.
57 private Long timeToLive;
60 * The accumulated time, in milliseconds, that has been used so far to process the request. This is compared to the
61 * time to live each time it is updated. If the accumulated time exceeds the time to live, then the request is
62 * failed with a timeout exception, regardless of the state of the provider.
64 private long accumulatedTime;
67 * The total number of retries attempted so far
72 * The time when the stopwatch was started
74 private long startTime = -1;
77 * The service logic (DG) context from the SLI
79 private SvcLogicContext svcLogicContext;
84 private Configuration configuration = ConfigurationFactory.getConfiguration();
87 * Set to true whenever the retry limit has been exceeded, reset to false when reset() is called.
89 private boolean retryFailed;
92 * Creates the request context
94 * @param context The service logic (SLI) context associated with the current DG
96 public RequestContext(SvcLogicContext context) {
97 setSvcLogicContext(context);
101 * @return The retry delay, in seconds. If zero, then no retry is to be performed
103 public int getRetryDelay() {
104 if (retryDelay == null) {
105 int value = configuration.getIntegerProperty(Constants.PROPERTY_RETRY_DELAY);
106 retryDelay = Integer.valueOf(value);
109 return retryDelay.intValue();
113 * This method is a helper that allows the caller to delay for the retry interval time and not have to handle the
114 * thread interruption, timer handling, etc.
116 public void delay() {
117 long time = getRetryDelay() * 1000L;
118 long future = System.currentTimeMillis() + time;
120 while (System.currentTimeMillis() < future && time > 0) {
123 } catch (InterruptedException e) {
125 * This is rare, but it can happen if another thread interrupts us while we are sleeping. In that
126 * case, the thread is resumed before the delay time has actually expired, so re-calculate the
127 * amount of delay time needed and reenter the sleep until we get to the future time.
129 time = future - System.currentTimeMillis();
136 * @return The number of retries that are allowed per connection
138 public int getRetryLimit() {
139 if (retryLimit == null) {
140 int value = configuration.getIntegerProperty(Constants.PROPERTY_RETRY_LIMIT);
141 retryLimit = Integer.valueOf(value);
144 return retryLimit.intValue();
148 * Check and count the connection attempt.
150 * @return True if the connection should be attempted. False indicates that the number of retries has been exhausted
151 * and it should NOT be attempted.
153 public boolean attempt() {
154 if (retryFailed || attempt >= getRetryLimit()) {
164 * @return The number of retry attempts so far
166 public int getAttempts() {
171 * @return True if the retry limit has been exceeded, false otherwise
173 public boolean isFailed() {
178 * This method both checks the time to live to see if it has been exceeded and accumulates the total time used so
181 * Each time this method is called it accumulates the total duration since the last time it was called to the total
182 * time accumulator. It then checks the total time to the time to live and if greater, it returns false. As long as
183 * the total time used is less than or equal to the time to live limit, the method returns true. It is important to
184 * call this method at the very beginning of the process so that all parts of the process are tracked.
187 * @return True if the total time to live has not been exceeded. False indicates that the total time to live has
188 * been exceeded and no further processing should be performed.
190 public boolean isAlive() {
191 long now = System.currentTimeMillis();
192 if (startTime == -1) {
196 accumulatedTime += (now - startTime);
198 if (accumulatedTime > timeToLive) {
205 * @return The total amount of time used, in milliseconds.
207 public long getTotalDuration() {
208 return accumulatedTime;
212 * This method is called to reset the retry counters. It has no effect on the time to live accumulator.
214 public void reset() {
219 * Sets the time to live to the value, expressed in seconds
221 * @param time The time to live, in seconds
223 public void setTimeToLiveSeconds(int time) {
224 setTimeToLiveMS(time * 1000L);
228 * Sets the time to live to the value, expressed in milliseconds
230 * @param time The time to live, in milliseconds
232 public void setTimeToLiveMS(long time) {
233 this.timeToLive = time;
237 * @return The service logic context associated with this request
239 public SvcLogicContext getSvcLogicContext() {
240 return svcLogicContext;
244 * @param svcLogicContext The service logic context to be associated with this request
246 public void setSvcLogicContext(SvcLogicContext svcLogicContext) {
247 this.svcLogicContext = svcLogicContext;