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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.pdp.xacml.application.common;
  24
  25 import com.att.research.xacml.api.Request;
  26 import com.att.research.xacml.api.Response;
  27
  28 import java.util.List;
  29 import java.util.Map;
  30
  31 import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
  32
  33 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  34 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  35
  36 public interface ToscaPolicyTranslator {
  37
  38     /**
  39      * Implement this method to translate policies.
  40      *
  41      * @param toscaObject Incoming Tosca Policies object
  42      * @return List of translated policies
  43      * @throws ToscaPolicyConversionException Exception
  44      */
  45     List<PolicyType> scanAndConvertPolicies(Map<String, Object> toscaObject) throws ToscaPolicyConversionException;
  46
  47     /**
  48      * Implement this method to convert an ONAP DecisionRequest into
  49      * a Xacml request.
  50      *
  51      * @param request Incoming DecisionRequest
  52      * @return Xacml Request object
  53      */
  54     Request convertRequest(DecisionRequest request);
  55
  56     /**
  57      * Implement this method to convert a Xacml Response
  58      * into a ONAP DecisionResponse.
  59      *
  60      * @param xacmlResponse Input Xacml Response
  61      * @return DecisionResponse object
  62      */
  63     DecisionResponse convertResponse(Response xacmlResponse);
  64
  65 }