aboutsummaryrefslogtreecommitdiffstats
path: root/adapters/mso-vnfm-adapter/mso-vnfm-etsi-adapter/src/main/java/org/onap/so/adapters/vnfmadapter/jobmanagement/VnfmOperation.java
blob: e0ad327bd371ccfaa853c5ad4cd3aab6d64b24b0 (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
/*-
 * ============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.adapters.vnfmadapter.jobmanagement;

/**
 * Represents an operation on a VNFM.
 */
public class VnfmOperation {

    private final String vnfmId;
    private final String operationId;
    private NotificationStatus notificationStatus;

    public VnfmOperation(final String vnfmId, final String operationId, final boolean waitForNotificationForSuccess) {
        this.vnfmId = vnfmId;
        this.operationId = operationId;
        this.notificationStatus = waitForNotificationForSuccess ? NotificationStatus.NOTIFICATION_PROCESSING_PENDING
                : NotificationStatus.NOTIFICATION_PROCESSING_NOT_REQUIRED;
    }

    /**
     * Get the ID of the operation on the VNFM.
     *
     * @return the ID of the operation on the VNFM
     */
    public String getOperationId() {
        return operationId;
    }

    /**
     * Get the ID of the VNFM the operation is carried out by.
     *
     * @return the ID of the VNFM
     */
    public String getVnfmId() {
        return vnfmId;
    }

    /**
     * Set the required notification has been processed for the operation.
     *
     * @param notificationProcessingWasSuccessful <code>true</code> if the notification processing was
     *        successful, <code>false<code> otherwise
     */
    public void setNotificationProcessed(final boolean notificationProcessingWasSuccessful) {
        this.notificationStatus =
                notificationProcessingWasSuccessful ? NotificationStatus.NOTIFICATION_PROCEESING_SUCCESSFUL
                        : NotificationStatus.NOTIFICATION_PROCESSING_FAILED;
    }

    /**
     * Get the notification status for the operation.
     *
     * @return the notification status
     */
    public NotificationStatus getNotificationStatus() {
        return notificationStatus;
    }

    public enum NotificationStatus {
        /**
         * No notification handling is required to determine the status of the operation
         */
        NOTIFICATION_PROCESSING_NOT_REQUIRED,
        /**
         * A notification must be processed before the notification can be considered to be completed
         */
        NOTIFICATION_PROCESSING_PENDING,
        /**
         * A notification has been successfully handled for the operation
         */
        NOTIFICATION_PROCEESING_SUCCESSFUL,
        /**
         * An error occurred processing a notification for the operation
         */
        NOTIFICATION_PROCESSING_FAILED;
    }

}