main/src/main/java/org/onap/policy/pap/main/rest/PdpGroupDeleteProvider.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * ONAP PAP
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.pap.main.rest;
  22
  23 import javax.ws.rs.core.Response;
  24 import org.apache.commons.lang3.tuple.Pair;
  25 import org.onap.policy.models.pap.concepts.PdpGroupDeleteResponse;
  26
  27 /**
  28  * Provider for PAP component to delete PDP groups.
  29  */
  30 public class PdpGroupDeleteProvider {
  31
  32     /**
  33      * Deletes a PDP group.
  34      *
  35      * @param groupName name of the PDP group to be deleted
  36      * @param version group version to delete; may be {@code null} if the group has only
  37      *        one version
  38      * @return a pair containing the status and the response
  39      */
  40     public Pair<Response.Status, PdpGroupDeleteResponse> delete(String groupName, String version) {
  41
  42         /*
  43          * TODO Lock for updates - return error if already locked.
  44          */
  45
  46         /*
  47          * TODO Make updates - sending initial messages to PDPs and arranging for
  48          * listeners to complete the deletion actions (in the background). The final step
  49          * for the listener is to unlock.
  50          */
  51
  52         /*
  53          * TODO Return error if unable to send updates to all PDPs.
  54          */
  55
  56         return Pair.of(Response.Status.OK, new PdpGroupDeleteResponse());
  57     }
  58 }