aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeleteProvider.java
blob: 2a1d240dc8d67b57ba25f968f3b54e2eaf9f7ec9 (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
/*
 * ============LICENSE_START=======================================================
 * ONAP PAP
 * ================================================================================
 * Copyright (C) 2019 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.onap.policy.pap.main.rest;

import javax.ws.rs.core.Response;
import org.apache.commons.lang3.tuple.Pair;
import org.onap.policy.models.pap.concepts.PdpGroupDeleteResponse;

/**
 * Provider for PAP component to delete PDP groups.
 */
public class PdpGroupDeleteProvider {

    /**
     * Deletes a PDP group.
     *
     * @param groupName name of the PDP group to be deleted
     * @param version group version to delete; may be {@code null} if the group has only
     *        one version
     * @return a pair containing the status and the response
     */
    public Pair<Response.Status, PdpGroupDeleteResponse> deleteGroup(String groupName, String version) {

        /*
         * TODO Lock for updates - return error if already locked.
         */

        /*
         * TODO Make updates - sending initial messages to PDPs and arranging for
         * listeners to complete the deletion actions (in the background). The final step
         * for the listener is to unlock.
         */

        /*
         * TODO Return error if unable to send updates to all PDPs.
         */

        return Pair.of(Response.Status.OK, new PdpGroupDeleteResponse());
    }

    /**
     * Deletes a PDP policy.
     *
     * @param policyId id of the policy to be deleted
     * @param version policy version to delete; may be {@code null} if the policy has only
     *        one version
     * @return a pair containing the status and the response
     */
    public Pair<Response.Status, PdpGroupDeleteResponse> deletePolicy(String policyId, String version) {

        /*
         * TODO Lock for updates - return error if already locked.
         */

        /*
         * TODO Make updates - sending initial messages to PDPs and arranging for
         * listeners to complete the deletion actions (in the background). The final step
         * for the listener is to unlock.
         */

        /*
         * TODO Return error if unable to send updates to all PDPs.
         */

        return Pair.of(Response.Status.OK, new PdpGroupDeleteResponse());
    }
}