aboutsummaryrefslogtreecommitdiffstats
path: root/so-etsi-sol003-adapter-lcm/so-etsi-sol003-adapter-lcm-service/src/main/java/org/onap/so/adapters/etsisol003adapter/lcm/extclients/vnfm/VnfmServiceProvider.java
blob: 863fd5f780c704846c27fe8200e85f9cbcb5f253 (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
/*-
 * ============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.etsisol003adapter.lcm.extclients.vnfm;

import org.onap.aai.domain.yang.EsrVnfm;
import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.CreateVnfRequest;
import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.InlineResponse200;
import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.InlineResponse2001;
import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.InlineResponse201;
import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.InstantiateVnfRequest;
import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.LccnSubscriptionRequest;
import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.TerminateVnfRequest;
import com.google.common.base.Optional;

/**
 * Provides methods for invoking REST calls to a VNFM.
 */
public interface VnfmServiceProvider {

    /**
     * Invoke a get request for a VNF.
     *
     * @param vnfm the VNFM in AAI
     * @param vnfSelfLink the link to the VNF in the VNFM
     * @return the VNF from the VNFM
     */
    Optional<InlineResponse201> getVnf(final EsrVnfm vnfm, final String vnfSelfLink);

    /**
     * Invoke an instantiate request for a VNF.
     *
     * @param vnfm the VNFM in AAI
     * @param vnfSelfLink the link to he VNF on the VNFM
     * @param instantiateVnfRequest the instantiate request
     * @return the operation ID of the instantiation operation
     */
    String instantiateVnf(final EsrVnfm vnfm, final String vnfSelfLink,
                          final InstantiateVnfRequest instantiateVnfRequest);

    /**
     * Invoke a notification subscription request to a VNFM.
     *
     * @param vnfm the VNFM in AAI
     * @param subscriptionRequest
     * @return the response to the subscription request
     */
    InlineResponse2001 subscribeForNotifications(final EsrVnfm vnfm, final LccnSubscriptionRequest subscriptionRequest);

    /**
     * Invoke a terminate request for a VNF.
     *
     * @param vnfm the VNFM in AAI
     * @param vnfSelfLink the link to he VNF on the VNFM
     * @param terminateVnfRequest the terminate request
     * @return the operation ID of the termination operation
     */
    String terminateVnf(final EsrVnfm vnfm, final String vnfSelfLink, final TerminateVnfRequest terminateVnfRequest);

    /**
     * Invoke a delete request for a VNF.
     *
     * @param vnfm the VNFM in AAI
     * @param vnfSelfLink the link to he VNF on the VNFM
     * @return the operation ID of the instantiation operation
     */
    void deleteVnf(final EsrVnfm vnfm, final String vnfSelfLink);

    /**
     * Invoke a get request for a VNFM operation.
     *
     * @param vnfm the VNFM in AAI
     * @param operationId the id of the operation on the VNFM
     * @return the operation from the VNFM
     */
    Optional<InlineResponse200> getOperation(final EsrVnfm vnfm, final String operationId);

    /**
     * Invoke a create request to a VNFM
     *
     * @param vnfm the VNFM in AAI
     * @param createVnfRequest the parameters for creating a VNF
     * @return the newly created VNF
     */
    Optional<InlineResponse201> createVnf(final EsrVnfm vnfm, final CreateVnfRequest createVnfRequest);

}