aboutsummaryrefslogtreecommitdiffstats
path: root/catalog-model/src/main/java/org/openecomp/sdc/be/model/operations/api/IComponentInstanceOperation.java
blob: e51e0779069c39732cac1027c0cc1bc506b5f041 (plain)
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.sdc.be.model.operations.api;

import java.util.List;
import java.util.Map;

import org.apache.commons.lang3.tuple.ImmutablePair;
import org.openecomp.sdc.be.dao.neo4j.GraphPropertiesDictionary;
import org.openecomp.sdc.be.dao.titan.TitanOperationStatus;
import org.openecomp.sdc.be.datatypes.enums.NodeTypeEnum;
import org.openecomp.sdc.be.model.ArtifactDefinition;
import org.openecomp.sdc.be.model.ComponentInstance;
import org.openecomp.sdc.be.model.ComponentInstanceAttribute;
import org.openecomp.sdc.be.model.ComponentInstanceInput;
import org.openecomp.sdc.be.model.ComponentInstanceProperty;
import org.openecomp.sdc.be.model.RequirementAndRelationshipPair;
import org.openecomp.sdc.be.model.RequirementCapabilityRelDef;
import org.openecomp.sdc.be.resources.data.AttributeValueData;
import org.openecomp.sdc.be.resources.data.ComponentInstanceData;

import fj.data.Either;

public interface IComponentInstanceOperation {

	/**
	 * add resource instance to service
	 * 
	 * @param containerComponentId
	 *            - component id
	 * @param instanceNumber
	 *            - instance number of the component instance
	 * @param componentInstance
	 * @param inTransaction
	 * @return
	 */
	public Either<ComponentInstance, StorageOperationStatus> createComponentInstance(String containerComponentId,
			NodeTypeEnum containerNodeType, String instanceNumber, ComponentInstance componentInstance,
			NodeTypeEnum instNodeType, boolean inTransaction);

	/**
	 * add resource instance to service with internal transaction
	 * 
	 * @param containerComponentId
	 * @param instanceNumber
	 * @param componentInstance
	 * @return
	 */
	public Either<ComponentInstance, StorageOperationStatus> createComponentInstance(String containerComponentId,
			NodeTypeEnum containerNodeType, String instanceNumber, ComponentInstance componentInstance,
			NodeTypeEnum instNodeType);

	/**
	 * delete resource instance from component
	 * 
	 * @param containerComponentId
	 *            - containerComponent id
	 * @param resourceInstUid
	 *            - resource instance uid
	 * @param inTransaction
	 * @return
	 */
	public Either<ComponentInstance, StorageOperationStatus> deleteComponentInstance(NodeTypeEnum containerNodeType,
			String containerComponentId, String resourceInstUid, boolean inTransaction);

	public Either<ComponentInstance, StorageOperationStatus> deleteComponentInstance(NodeTypeEnum containerNodeType,
			String containerComponentId, String resourceInstUid);

	/**
	 * associate 2 resource instances for a given requirement
	 * 
	 * @param serviceId
	 * @param fromResInstanceUid
	 * @param toResInstanceUid
	 * @param requirement
	 * @param relationship
	 * @param inTransaction
	 * @return
	 */
	// public Either<RequirementCapabilityRelDef, StorageOperationStatus>
	// associateResourceInstances(
	// String serviceId, NodeTypeEnum nodeType, String fromResInstanceUid,
	// String toResInstanceUid, String requirement, String relationship,
	// boolean inTransaction);

	// public Either<RequirementCapabilityRelDef, StorageOperationStatus>
	// associateResourceInstances(
	// String serviceId, NodeTypeEnum nodeType, String fromResInstanceUid,
	// String toResInstanceUid, String requirement, String relationship);

	public Either<RequirementCapabilityRelDef, StorageOperationStatus> associateResourceInstances(String serviceId,
			NodeTypeEnum nodeType, RequirementCapabilityRelDef relation, boolean inTransaction);

	public Either<RequirementCapabilityRelDef, StorageOperationStatus> associateResourceInstances(String serviceId,
			NodeTypeEnum nodeType, RequirementCapabilityRelDef relation);

	/**
	 * 
	 * dissociate the relation between 2 resource instances for a given
	 * requirement
	 * 
	 * @param serviceId
	 * @param fromResInstanceUid
	 * @param toResInstanceUid
	 * @param requirement
	 * @param inTransaction
	 * @return
	 */
	public Either<RequirementCapabilityRelDef, StorageOperationStatus> dissociateResourceInstances(String serviceId,
			NodeTypeEnum nodeType, RequirementCapabilityRelDef requirementDef, boolean inTransaction);

	public Either<RequirementCapabilityRelDef, StorageOperationStatus> dissociateResourceInstances(String serviceId,
			NodeTypeEnum nodeType, RequirementCapabilityRelDef requirementDef);

