rulemgt/src/main/java/org/onap/holmes/rulemgt/resources/RuleMgtResources.java

   1 /**\r
   2  * Copyright 2017 ZTE Corporation.\r
   3  *\r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 package org.onap.holmes.rulemgt.resources;\r
  17 \r
  18 import com.codahale.metrics.annotation.Timed;\r
  19 import io.swagger.annotations.Api;\r
  20 import io.swagger.annotations.ApiOperation;\r
  21 import io.swagger.annotations.ApiParam;\r
  22 import io.swagger.annotations.SwaggerDefinition;\r
  23 import java.io.IOException;\r
  24 import java.util.Locale;\r
  25 import javax.inject.Inject;\r
  26 import javax.servlet.http.HttpServletRequest;\r
  27 import javax.ws.rs.DELETE;\r
  28 import javax.ws.rs.GET;\r
  29 import javax.ws.rs.POST;\r
  30 import javax.ws.rs.PUT;\r
  31 import javax.ws.rs.Path;\r
  32 import javax.ws.rs.PathParam;\r
  33 import javax.ws.rs.Produces;\r
  34 import javax.ws.rs.QueryParam;\r
  35 import javax.ws.rs.core.Context;\r
  36 import javax.ws.rs.core.MediaType;\r
  37 import lombok.extern.slf4j.Slf4j;\r
  38 import net.sf.json.JSONObject;\r
  39 import org.jvnet.hk2.annotations.Service;\r
  40 import org.onap.holmes.common.exception.CorrelationException;\r
  41 import org.onap.holmes.common.utils.ExceptionUtil;\r
  42 import org.onap.holmes.common.utils.JacksonUtil;\r
  43 import org.onap.holmes.common.utils.LanguageUtil;\r
  44 import org.onap.holmes.common.utils.UserUtil;\r
  45 import org.onap.holmes.rulemgt.bean.request.RuleCreateRequest;\r
  46 import org.onap.holmes.rulemgt.bean.request.RuleDeleteRequest;\r
  47 import org.onap.holmes.rulemgt.bean.request.RuleQueryCondition;\r
  48 import org.onap.holmes.rulemgt.bean.request.RuleUpdateRequest;\r
  49 import org.onap.holmes.rulemgt.bean.response.RuleAddAndUpdateResponse;\r
  50 import org.onap.holmes.rulemgt.bean.response.RuleQueryListResponse;\r
  51 import org.onap.holmes.rulemgt.constant.RuleMgtConstant;\r
  52 import org.onap.holmes.rulemgt.wrapper.RuleMgtWrapper;\r
  53 \r
  54 @Service\r
  55 @SwaggerDefinition\r
  56 @Path("/rule")\r
  57 @Api(tags = {"Holmes Rule Management"})\r
  58 @Produces(MediaType.APPLICATION_JSON)\r
  59 @Slf4j\r
  60 public class RuleMgtResources {\r
  61 \r
  62     @Inject\r
  63     private RuleMgtWrapper ruleMgtWrapper;\r
  64 \r
  65     @PUT\r
  66     @Produces(MediaType.APPLICATION_JSON)\r
  67     @ApiOperation(value = "Save a rule into the database; deploy it to the Drools engine if it is enabled.",\r
  68             response = RuleAddAndUpdateResponse.class)\r
  69     @Timed\r
  70     public RuleAddAndUpdateResponse addCorrelationRule(@Context HttpServletRequest request,\r
  71             @ApiParam(value = "The request entity of the HTTP call, which comprises \"rulename\"(required), "\r
  72                     + "\"content\"(required), \"enabled\"(required) and \"description\"(optional)", required = true)\r
  73                     RuleCreateRequest ruleCreateRequest) {\r
  74         Locale locale = LanguageUtil.getLocale(request);\r
  75         RuleAddAndUpdateResponse ruleChangeResponse;\r
  76         try {\r
  77             ruleChangeResponse = ruleMgtWrapper\r
  78                     .addCorrelationRule(UserUtil.getUserName(request), ruleCreateRequest);\r
  79             log.info("create rule:" + ruleCreateRequest.getRuleName() + " success.");\r
  80             return ruleChangeResponse;\r
  81         } catch (CorrelationException e) {\r
  82             log.error("create rule:" + ruleCreateRequest.getRuleName() + " failed", e);\r
  83             throw ExceptionUtil.buildExceptionResponse(e.getMessage());\r
  84         }\r
  85     }\r
  86 \r
  87     @POST\r
  88     @Produces(MediaType.APPLICATION_JSON)\r
  89     @ApiOperation(value = "Update an existing rule; deploy it to the Drools engine if it is enabled.", response = RuleAddAndUpdateResponse.class)\r
  90     @Timed\r
  91     public RuleAddAndUpdateResponse updateCorrelationRule(@Context HttpServletRequest request,\r
  92             @ApiParam(value = "The request entity of the HTTP call, which comprises \"ruleid\"(required), "\r
  93                     + "\"content\"(required), \"enabled\"(required) and \"description\"(optional)", required = true)\r
  94                     RuleUpdateRequest ruleUpdateRequest) {\r
  95         Locale locale = LanguageUtil.getLocale(request);\r
  96         RuleAddAndUpdateResponse ruleChangeResponse;\r
  97         try {\r
  98             ruleChangeResponse = ruleMgtWrapper.updateCorrelationRule(UserUtil.getUserName(request), ruleUpdateRequest);\r
  99             log.info("update rule:" + ruleUpdateRequest.getRuleId() + " successful");\r
 100             return ruleChangeResponse;\r
 101         } catch (CorrelationException e) {\r
 102             log.error("update rule:" + ruleUpdateRequest.getContent() + " failed", e);\r
 103             throw ExceptionUtil.buildExceptionResponse(e.getMessage());\r
 104         }\r
 105     }\r
 106 \r
 107     @DELETE\r
 108     @Produces(MediaType.APPLICATION_JSON)\r
 109     @ApiOperation(value = "Remove a rule from Holmes.")\r
 110     @Timed\r
 111     @Path("/{ruleid}")\r
 112     public boolean deleteCorrelationRule(@Context HttpServletRequest request,\r
 113             @PathParam("ruleid") String ruleId) {\r
 114         Locale locale = LanguageUtil.getLocale(request);\r
 115         try {\r
 116             ruleMgtWrapper.deleteCorrelationRule(new RuleDeleteRequest(ruleId));\r
 117             log.info("delete rule:" + ruleId + " successful");\r
 118             return true;\r
 119         } catch (CorrelationException e) {\r
 120             log.error("delete rule:" + ruleId + " failed", e);\r
 121             throw ExceptionUtil.buildExceptionResponse(e.getMessage());\r
 122         }\r
 123     }\r
 124 \r
 125     @GET\r
 126     @Produces(MediaType.APPLICATION_JSON)\r
 127     @ApiOperation(value = "Query rules using certain criteria.", response = RuleQueryListResponse.class)\r
 128     @Timed\r
 129     public RuleQueryListResponse getCorrelationRules(@Context HttpServletRequest request,\r
 130             @ApiParam(value = "A JSON string used as a query parameter, which comprises \"ruleid\"(optional), "\r
 131                     + "\"rulename\"(optional), \"creator\"(optional), "\r
 132                     + "\"modifier\"(optional) and \"enabled\"(optional). E.g. {\"ruleid\":\"rule_1484727187317\"}",\r
 133                     required = false) @QueryParam("queryrequest") String ruleQueryRequest) {\r
 134         Locale locale = LanguageUtil.getLocale(request);\r
 135         RuleQueryListResponse ruleQueryListResponse;\r
 136         RuleQueryCondition ruleQueryCondition = getRuleQueryCondition(ruleQueryRequest, request);\r
 137         try {\r
 138             ruleQueryListResponse = ruleMgtWrapper\r
 139                     .getCorrelationRuleByCondition(ruleQueryCondition);\r
 140             log.info("query rule successful by condition:" + JSONObject.fromObject(ruleQueryCondition));\r
 141             return ruleQueryListResponse;\r
 142         } catch (CorrelationException e) {\r
 143             log.error("query rule failed,cause query condition conversion failure", e);\r
 144             throw ExceptionUtil.buildExceptionResponse(e.getMessage());\r
 145         }\r
 146     }\r
 147 \r
 148     private RuleQueryCondition getRuleQueryCondition(String queryRequest,\r
 149             HttpServletRequest request) {\r
 150         Locale locale = LanguageUtil.getLocale(request);\r
 151         try {\r
 152             RuleQueryCondition ruleQueryCondition = JacksonUtil\r
 153                     .jsonToBean(queryRequest, RuleQueryCondition.class);\r
 154             if (queryRequest == null) {\r
 155                 ruleQueryCondition.setEnabled(RuleMgtConstant.STATUS_RULE_ALL);\r
 156             } else if (queryRequest.indexOf("enabled") == -1) {\r
 157                 ruleQueryCondition.setEnabled(RuleMgtConstant.STATUS_RULE_ALL);\r
 158             }\r
 159             return ruleQueryCondition;\r
 160         } catch (IOException e) {\r
 161             log.warn("queryRequest convert to json failed", e);\r
 162             throw ExceptionUtil.buildExceptionResponse("The request format is invalid!");\r
 163         }\r
 164     }\r
 165 }\r