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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.pap.main.rest;
  22
  23 import javax.ws.rs.core.Response;
  24
  25 import org.apache.commons.lang3.tuple.Pair;
  26 import org.onap.policy.models.pap.concepts.PdpGroupStateChangeResponse;
  27 import org.onap.policy.pdp.common.enums.PdpState;
  28
  29 /**
  30  * Provider for PAP component to change state of PDP group.
  31  *
  32  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  33  */
  34 public class PdpGroupStateChangeProvider {
  35
  36     /**
  37      * Changes state of a PDP group.
  38      *
  39      * @param groupName name of the PDP group
  40      * @param version version of the PDP group
  41      * @param pdpGroupState state of the PDP group
  42      * @return a pair containing the status and the response
  43      */
  44     public Pair<Response.Status, PdpGroupStateChangeResponse> changeGroupState(final String groupName,
  45             final String version, final PdpState pdpGroupState) {
  46
  47         /*
  48          * TODO Check preconditions - return error if any.
  49          */
  50
  51         /*
  52          * TODO Change state - sending state change messages to PDPs and arranging for listeners to complete the state
  53          * change actions (in the background).
  54          */
  55
  56         /*
  57          * TODO Return error if unable to send state change to all PDPs.
  58          */
  59
  60         return Pair.of(Response.Status.OK, new PdpGroupStateChangeResponse());
  61     }
  62 }