1 /* ============LICENSE_START=======================================================
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.pdp.xacml.application.common;
24 import com.att.research.xacml.api.Response;
26 import java.nio.file.Path;
27 import java.util.List;
29 import org.apache.commons.lang3.tuple.Pair;
30 import org.onap.policy.models.decisions.concepts.DecisionRequest;
31 import org.onap.policy.models.decisions.concepts.DecisionResponse;
32 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
33 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
36 * This interface is how the XACML REST controller can communicate
37 * with Policy Type implementation applications.
38 * Applications should register themselves as this service provider
39 * and implement these methods.
41 * @author pameladragosh
44 public interface XacmlApplicationServiceProvider {
47 * Name of the application for auditing and organization of its data.
51 String applicationName();
54 * Returns a list of action decisions supported by the application.
56 * @return List of String (eg. "configure", "placement", "naming")
58 List<String> actionDecisionsSupported();
61 * Initializes the application and gives it a Path for storing its
62 * data. The Path may be already populated with previous data.
64 * @param pathForData Local Path
66 void initialize(Path pathForData) throws XacmlApplicationException;
69 * Returns a list of supported Tosca Policy Types.
71 * @return List of Strings (eg. "onap.policy.foo.bar")
73 List<ToscaPolicyTypeIdentifier> supportedPolicyTypes();
76 * Asks whether the application can support the incoming
77 * Tosca Policy Type and version.
79 * @param toscaPolicyId Identifier for policy type
80 * @return true if supported
82 boolean canSupportPolicyType(ToscaPolicyTypeIdentifier toscaPolicyId);
85 * Load a Tosca Policy.
87 * @param toscaPolicy object
89 boolean loadPolicy(ToscaPolicy toscaPolicy) throws XacmlApplicationException;
92 * unloadPolicy a Tosca Policy.
94 * @param toscaPolicy object
96 boolean unloadPolicy(ToscaPolicy toscaPolicy) throws XacmlApplicationException;
99 * Makes a decision given the incoming request and returns a response.
101 * @param request Incoming DecisionRequest object
102 * @return response Responding DecisionResponse object
104 Pair<DecisionResponse, Response> makeDecision(DecisionRequest request);