import javax.ws.rs.PathParam;\r
import javax.ws.rs.Produces;\r
import javax.ws.rs.core.Response;\r
-import javax.ws.rs.core.Response.ResponseBuilder;\r
import org.apache.commons.lang3.tuple.Pair;\r
import org.onap.policy.api.main.rest.provider.HealthCheckProvider;\r
import org.onap.policy.api.main.rest.provider.PolicyProvider;\r
import org.onap.policy.common.endpoints.report.HealthCheckReport;\r
import org.onap.policy.common.endpoints.utils.NetLoggerUtil;\r
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;\r
-import org.onap.policy.common.utils.coder.Coder;\r
-import org.onap.policy.common.utils.coder.CoderException;\r
-import org.onap.policy.common.utils.coder.StandardCoder;\r
import org.onap.policy.models.base.PfModelException;\r
import org.onap.policy.models.base.PfModelRuntimeException;\r
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;\r
}),\r
schemes = { SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS },\r
securityDefinition = @SecurityDefinition(basicAuthDefinitions = { @BasicAuthDefinition(key = "basicAuth") }))\r
-public class ApiRestController {\r
+public class ApiRestController extends CommonRestController {\r
\r
private static final Logger LOGGER = LoggerFactory.getLogger(ApiRestController.class);\r
\r
- private final Coder coder = new StandardCoder();\r
-\r
/**\r
* Retrieves the healthcheck status of the API component.\r
*\r
@HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
\r
updateApiStatisticsCounter(Target.OTHER, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new HealthCheckProvider().performHealthCheck()).build();\r
+ return makeOkResponse(requestId, new HealthCheckProvider().performHealthCheck());\r
}\r
\r
/**\r
@HeaderParam("X-ONAP-RequestID") @ApiParam("RequestID for http transaction") UUID requestId) {\r
\r
updateApiStatisticsCounter(Target.OTHER, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(new StatisticsProvider().fetchCurrentStatistics()).build();\r
+\r
+ return makeOkResponse(requestId, new StatisticsProvider().fetchCurrentStatistics());\r
}\r
\r
/**\r
try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(null, null);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("GET /policytypes", pfme);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(policyTypeId, null);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("GET /policytypes/{}", policyTypeId, pfme);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchPolicyTypes(policyTypeId, versionId);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("GET /policytypes/{}/versions/{}", policyTypeId, versionId, pfme);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
ToscaServiceTemplate serviceTemplate = policyTypeProvider.fetchLatestPolicyTypes(policyTypeId);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("GET /policytypes/{}/versions/latest", policyTypeId, pfme);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
ToscaServiceTemplate serviceTemplate = policyTypeProvider.createPolicyType(body);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.SUCCESS, HttpMethod.POST);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("POST /policytypes", pfme);\r
updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.POST);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
\r
try (PolicyTypeProvider policyTypeProvider = new PolicyTypeProvider()) {\r
ToscaServiceTemplate serviceTemplate = policyTypeProvider.deletePolicyType(policyTypeId, versionId);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("DELETE /policytypes/{}/versions/{}", policyTypeId, versionId, pfme);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
ToscaServiceTemplate serviceTemplate =\r
policyProvider.fetchPolicies(policyTypeId, policyTypeVersion, null, null);\r
updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("GET /policytypes/{}/versions/{}/policies", policyTypeId, policyTypeVersion, pfme);\r
updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
ToscaServiceTemplate serviceTemplate = policyProvider\r
.fetchPolicies(policyTypeId, policyTypeVersion, policyId, null);\r
updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("/policytypes/{}/versions/{}/policies/{}", policyTypeId, policyTypeVersion, policyId,\r
pfme);\r
updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
ToscaServiceTemplate serviceTemplate = policyProvider\r
.fetchPolicies(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/{}", policyTypeId,\r
policyTypeVersion, policyId, policyVersion, pfme);\r
updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
ToscaServiceTemplate serviceTemplate =\r
policyProvider.fetchLatestPolicies(policyTypeId, policyTypeVersion, policyId);\r
updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/latest", policyTypeId,\r
policyTypeVersion, policyId, pfme);\r
updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
Map<Pair<String, String>, List<ToscaPolicy>> deployedPolicies = policyProvider\r
.fetchDeployedPolicies(policyTypeId, policyTypeVersion, policyId);\r
updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(deployedPolicies).build();\r
+ return makeOkResponse(requestId, deployedPolicies);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/deployed", policyTypeId,\r
policyTypeVersion, policyId, pfme);\r
updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
ToscaServiceTemplate serviceTemplate = policyProvider\r
.createPolicy(policyTypeId, policyTypeVersion, body);\r
updateApiStatisticsCounter(Target.POLICY, Result.SUCCESS, HttpMethod.POST);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("POST /policytypes/{}/versions/{}/policies", policyTypeId, policyTypeVersion, pfme);\r
updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.POST);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
try (PolicyProvider policyProvider = new PolicyProvider()) {\r
ToscaServiceTemplate serviceTemplate = policyProvider\r
.deletePolicy(policyTypeId, policyTypeVersion, policyId, policyVersion);\r
- return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
- .entity(serviceTemplate).build();\r
+ return makeOkResponse(requestId, serviceTemplate);\r
} catch (PfModelException | PfModelRuntimeException pfme) {\r
LOGGER.error("DELETE /policytypes/{}/versions/{}/policies/{}/versions/{}", policyTypeId,\r
policyTypeVersion, policyId, policyVersion, pfme);\r
- return addLoggingHeaders(addVersionControlHeaders(\r
- Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
- .entity(pfme.getErrorResponse()).build();\r
- }\r
- }\r
-\r
- private ResponseBuilder addVersionControlHeaders(ResponseBuilder rb) {\r
- return rb.header("X-MinorVersion", "0").header("X-PatchVersion", "0").header("X-LatestVersion", "1.0.0");\r
- }\r
-\r
- private ResponseBuilder addLoggingHeaders(ResponseBuilder rb, UUID requestId) {\r
- if (requestId == null) {\r
- // Generate a random uuid if client does not embed requestId in rest request\r
- return rb.header("X-ONAP-RequestID", UUID.randomUUID());\r
- }\r
- return rb.header("X-ONAP-RequestID", requestId);\r
- }\r
-\r
- /**\r
- * Converts an object to a JSON string.\r
- *\r
- * @param object object to convert\r
- * @return a JSON string representing the object\r
- */\r
- private String toJson(Object object) {\r
- if (object == null) {\r
- return null;\r
- }\r
-\r
- try {\r
- return coder.encode(object);\r
-\r
- } catch (CoderException e) {\r
- LOGGER.warn("cannot convert {} to JSON", object.getClass().getName(), e);\r
- return null;\r
+ return makeErrorResponse(requestId, pfme);\r
}\r
}\r
\r
private void updateApiStatisticsCounter(Target target, Result result, HttpMethod http) {\r
\r
ApiStatisticsManager.updateTotalApiCallCount();\r
- if (target == Target.POLICY) {\r
- if (result == Result.SUCCESS) {\r
- if (http == HttpMethod.GET) {\r
- ApiStatisticsManager.updateApiCallSuccessCount();\r
- ApiStatisticsManager.updateTotalPolicyGetCount();\r
- ApiStatisticsManager.updatePolicyGetSuccessCount();\r
- } else if (http == HttpMethod.POST) {\r
- ApiStatisticsManager.updateApiCallSuccessCount();\r
- ApiStatisticsManager.updateTotalPolicyPostCount();\r
- ApiStatisticsManager.updatePolicyPostSuccessCount();\r
- }\r
- } else {\r
- if (http == HttpMethod.GET) {\r
- ApiStatisticsManager.updateApiCallFailureCount();\r
- ApiStatisticsManager.updateTotalPolicyGetCount();\r
- ApiStatisticsManager.updatePolicyGetFailureCount();\r
- } else {\r
- ApiStatisticsManager.updateApiCallFailureCount();\r
- ApiStatisticsManager.updateTotalPolicyPostCount();\r
- ApiStatisticsManager.updatePolicyPostFailureCount();\r
- }\r
+\r
+ switch (target) {\r
+ case POLICY:\r
+ updatePolicyStats(result, http);\r
+ break;\r
+ case POLICY_TYPE:\r
+ updatePolicyTypeStats(result, http);\r
+ break;\r
+ default:\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ break;\r
+ }\r
+ }\r
+\r
+ private void updatePolicyStats(Result result, HttpMethod http) {\r
+ if (result == Result.SUCCESS) {\r
+ if (http == HttpMethod.GET) {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ ApiStatisticsManager.updateTotalPolicyGetCount();\r
+ ApiStatisticsManager.updatePolicyGetSuccessCount();\r
+ } else if (http == HttpMethod.POST) {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ ApiStatisticsManager.updateTotalPolicyPostCount();\r
+ ApiStatisticsManager.updatePolicyPostSuccessCount();\r
}\r
- } else if (target == Target.POLICY_TYPE) {\r
- if (result == Result.SUCCESS) {\r
- if (http == HttpMethod.GET) {\r
- ApiStatisticsManager.updateApiCallSuccessCount();\r
- ApiStatisticsManager.updateTotalPolicyTypeGetCount();\r
- ApiStatisticsManager.updatePolicyTypeGetSuccessCount();\r
- } else if (http == HttpMethod.POST) {\r
- ApiStatisticsManager.updateApiCallSuccessCount();\r
- ApiStatisticsManager.updatePolicyTypePostSuccessCount();\r
- ApiStatisticsManager.updatePolicyTypePostSuccessCount();\r
- }\r
+ } else {\r
+ if (http == HttpMethod.GET) {\r
+ ApiStatisticsManager.updateApiCallFailureCount();\r
+ ApiStatisticsManager.updateTotalPolicyGetCount();\r
+ ApiStatisticsManager.updatePolicyGetFailureCount();\r
} else {\r
- if (http == HttpMethod.GET) {\r
- ApiStatisticsManager.updateApiCallFailureCount();\r
- ApiStatisticsManager.updateTotalPolicyTypeGetCount();\r
- ApiStatisticsManager.updatePolicyTypeGetFailureCount();\r
- } else {\r
- ApiStatisticsManager.updateApiCallFailureCount();\r
- ApiStatisticsManager.updateTotalPolicyTypePostCount();\r
- ApiStatisticsManager.updatePolicyTypePostFailureCount();\r
- }\r
+ ApiStatisticsManager.updateApiCallFailureCount();\r
+ ApiStatisticsManager.updateTotalPolicyPostCount();\r
+ ApiStatisticsManager.updatePolicyPostFailureCount();\r
+ }\r
+ }\r
+ }\r
+\r
+ private void updatePolicyTypeStats(Result result, HttpMethod http) {\r
+ if (result == Result.SUCCESS) {\r
+ if (http == HttpMethod.GET) {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ ApiStatisticsManager.updateTotalPolicyTypeGetCount();\r
+ ApiStatisticsManager.updatePolicyTypeGetSuccessCount();\r
+ } else if (http == HttpMethod.POST) {\r
+ ApiStatisticsManager.updateApiCallSuccessCount();\r
+ ApiStatisticsManager.updatePolicyTypePostSuccessCount();\r
+ ApiStatisticsManager.updatePolicyTypePostSuccessCount();\r
}\r
} else {\r
- ApiStatisticsManager.updateApiCallSuccessCount();\r
+ if (http == HttpMethod.GET) {\r
+ ApiStatisticsManager.updateApiCallFailureCount();\r
+ ApiStatisticsManager.updateTotalPolicyTypeGetCount();\r
+ ApiStatisticsManager.updatePolicyTypeGetFailureCount();\r
+ } else {\r
+ ApiStatisticsManager.updateApiCallFailureCount();\r
+ ApiStatisticsManager.updateTotalPolicyTypePostCount();\r
+ ApiStatisticsManager.updatePolicyTypePostFailureCount();\r
+ }\r
}\r
}\r
}
\ No newline at end of file
Code Review / policy / api.git / blobdiff