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