67bcb53487af1c9acbc24942c4b4458250f1eb83
[policy/clamp.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  * Copyright (C) 2021 Nordix Foundation.
4  * ================================================================================
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * SPDX-License-Identifier: Apache-2.0
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.clamp.controlloop.models.controlloop.concepts;
22
23 import java.util.LinkedHashMap;
24 import java.util.Map;
25 import java.util.UUID;
26 import java.util.function.UnaryOperator;
27 import lombok.Data;
28 import lombok.NoArgsConstructor;
29 import lombok.NonNull;
30 import lombok.ToString;
31 import org.onap.policy.models.base.PfConceptKey;
32 import org.onap.policy.models.base.PfUtils;
33 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
34 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
35
36 /**
37  * Class to represent a control loop instance.
38  */
39 @NoArgsConstructor
40 @Data
41 @ToString
42 public class ControlLoopElement {
43     @NonNull
44     private UUID id = UUID.randomUUID();
45
46     @NonNull
47     private ToscaConceptIdentifier definition = new ToscaConceptIdentifier(PfConceptKey.getNullKey());
48
49     @NonNull
50     private ToscaConceptIdentifier participantType = new ToscaConceptIdentifier(PfConceptKey.getNullKey());
51
52     @NonNull
53     private ToscaConceptIdentifier participantId = new ToscaConceptIdentifier(PfConceptKey.getNullKey());
54
55     @NonNull
56     private ControlLoopState state = ControlLoopState.UNINITIALISED;
57
58     @NonNull
59     private ControlLoopOrderedState orderedState = ControlLoopOrderedState.UNINITIALISED;
60
61     private ToscaServiceTemplate toscaServiceTemplateFragment;
62
63     private String description;
64
65     private ClElementStatistics clElementStatistics;
66
67     // A map indexed by the property name. Each map entry is the serialized value of the property,
68     // which can be deserialized into an instance of the type of the property.
69     private Map<String, String> commonPropertiesMap = new LinkedHashMap<>();
70
71     /**
72      * Copy constructor, does a deep copy but as all fields here are immutable, it's just a regular copy.
73      *
74      * @param otherElement the other element to copy from
75      */
76     public ControlLoopElement(final ControlLoopElement otherElement) {
77         this.id = otherElement.id;
78         this.definition = new ToscaConceptIdentifier(otherElement.definition);
79         this.participantType = new ToscaConceptIdentifier(otherElement.participantType);
80         this.participantId = new ToscaConceptIdentifier(otherElement.participantId);
81         this.state = otherElement.state;
82         this.orderedState = otherElement.orderedState;
83         this.toscaServiceTemplateFragment = otherElement.toscaServiceTemplateFragment;
84         this.description = otherElement.description;
85         this.clElementStatistics = otherElement.clElementStatistics;
86         this.commonPropertiesMap = PfUtils.mapMap(otherElement.commonPropertiesMap, UnaryOperator.identity());
87     }
88 }