aboutsummaryrefslogtreecommitdiffstats
path: root/asdc-controller/src/main/java/org/onap/so/asdc/installer/ResourceStructure.java
blob: 8be3d6ba0699f622fb73b9aff244a5b657533dd6 (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
/*
 * ============LICENSE_START======================================================= Copyright (C) 2019 Nordix
 * Foundation. ================================================================================ 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.
 *
 * SPDX-License-Identifier: Apache-2.0 ============LICENSE_END=========================================================
 */

package org.onap.so.asdc.installer;

import java.io.UnsupportedEncodingException;
import java.util.HashMap;
import java.util.Map;
import org.onap.sdc.api.IDistributionClient;
import org.onap.sdc.api.notification.IArtifactInfo;
import org.onap.sdc.api.notification.INotificationData;
import org.onap.sdc.api.notification.IResourceInstance;
import org.onap.sdc.api.results.IDistributionClientDownloadResult;
import org.onap.so.asdc.client.exceptions.ArtifactInstallerException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Abstract class to represent the resource structure.
 *
 * This structure exists to avoid having issues if the order of the resource artifact of tree structure is not good.
 */
public abstract class ResourceStructure {

    /**
     * Flag to indicate whether the resource is deployed successfully.
     */
    protected boolean isDeployedSuccessfully = false;

    /**
     * Flag to indicate whether the resource is already deployed.
     */
    protected boolean isAlreadyDeployed = false;

    /**
     * The resource type.
     */
    protected ResourceType resourceType;

    /**
     * The Raw notification data.
     */
    protected INotificationData notificationData;

    /**
     * The resource we will try to deploy.
     */
    protected IResourceInstance resourceInstance;

    /**
     * Number of resources provided by the resource structure.
     */
    protected int NumberOfResources;

    /**
     * The list of artifacts existing in this resource hashed by UUID.
     */
    protected final Map<String, VfModuleArtifact> artifactsMapByUUID;

    /**
     * The list of workflow artifacts existing in this resource
     */
    protected final Map<String, WorkflowArtifact> workflowArtifactsMapByUUID;

    public ResourceStructure(INotificationData notificationData, IResourceInstance resourceInstance) {
        this.notificationData = notificationData;
        this.resourceInstance = resourceInstance;
        artifactsMapByUUID = new HashMap<>();
        workflowArtifactsMapByUUID = new HashMap<>();
    }

    /**
     * Add artifact to the resource structure.
     *
     * @param distributionClient
     * @param artifactinfo
     * @param clientResult
     * @throws UnsupportedEncodingException
     */
    public abstract void addArtifactToStructure(IDistributionClient distributionClient, IArtifactInfo artifactinfo,
            IDistributionClientDownloadResult clientResult) throws UnsupportedEncodingException;

    public abstract void addWorkflowArtifactToStructure(IArtifactInfo artifactinfo,
            IDistributionClientDownloadResult clientResult) throws UnsupportedEncodingException;

    /**
     * Prepare the resource for installation.
     *
     * @throws ArtifactInstallerException
     */
    public abstract void prepareInstall() throws ArtifactInstallerException;

    public boolean isDeployedSuccessfully() {
        return isDeployedSuccessfully;
    }

    public void setDeployedSuccessfully(boolean deployedSuccessfully) {
        isDeployedSuccessfully = deployedSuccessfully;
    }

    public boolean isAlreadyDeployed() {
        return isAlreadyDeployed;
    }

    public void setAlreadyDeployed(boolean alreadyDeployed) {
        isAlreadyDeployed = alreadyDeployed;
    }

    public ResourceType getResourceType() {
        return resourceType;
    }

    public void setResourceType(ResourceType resourceType) {
        this.resourceType = resourceType;
    }

    public INotificationData getNotification() {
        return notificationData;
    }

    public void setNotification(INotificationData notificationData) {
        this.notificationData = notificationData;
    }

    public IResourceInstance getResourceInstance() {
        return resourceInstance;
    }

    public void setResourceInstance(IResourceInstance resourceInstance) {
        this.resourceInstance = resourceInstance;
    }

    public int getNumberOfResources() {
        return NumberOfResources;
    }

    public void setNumberOfResources(int numberOfResources) {
        NumberOfResources = numberOfResources;
    }

    public Map<String, VfModuleArtifact> getArtifactsMapByUUID() {
        return artifactsMapByUUID;
    }

    public Map<String, WorkflowArtifact> getWorkflowArtifactsMapByUUID() {
        return workflowArtifactsMapByUUID;
    }

}