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