2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2020 Nordix Foundation.
4 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
5 * Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.policy.models.provider.impl;
25 import java.util.ArrayList;
26 import java.util.Date;
27 import java.util.List;
28 import javax.ws.rs.core.Response;
29 import org.onap.policy.common.utils.coder.StandardCoder;
30 import org.onap.policy.common.utils.resources.ResourceUtils;
31 import org.onap.policy.models.base.PfModelException;
32 import org.onap.policy.models.base.PfModelRuntimeException;
33 import org.onap.policy.models.pdp.concepts.Pdp;
34 import org.onap.policy.models.pdp.concepts.PdpGroup;
35 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
36 import org.onap.policy.models.pdp.concepts.PdpStatistics;
37 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
38 import org.onap.policy.models.provider.PolicyModelsProvider;
39 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
40 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
41 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
42 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
43 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
44 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
47 * This class provides a dummy implementation of the Policy Models Provider for the ONAP Policy Framework.
49 * @author Liam Fallon (liam.fallon@est.tech)
50 * @author Chenfei Gao (cgao@research.att.com)
52 public class DummyPolicyModelsProviderImpl implements PolicyModelsProvider {
54 * Constructor that takes the parameters.
56 * @param parameters the parameters for the provider
58 public DummyPolicyModelsProviderImpl(final PolicyModelsProviderParameters parameters) {
59 // Default constructor
63 public void init() throws PfModelException {
64 // Not required on the dummy provider
69 // Not required on the dummy provider
73 public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
74 return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
78 public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
79 return new ArrayList<>();
83 public ToscaServiceTemplate getFilteredPolicyTypes(ToscaPolicyTypeFilter filter) throws PfModelException {
84 return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
88 public List<ToscaPolicyType> getFilteredPolicyTypeList(ToscaPolicyTypeFilter filter) {
89 return new ArrayList<>();
93 public ToscaServiceTemplate createPolicyTypes(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
94 return serviceTemplate;
98 public ToscaServiceTemplate updatePolicyTypes(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
99 return serviceTemplate;
103 public ToscaServiceTemplate deletePolicyType(final String name, final String version) throws PfModelException {
104 return getDummyResponse("dummyimpl/DummyToscaPolicyTypeDeleteResponse.json");
108 public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
109 return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
113 public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
114 return new ArrayList<>();
118 public ToscaServiceTemplate getFilteredPolicies(ToscaPolicyFilter filter) throws PfModelException {
119 return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
123 public List<ToscaPolicy> getFilteredPolicyList(ToscaPolicyFilter filter) throws PfModelException {
124 return new ArrayList<>();
128 public ToscaServiceTemplate createPolicies(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
129 return serviceTemplate;
133 public ToscaServiceTemplate updatePolicies(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
134 return serviceTemplate;
138 public ToscaServiceTemplate deletePolicy(final String name, final String version) throws PfModelException {
139 return getDummyResponse("dummyimpl/DummyToscaPolicyDeleteResponse.json");
143 public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
144 return new ArrayList<>();
148 public List<PdpGroup> getFilteredPdpGroups(PdpGroupFilter filter) throws PfModelException {
149 return new ArrayList<>();
153 public List<PdpGroup> createPdpGroups(final List<PdpGroup> pdpGroups) throws PfModelException {
154 return new ArrayList<>();
158 public List<PdpGroup> updatePdpGroups(final List<PdpGroup> pdpGroups) throws PfModelException {
159 return new ArrayList<>();
163 public void updatePdpSubGroup(final String pdpGroupName, final PdpSubGroup pdpSubGroup) throws PfModelException {
168 public void updatePdp(String pdpGroupName, String pdpSubGroup, Pdp pdp) throws PfModelException {
173 public PdpGroup deletePdpGroup(final String name) throws PfModelException {
178 public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException {
179 return new ArrayList<>();
183 public List<PdpStatistics> getFilteredPdpStatistics(String name, String pdpGroupName, String pdpSubGroup,
184 Date startTimeStamp, Date endTimeStamp, String sortOrder, int getRecordNum) {
186 return new ArrayList<>();
190 public List<PdpStatistics> createPdpStatistics(final List<PdpStatistics> pdpStatisticsList)
191 throws PfModelException {
193 return new ArrayList<>();
197 public List<PdpStatistics> updatePdpStatistics(final List<PdpStatistics> pdpStatisticsList)
198 throws PfModelException {
200 return new ArrayList<>();
204 public List<PdpStatistics> deletePdpStatistics(final String name, final Date timestamp) {
206 return new ArrayList<>();
210 * Return a ToscaServicetemplate dummy response.
212 * @param fileName the file name containing the dummy response
213 * @return the ToscaServiceTemplate with the dummy response
215 protected ToscaServiceTemplate getDummyResponse(final String fileName) {
216 StandardCoder standardCoder = new StandardCoder();
217 ToscaServiceTemplate serviceTemplate;
221 standardCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
222 if (serviceTemplate == null) {
223 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, "error reading specified file");
225 } catch (Exception exc) {
226 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "error serializing object", exc);
229 return serviceTemplate;