2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019 Nordix Foundation.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
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;
31 import java.util.UUID;
32 import javax.ws.rs.HeaderParam;
33 import javax.ws.rs.POST;
34 import javax.ws.rs.Path;
35 import javax.ws.rs.core.Response;
36 import javax.ws.rs.core.Response.Status;
37 import org.onap.policy.models.base.PfModelException;
38 import org.onap.policy.models.base.PfModelRuntimeException;
39 import org.onap.policy.models.pap.concepts.PdpGroupUpdateResponse;
40 import org.onap.policy.models.pdp.concepts.PdpGroups;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
45 * Class to provide REST end points for PAP component to create or update PDP groups.
47 public class PdpGroupCreateOrUpdateControllerV1 extends PapRestControllerV1 {
48 private static final Logger logger = LoggerFactory.getLogger(PdpGroupCreateOrUpdateControllerV1.class);
50 private final PdpGroupCreateOrUpdateProvider provider = new PdpGroupCreateOrUpdateProvider();
53 * Creates or updates one or more PDP groups.
55 * @param requestId request ID used in ONAP logging
56 * @param groups PDP group configuration
61 @Path("pdps/groups/batch")
62 @ApiOperation(value = "Create or update PDP Groups",
63 notes = "Create or update one or more PDP Groups, returning optional error details",
64 response = PdpGroupUpdateResponse.class,
65 tags = {"Policy Administration (PAP) API"},
66 authorizations = @Authorization(value = AUTHORIZATION_TYPE),
68 @ResponseHeader(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
69 response = String.class),
70 @ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
71 response = String.class),
72 @ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
73 response = String.class),
74 @ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
75 response = UUID.class)},
76 extensions = {@Extension(name = EXTENSION_NAME,
77 properties = {@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
78 @ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)})})
79 @ApiResponses(value = {@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
80 @ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
81 @ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)})
84 public Response createOrUpdateGroups(
85 @HeaderParam(REQUEST_ID_NAME) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
86 @ApiParam(value = "List of PDP Group Configuration", required = true) PdpGroups groups) {
88 return doOperation(requestId, "create groups failed", () -> provider.createOrUpdateGroups(groups));
92 * Invokes an operation.
94 * @param requestId request ID
95 * @param errmsg error message to log if the operation throws an exception
96 * @param runnable operation to invoke
97 * @return a {@link PdpGroupUpdateResponse} response entity
99 private Response doOperation(UUID requestId, String errmsg, RunnableWithPfEx runnable) {
102 return addLoggingHeaders(addVersionControlHeaders(Response.status(Status.OK)), requestId)
103 .entity(new PdpGroupUpdateResponse()).build();
105 } catch (PfModelException | PfModelRuntimeException e) {
106 logger.warn(errmsg, e);
107 PdpGroupUpdateResponse resp = new PdpGroupUpdateResponse();
108 resp.setErrorDetails(e.getErrorResponse().getErrorMessage());
109 return addLoggingHeaders(addVersionControlHeaders(Response.status(e.getErrorResponse().getResponseCode())),
110 requestId).entity(resp).build();