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
  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 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
  31
  32 /**
  33  * This interface is how the XACML REST controller can communicate
  34  * with Policy Type implementation applications.
  35  * Applications should register themselves as this service provider
  36  * and implement these methods.
  37  *
  38  * @author pameladragosh
  39  *
  40  */
  41 public interface XacmlApplicationServiceProvider {
  42
  43     /**
  44      * Name of the application for auditing and organization of its data.
  45      *
  46      * @return String
  47      */
  48     String           applicationName();
  49
  50     /**
  51      * Returns a list of action decisions supported by the application.
  52      *
  53      * @return List of String (eg. "configure", "placement", "naming")
  54      */
  55     List<String>     actionDecisionsSupported();
  56
  57     /**
  58      * Initializes the application and gives it a Path for storing its
  59      * data. The Path may be already populated with previous data.
  60      *
  61      * @param pathForData Local Path
  62      */
  63     void             initialize(Path pathForData) throws XacmlApplicationException;
  64
  65     /**
  66      * Returns a list of supported Tosca Policy Types.
  67      *
  68      * @return List of Strings (eg. "onap.policy.foo.bar")
  69      */
  70     List<ToscaPolicyTypeIdentifier>     supportedPolicyTypes();
  71
  72     /**
  73      * Asks whether the application can support the incoming
  74      * Tosca Policy Type and version.
  75      *
  76      * @param toscaPolicyId Identifier for policy type
  77      * @return true if supported
  78      */
  79     boolean          canSupportPolicyType(ToscaPolicyTypeIdentifier toscaPolicyId);
  80
  81     /**
  82      * Load a Tosca Policy.
  83      *
  84      * @param toscaPolicy object
  85      */
  86     boolean          loadPolicy(ToscaPolicy toscaPolicy) throws XacmlApplicationException;
  87
  88     /**
  89      * unloadPolicy a Tosca Policy.
  90      *
  91      * @param toscaPolicy object
  92      */
  93     boolean          unloadPolicy(ToscaPolicy toscaPolicy) throws XacmlApplicationException;
  94
  95     /**
  96      * Makes a decision given the incoming request and returns a response.
  97      *
  98      * @param request Incoming DecisionRequest object
  99      * @return response Responding DecisionResponse object
 100      */
 101     DecisionResponse       makeDecision(DecisionRequest request);
 102
 103 }