applications/common/src/main/java/org/onap/policy/pdp/xacml/application/common/operationshistory/GetOperationOutcomePip.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
   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
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  * ============LICENSE_END=========================================================
  17  */
  18
  19 package org.onap.policy.pdp.xacml.application.common.operationshistory;
  20
  21 import com.att.research.xacml.api.XACML3;
  22 import com.att.research.xacml.api.pip.PIPException;
  23 import com.att.research.xacml.api.pip.PIPFinder;
  24 import com.att.research.xacml.api.pip.PIPRequest;
  25 import com.att.research.xacml.api.pip.PIPResponse;
  26 import com.att.research.xacml.std.pip.StdMutablePIPResponse;
  27 import com.att.research.xacml.std.pip.StdPIPResponse;
  28 import com.google.common.base.Strings;
  29 import java.util.Arrays;
  30 import java.util.Collection;
  31 import javax.persistence.NoResultException;
  32 import org.onap.policy.pdp.xacml.application.common.ToscaDictionary;
  33 import org.onap.policy.pdp.xacml.application.common.std.StdOnapPip;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37
  38 public class GetOperationOutcomePip extends StdOnapPip {
  39     public static final String ISSUER_NAME = "get-operation-outcome";
  40     private static Logger logger = LoggerFactory.getLogger(GetOperationOutcomePip.class);
  41
  42     public GetOperationOutcomePip() {
  43         super();
  44         this.issuer = ISSUER_NAME;
  45     }
  46
  47     @Override
  48     public Collection<PIPRequest> attributesRequired() {
  49         return Arrays.asList(PIP_REQUEST_TARGET);
  50     }
  51
  52     /**
  53      * getAttributes.
  54      *
  55      * @param pipRequest the request
  56      * @param pipFinder the pip finder
  57      * @return PIPResponse
  58      */
  59     @Override
  60     public PIPResponse getAttributes(PIPRequest pipRequest, PIPFinder pipFinder) throws PIPException {
  61         logger.debug("getAttributes requesting attribute {} of type {} for issuer {}",
  62                 pipRequest.getAttributeId(), pipRequest.getDataTypeId(), pipRequest.getIssuer());
  63         //
  64         // Determine if the issuer is correct
  65         //
  66         if (Strings.isNullOrEmpty(pipRequest.getIssuer())) {
  67             logger.error("issuer is null - returning empty response");
  68             //
  69             // We only respond to ourself as the issuer
  70             //
  71             return StdPIPResponse.PIP_RESPONSE_EMPTY;
  72         }
  73         if (! pipRequest.getIssuer().startsWith(ToscaDictionary.GUARD_ISSUER_PREFIX)) {
  74             logger.error("Issuer does not start with guard");
  75             //
  76             // We only respond to ourself as the issuer
  77             //
  78             return StdPIPResponse.PIP_RESPONSE_EMPTY;
  79         }
  80         //
  81         // Parse out the issuer which denotes the time window
  82         // Eg: any-prefix:clname:some-controlloop-name
  83         //
  84         String[] s1 = pipRequest.getIssuer().split("clname:");
  85         String clname = s1[1];
  86         String target = null;
  87         target = getAttribute(pipFinder, PIP_REQUEST_TARGET);
  88
  89         logger.debug("Going to query DB about: clname={}, target={}", clname, target);
  90         String outcome = doDatabaseQuery(clname, target);
  91         logger.debug("Query result is: {}", outcome);
  92
  93         StdMutablePIPResponse pipResponse = new StdMutablePIPResponse();
  94         this.addStringAttribute(pipResponse,
  95                 XACML3.ID_ATTRIBUTE_CATEGORY_RESOURCE,
  96                 ToscaDictionary.ID_RESOURCE_GUARD_OPERATIONOUTCOME,
  97                 outcome,
  98                 pipRequest);
  99         return new StdPIPResponse(pipResponse);
 100     }
 101
 102     private String doDatabaseQuery(String clname, String target) {
 103         logger.info("Querying operations history for {} {}", clname, target);
 104         //
 105         // Only can query if we have an EntityManager
 106         //
 107         if (em == null) {
 108             logger.error("No EntityManager available");
 109             return null;
 110         }
 111         //
 112         // Do the query
 113         //
 114         try {
 115             //
 116             // We are expecting a single result
 117             //
 118             return em.createQuery("select e.outcome from Dbao e"
 119                                   + " where e.closedLoopName= ?1"
 120                                   + " and e.target= ?2"
 121                                   + " order by e.endtime desc",
 122                                   String.class)
 123                 .setParameter(1, clname)
 124                 .setParameter(2, target)
 125                 .setMaxResults(1)
 126                 .getSingleResult();
 127         } catch (NoResultException e) {
 128             logger.trace("No results", e);
 129         } catch (Exception e) {
 130             logger.error("Typed query failed", e);
 131         }
 132         return null;
 133     }
 134 }