aboutsummaryrefslogtreecommitdiffstats
path: root/PolicyEngineAPI/src/main/java/org/onap/policy/api/DecisionRequestParameters.java
blob: a95063ed94800cd65b42699d70b7b054f6b8f4cf (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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*-
 * ============LICENSE_START=======================================================
 * PolicyEngineAPI
 * ================================================================================
 * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.api;

import com.google.gson.Gson;
import java.util.Map;
import java.util.UUID;

/**
 * <code>DecisionRequestParameters</code> defines the Decision Policy Request Parameters which retrieve(s) the response
 * from PDP if the request parameters match with any Decision Policy.
 *
 * @version 0.1
 */
public class DecisionRequestParameters {
    private static final Gson GSON = new Gson();
    private String onapName;
    private Map<String, String> decisionAttributes;
    private UUID requestID;

    /**
     * Constructor with no Parameters
     */
    public DecisionRequestParameters() {
        // Empty constructor
    }

    /**
     * Constructor with Parameters
     *
     * @param onapName the <code>String</code> format of the onapName whose Decision is required.
     * @param decisionAttributes the <code>Map</code> of <code>String,String</code> format of the decisionAttributes
     *        that contain the ID and values.
     * @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging
     *        messages.
     */
    public DecisionRequestParameters(String onapName, Map<String, String> decisionAttributes, UUID requestID) {
        this.onapName = onapName;
        this.decisionAttributes = decisionAttributes;
        this.requestID = requestID;
    }

    /**
     * Gets the onapName of the Decision Request Parameters.
     *
     * @return onapName the <code>String</code> format of the onapName of the Decision Request Parameters.
     */
    public String getOnapName() {
        return onapName;
    }

    /**
     * Gets the onapName of the Decision Request Parameters.
     *
     * @return onapName the <code>String</code> format of the onapName of the Decision Request Parameters.
     * @deprecated use {@link #getOnapName()} instead.
     */
    @Deprecated
    public String getECOMPComponentName() {
        return onapName;
    }

    /**
     * Sets the onapName of the Decision Request parameters.
     *
     * @param onapName the <code>String</code> format of the onapName whose Decision is required.
     */
    public void setOnapName(String onapName) {
        this.onapName = onapName;
    }

    /**
     * Sets the ecompComponentName of the Decision Request parameters.
     *
     * @param ecompName the <code>String</code> format of the onapName whose Decision is required.
     * @deprecated use {@link #setOnapName(String)} instead.
     */
    @Deprecated
    public void setECOMPComponentName(String ecompName) {
        this.onapName = ecompName;
    }

    /**
     * Gets the Decision Attributes from Decision Request Parameters.
     *
     * @return decisionAttributes the <code>Map</code> of <code>String,String</code> format of the decisionAttributes
     *         that contain the ID and values.
     */
    public Map<String, String> getDecisionAttributes() {
        return decisionAttributes;
    }

    /**
     * Sets the Decision Attributes which contain ID and values for obtaining Decision from PDP.
     *
     * @param decisionAttributes the <code>Map</code> of <code>String,String</code> format of the decisionAttributes
     *        that must contain the ID and values.
     */
    public void setDecisionAttributes(Map<String, String> decisionAttributes) {
        this.decisionAttributes = decisionAttributes;
    }

    /**
     * Gets the request ID of Decision Request Parameters.
     *
     * @return the requestID unique request ID which will be passed throughout the ONAP components to correlate logging
     *         messages.
     */
    public UUID getRequestID() {
        return requestID;
    }

    /**
     * Sets the ReqestID of Decision Request Parameters which will be passed around ONAP requests.
     *
     * @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging
     *        messages.
     */
    public void setRequestID(UUID requestID) {
        this.requestID = requestID;
    }

    /**
     * Used to print the input Params for getDecision REST call.
     *
     * @return JSON String of this object.
     */
    @Override
    public String toString() {
        return GSON.toJson(this);
    }
}