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                     + "\"loopcontrolname\"(required), \"content\"(required), \"enabled\"(required) "\r
  73                     + "and \"description\"(optional)", required = true)\r
  74                     RuleCreateRequest ruleCreateRequest) {\r
  75         Locale locale = LanguageUtil.getLocale(request);\r
  76         RuleAddAndUpdateResponse ruleChangeResponse;\r
  77         try {\r
  78             ruleChangeResponse = ruleMgtWrapper\r
  79                     .addCorrelationRule(UserUtil.getUserName(request), ruleCreateRequest);\r
  80             log.info("create rule:" + ruleCreateRequest.getRuleName() + " success.");\r
  81             return ruleChangeResponse;\r
  82         } catch (CorrelationException e) {\r
  83             log.error("create rule:" + ruleCreateRequest.getRuleName() + " failed", e);\r
  84             throw ExceptionUtil.buildExceptionResponse(e.getMessage());\r
  85         }\r
  86     }\r
  87 \r
  88     @POST\r
  89     @Produces(MediaType.APPLICATION_JSON)\r
  90     @ApiOperation(value = "Update an existing rule; deploy it to the Drools engine if it is enabled.", response = RuleAddAndUpdateResponse.class)\r
  91     @Timed\r
  92     public RuleAddAndUpdateResponse updateCorrelationRule(@Context HttpServletRequest request,\r
  93             @ApiParam(value = "The request entity of the HTTP call, which comprises \"ruleid\"(required), "\r
  94                     + "\"content\"(required), \"enabled\"(required) and \"description\"(optional)", required = true)\r
  95                     RuleUpdateRequest ruleUpdateRequest) {\r
  96         Locale locale = LanguageUtil.getLocale(request);\r
  97         RuleAddAndUpdateResponse ruleChangeResponse;\r
  98         try {\r
  99             ruleChangeResponse = ruleMgtWrapper.updateCorrelationRule(UserUtil.getUserName(request), ruleUpdateRequest);\r
 100             log.info("update rule:" + ruleUpdateRequest.getRuleId() + " successful");\r
 101             return ruleChangeResponse;\r
 102         } catch (CorrelationException e) {\r
 103             log.error("update rule:" + ruleUpdateRequest.getContent() + " failed", e);\r
 104             throw ExceptionUtil.buildExceptionResponse(e.getMessage());\r
 105         }\r
 106     }\r
 107 \r
 108     @DELETE\r
 109     @Produces(MediaType.APPLICATION_JSON)\r
 110     @ApiOperation(value = "Remove a rule from Holmes.")\r
 111     @Timed\r
 112     @Path("/{ruleid}")\r
 113     public boolean deleteCorrelationRule(@Context HttpServletRequest request,\r
 114             @PathParam("ruleid") String ruleId) {\r
 115         Locale locale = LanguageUtil.getLocale(request);\r
 116         try {\r
 117             ruleMgtWrapper.deleteCorrelationRule(new RuleDeleteRequest(ruleId));\r
 118             log.info("delete rule:" + ruleId + " successful");\r
 119             return true;\r
 120         } catch (CorrelationException e) {\r
 121             log.error("delete rule:" + ruleId + " failed", e);\r
 122             throw ExceptionUtil.buildExceptionResponse(e.getMessage());\r
 123         }\r
 124     }\r
 125 \r
 126     @GET\r
 127     @Produces(MediaType.APPLICATION_JSON)\r
 128     @ApiOperation(value = "Query rules using certain criteria.", response = RuleQueryListResponse.class)\r
 129     @Timed\r
 130     public RuleQueryListResponse getCorrelationRules(@Context HttpServletRequest request,\r
 131             @ApiParam(value = "A JSON string used as a query parameter, which comprises \"ruleid\"(optional), "\r
 132                     + "\"rulename\"(optional), \"creator\"(optional), "\r
 133                     + "\"modifier\"(optional) and \"enabled\"(optional). E.g. {\"ruleid\":\"rule_1484727187317\"}",\r
 134                     required = false) @QueryParam("queryrequest") String ruleQueryRequest) {\r
 135         Locale locale = LanguageUtil.getLocale(request);\r
 136         RuleQueryListResponse ruleQueryListResponse;\r
 137         RuleQueryCondition ruleQueryCondition = getRuleQueryCondition(ruleQueryRequest, request);\r
 138         try {\r
 139             ruleQueryListResponse = ruleMgtWrapper\r
 140                     .getCorrelationRuleByCondition(ruleQueryCondition);\r
 141             log.info("query rule successful by condition:" + JSONObject.fromObject(ruleQueryCondition));\r
 142             return ruleQueryListResponse;\r
 143         } catch (CorrelationException e) {\r
 144             log.error("query rule failed,cause query condition conversion failure", e);\r
 145             throw ExceptionUtil.buildExceptionResponse(e.getMessage());\r
 146         }\r
 147     }\r
 148 \r
 149     private RuleQueryCondition getRuleQueryCondition(String queryRequest,\r
 150             HttpServletRequest request) {\r
 151         Locale locale = LanguageUtil.getLocale(request);\r
 152         try {\r
 153             RuleQueryCondition ruleQueryCondition = JacksonUtil\r
 154                     .jsonToBean(queryRequest, RuleQueryCondition.class);\r
 155             if (queryRequest == null) {\r
 156                 ruleQueryCondition.setEnabled(RuleMgtConstant.STATUS_RULE_ALL);\r
 157             } else if (queryRequest.indexOf("enabled") == -1) {\r
 158                 ruleQueryCondition.setEnabled(RuleMgtConstant.STATUS_RULE_ALL);\r
 159             }\r
 160             return ruleQueryCondition;\r
 161         } catch (IOException e) {\r
 162             log.warn("queryRequest convert to json failed", e);\r
 163             throw ExceptionUtil.buildExceptionResponse("The request format is invalid!");\r
 164         }\r
 165     }\r
 166 }\r