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-2020 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 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  28 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  29 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  30
  31 public interface ToscaPolicyTranslator {
  32
  33     /**
  34      * Implement this method to translate policies.
  35      *
  36      * @param toscaPolicy Incoming Tosca Policy object
  37      * @return Xacml PolicyType or PolicySetType object
  38      * @throws ToscaPolicyConversionException Exception
  39      */
  40     Object convertPolicy(ToscaPolicy toscaPolicy) throws ToscaPolicyConversionException;
  41
  42     /**
  43      * Implement this method to convert an ONAP DecisionRequest into
  44      * a Xacml request.
  45      *
  46      * @param request Incoming DecisionRequest
  47      * @return Xacml Request object
  48      */
  49     Request convertRequest(DecisionRequest request) throws ToscaPolicyConversionException;
  50
  51     /**
  52      * Implement this method to convert a Xacml Response
  53      * into a ONAP DecisionResponse.
  54      *
  55      * @param xacmlResponse Input Xacml Response
  56      * @return DecisionResponse object
  57      */
  58     DecisionResponse convertResponse(Response xacmlResponse);
  59
  60 }