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

   1 /* ============LICENSE_START=======================================================
   2  * ONAP
   3  * ================================================================================
   4  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.pdp.xacml.application.common;
  23
  24 import java.nio.file.Path;
  25 import java.util.List;
  26 import java.util.Map;
  27
  28 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  29 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  30
  31 /**
  32  * This interface is how the XACML REST controller can communicate
  33  * with Policy Type implementation applications.
  34  * Applications should register themselves as this service provider
  35  * and implement these methods.
  36  *
  37  * @author pameladragosh
  38  *
  39  */
  40 public interface XacmlApplicationServiceProvider {
  41
  42     /**
  43      * Name of the application for auditing and organization of its data.
  44      *
  45      * @return String
  46      */
  47     String           applicationName();
  48
  49     /**
  50      * Returns a list of action decisions supported by the application.
  51      *
  52      * @return List of String (eg. "configure", "placement", "naming")
  53      */
  54     List<String>     actionDecisionsSupported();
  55
  56     /**
  57      * Initializes the application and gives it a Path for storing its
  58      * data. The Path may be already populated with previous data.
  59      *
  60      * @param pathForData Local Path
  61      */
  62     void             initialize(Path pathForData);
  63
  64     /**
  65      * Returns a list of supported Tosca Policy Types.
  66      *
  67      * @return List of Strings (eg. "onap.policy.foo.bar")
  68      */
  69     List<String>     supportedPolicyTypes();
  70
  71     /**
  72      * Asks whether the application can support the incoming
  73      * Tosca Policy Type and version.
  74      *
  75      * @param policyType String Tosca Policy Type
  76      * @param policyTypeVersion String of the Tosca Policy Type version
  77      * @return true if supported
  78      */
  79     boolean          canSupportPolicyType(String policyType, String policyTypeVersion);
  80
  81     /**
  82      * Load a Map representation of a Tosca Policy.
  83      *
  84      * @param toscaPolicies Map of Tosca Policy Objects
  85      */
  86     void             loadPolicies(Map<String, Object> toscaPolicies);
  87
  88     /**
  89      * Makes a decision given the incoming request and returns a response.
  90      *
  91      * @param request Incoming DecisionRequest object
  92      * @return response Responding DecisionResponse object
  93      */
  94     DecisionResponse       makeDecision(DecisionRequest request);
  95
  96 }