	/**
	 * update the properties of a given resource instance
	 * 
	 * @param serviceId
	 * @param resourceInstanceName
	 * @param resourceInstance
	 * @param inTransaction
	 * @return
	 */
	public Either<ComponentInstance, StorageOperationStatus> updateResourceInstance(String serviceId,
			NodeTypeEnum nodeType, String resourceInstanceName, ComponentInstance resourceInstance,
			boolean inTransaction);

	public Either<ComponentInstance, StorageOperationStatus> updateResourceInstance(String serviceId,
			NodeTypeEnum nodeType, String resourceInstanceName, ComponentInstance resourceInstance);

	/**
	 * get all resource instances of a given service and the relations between
	 * the resource instances
	 * 
	 * @param serviceId
	 * @param inTransaction
	 * @return
	 */
	public Either<ImmutablePair<List<ComponentInstance>, List<RequirementCapabilityRelDef>>, StorageOperationStatus> getAllComponentInstances(
			String componentId, NodeTypeEnum containerNodeType, NodeTypeEnum compInstNodeType, boolean inTransaction);

	public Either<List<String>, StorageOperationStatus> getAllComponentInstancesNames(String componentId,
			NodeTypeEnum nodeType, boolean inTransaction);

	public Either<List<String>, StorageOperationStatus> getAllComponentInstancesNames(String componentId,
			NodeTypeEnum nodeType);

	/**
	 * get resource instance from id
	 * 
	 * @param resourceId
	 * @return resource instance of given id
	 */
	public Either<ComponentInstance, StorageOperationStatus> getResourceInstanceById(String resourceId);

	public Either<List<ComponentInstance>, StorageOperationStatus> deleteAllComponentInstances(String serviceId,
			NodeTypeEnum nodeType, boolean inTransaction);

	public Either<List<ComponentInstance>, StorageOperationStatus> deleteAllComponentInstances(String serviceId,
			NodeTypeEnum nodeType);

	public Either<Integer, StorageOperationStatus> increaseAndGetResourceInstanceSpecificCounter(
			String resourceInstanceId, GraphPropertiesDictionary counterType, boolean inTransaction);

	public String createComponentInstLogicalName(String instanceNumber, String componentInstanceName);

	public Either<Boolean, StorageOperationStatus> isComponentInstanceNameExist(String parentComponentId,
			NodeTypeEnum parentNodeType, String compInstId, String componentInstName);

	public Either<Boolean, StorageOperationStatus> validateParent(String parentId, String uniqId,
			boolean inTransaction);

	public Either<ComponentInstance, StorageOperationStatus> getFullComponentInstance(
			ComponentInstance componentInstance, NodeTypeEnum compInstNodeType);

	public Either<Boolean, StorageOperationStatus> isAvailableRequirement(ComponentInstance fromResInstance,
			RequirementAndRelationshipPair relationPair);

	public Either<Boolean, StorageOperationStatus> isAvailableCapabilty(ComponentInstance toResInstance,
			RequirementAndRelationshipPair relationPair);

	public Either<ComponentInstanceProperty, StorageOperationStatus> addPropertyValueToResourceInstance(
			ComponentInstanceProperty resourceInstanceProperty, String resourceInstanceId, Integer index,
			boolean inTransaction);

	public Either<ComponentInstanceProperty, StorageOperationStatus> addPropertyValueToResourceInstance(
			ComponentInstanceProperty resourceInstanceProperty, String resourceInstanceId, boolean isvalidate,
			Integer index, boolean inTransaction);

	/**
	 * Adds Attribute to resource instance
	 * 
	 * @param resourceInstanceAttribute
	 *            * @param resourceInstanceId * @param index * @param
	 *            inTransaction
	 * @return
	 **/
	public Either<ComponentInstanceAttribute, StorageOperationStatus> addAttributeValueToResourceInstance(
			ComponentInstanceAttribute resourceInstanceAttribute, String resourceInstanceId, Integer index,
			boolean inTransaction);

	public Either<ComponentInstanceProperty, StorageOperationStatus> updatePropertyValueInResourceInstance(
			ComponentInstanceProperty resourceInstanceProperty, String resourceInstanceId, boolean inTransaction);

	/**
	 * Updates Attribute on resource instance
	 * 
	 * @param attribute
	 * @param resourceInstanceId
	 * @param inTransaction
	 * @return
	 */
	public Either<ComponentInstanceAttribute, StorageOperationStatus> updateAttributeValueInResourceInstance(
			ComponentInstanceAttribute attribute, String resourceInstanceId, boolean inTransaction);

	public Either<AttributeValueData, TitanOperationStatus> createOrUpdateAttributeOfResourceInstance(
			ComponentInstanceAttribute attributeInstanceProperty, String resourceInstanceId);

	public Either<ComponentInstanceInput, StorageOperationStatus> addInputValueToResourceInstance(
			ComponentInstanceInput input, String resourceInstanceId, Integer innerElement, boolean b);

	public Either<ComponentInstanceInput, StorageOperationStatus> updateInputValueInResourceInstance(
			ComponentInstanceInput input, String resourceInstanceId, boolean b);

	public Either<Map<String, ArtifactDefinition>, StorageOperationStatus> fetchCIEnvArtifacts(
			String componentInstanceId);

}