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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.pap.main.rest;
23 import io.swagger.annotations.ApiOperation;
24 import io.swagger.annotations.ApiParam;
25 import io.swagger.annotations.ApiResponse;
26 import io.swagger.annotations.ApiResponses;
27 import io.swagger.annotations.Authorization;
28 import io.swagger.annotations.Extension;
29 import io.swagger.annotations.ExtensionProperty;
30 import io.swagger.annotations.ResponseHeader;
32 import java.util.UUID;
34 import javax.ws.rs.HeaderParam;
35 import javax.ws.rs.PUT;
36 import javax.ws.rs.Path;
37 import javax.ws.rs.PathParam;
38 import javax.ws.rs.QueryParam;
39 import javax.ws.rs.core.Response;
40 import javax.ws.rs.core.Response.Status;
42 import org.apache.commons.lang3.tuple.Pair;
43 import org.onap.policy.models.base.PfModelException;
44 import org.onap.policy.models.pap.concepts.PdpGroupStateChangeResponse;
45 import org.onap.policy.models.pdp.enums.PdpState;
48 * Class to provide REST end points for PAP component to change state of a PDP group.
50 * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
52 public class PdpGroupStateChangeControllerV1 extends PapRestControllerV1 {
54 private final PdpGroupStateChangeProvider provider = new PdpGroupStateChangeProvider();
57 * Changes state of a PDP group.
59 * @param requestId request ID used in ONAP logging
60 * @param groupName name of the PDP group to be deleted
61 * @param state state of the PDP group
66 @Path("pdps/groups/{name}")
67 @ApiOperation(value = "Change state of a PDP Group",
68 notes = "Changes state of PDP Group, returning optional error details",
69 response = PdpGroupStateChangeResponse.class,
70 tags = {"Policy Administration (PAP) API"},
71 authorizations = @Authorization(value = AUTHORIZATION_TYPE),
73 @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
74 response = String.class),
75 @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
76 response = String.class),
77 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
78 response = String.class),
79 @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
80 response = UUID.class)},
81 extensions = {@Extension(name = EXTENSION_NAME,
82 properties = {@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
83 @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)})})
84 @ApiResponses(value = {@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
85 @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
86 @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)})
89 public Response changeGroupState(
90 @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) final UUID requestId,
91 @ApiParam(value = "PDP Group Name", required = true) @PathParam("name") final String groupName,
92 @ApiParam(value = "PDP Group State", required = true) @QueryParam("state") final PdpState state) {
95 final Pair<Status, PdpGroupStateChangeResponse> pair = provider.changeGroupState(groupName, state);
96 return addLoggingHeaders(addVersionControlHeaders(Response.status(pair.getLeft())), requestId)
97 .entity(pair.getRight()).build();
98 } catch (final PfModelException exp) {
99 return addLoggingHeaders(
100 addVersionControlHeaders(Response.status(exp.getErrorResponse().getResponseCode())), requestId)
101 .entity(exp.getErrorResponse()).build();