models-provider/src/main/java/org/onap/policy/models/provider/impl/DummyPolicyModelsProviderImpl.java

   1 /*-
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.models.provider.impl;
  24
  25 import java.util.ArrayList;
  26 import java.util.Date;
  27 import java.util.List;
  28 import javax.ws.rs.core.Response;
  29 import lombok.NonNull;
  30 import org.onap.policy.common.utils.coder.StandardCoder;
  31 import org.onap.policy.common.utils.resources.ResourceUtils;
  32 import org.onap.policy.models.base.PfModelException;
  33 import org.onap.policy.models.base.PfModelRuntimeException;
  34 import org.onap.policy.models.pdp.concepts.Pdp;
  35 import org.onap.policy.models.pdp.concepts.PdpGroup;
  36 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  37 import org.onap.policy.models.pdp.concepts.PdpStatistics;
  38 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  39 import org.onap.policy.models.provider.PolicyModelsProvider;
  40 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  41 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  42 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
  43 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  44 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
  45 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  46 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplateFilter;
  47
  48 /**
  49  * This class provides a dummy implementation of the Policy Models Provider for the ONAP Policy Framework.
  50  *
  51  * @author Liam Fallon (liam.fallon@est.tech)
  52  * @author Chenfei Gao (cgao@research.att.com)
  53  */
  54 public class DummyPolicyModelsProviderImpl implements PolicyModelsProvider {
  55     /**
  56      * Constructor that takes the parameters.
  57      *
  58      * @param parameters the parameters for the provider
  59      */
  60     public DummyPolicyModelsProviderImpl(final PolicyModelsProviderParameters parameters) {
  61         // Default constructor
  62     }
  63
  64     @Override
  65     public void init() throws PfModelException {
  66         // Not required on the dummy provider
  67     }
  68
  69     @Override
  70     public void close() {
  71         // Not required on the dummy provider
  72     }
  73
  74
  75     @Override
  76     public List<ToscaServiceTemplate> getServiceTemplateList(String name, String version) throws PfModelException {
  77         return new ArrayList<>();
  78     }
  79
  80     @Override
  81     public List<ToscaServiceTemplate> getFilteredServiceTemplateList(@NonNull ToscaServiceTemplateFilter filter)
  82             throws PfModelException {
  83         return new ArrayList<>();
  84     }
  85
  86     @Override
  87     public ToscaServiceTemplate createServiceTemplate(@NonNull ToscaServiceTemplate serviceTemplate)
  88             throws PfModelException {
  89         return serviceTemplate;
  90     }
  91
  92     @Override
  93     public ToscaServiceTemplate updateServiceTemplate(@NonNull ToscaServiceTemplate serviceTemplate)
  94             throws PfModelException {
  95         return serviceTemplate;
  96     }
  97
  98     @Override
  99     public ToscaServiceTemplate deleteServiceTemplate(@NonNull String name, @NonNull String version)
 100             throws PfModelException {
 101         return getDummyResponse("dummyimpl/DummyToscaServiceTemplateDeleteResponse.json");
 102     }
 103
 104     @Override
 105     public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
 106         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
 107     }
 108
 109     @Override
 110     public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
 111         return new ArrayList<>();
 112     }
 113
 114     @Override
 115     public ToscaServiceTemplate getFilteredPolicyTypes(ToscaPolicyTypeFilter filter) throws PfModelException {
 116         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
 117     }
 118
 119     @Override
 120     public List<ToscaPolicyType> getFilteredPolicyTypeList(ToscaPolicyTypeFilter filter) {
 121         return new ArrayList<>();
 122     }
 123
 124     @Override
 125     public ToscaServiceTemplate createPolicyTypes(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 126         return serviceTemplate;
 127     }
 128
 129     @Override
 130     public ToscaServiceTemplate updatePolicyTypes(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 131         return serviceTemplate;
 132     }
 133
 134     @Override
 135     public ToscaServiceTemplate deletePolicyType(final String name, final String version) throws PfModelException {
 136         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeDeleteResponse.json");
 137     }
 138
 139     @Override
 140     public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
 141         return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
 142     }
 143
 144     @Override
 145     public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
 146         return new ArrayList<>();
 147     }
 148
 149     @Override
 150     public ToscaServiceTemplate getFilteredPolicies(ToscaPolicyFilter filter) throws PfModelException {
 151         return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
 152     }
 153
 154     @Override
 155     public List<ToscaPolicy> getFilteredPolicyList(ToscaPolicyFilter filter) throws PfModelException {
 156         return new ArrayList<>();
 157     }
 158
 159     @Override
 160     public ToscaServiceTemplate createPolicies(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 161         return serviceTemplate;
 162     }
 163
 164     @Override
 165     public ToscaServiceTemplate updatePolicies(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 166         return serviceTemplate;
 167     }
 168
 169     @Override
 170     public ToscaServiceTemplate deletePolicy(final String name, final String version) throws PfModelException {
 171         return getDummyResponse("dummyimpl/DummyToscaPolicyDeleteResponse.json");
 172     }
 173
 174     @Override
 175     public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
 176         return new ArrayList<>();
 177     }
 178
 179     @Override
 180     public List<PdpGroup> getFilteredPdpGroups(PdpGroupFilter filter) throws PfModelException {
 181         return new ArrayList<>();
 182     }
 183
 184     @Override
 185     public List<PdpGroup> createPdpGroups(final List<PdpGroup> pdpGroups) throws PfModelException {
 186         return new ArrayList<>();
 187     }
 188
 189     @Override
 190     public List<PdpGroup> updatePdpGroups(final List<PdpGroup> pdpGroups) throws PfModelException {
 191         return new ArrayList<>();
 192     }
 193
 194     @Override
 195     public void updatePdpSubGroup(final String pdpGroupName, final PdpSubGroup pdpSubGroup) throws PfModelException {
 196         // Not implemented
 197     }
 198
 199     @Override
 200     public void updatePdp(String pdpGroupName, String pdpSubGroup, Pdp pdp) throws PfModelException {
 201         // Not implemented
 202     }
 203
 204     @Override
 205     public PdpGroup deletePdpGroup(final String name) throws PfModelException {
 206         return null;
 207     }
 208
 209     @Override
 210     public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException {
 211         return new ArrayList<>();
 212     }
 213
 214     @Override
 215     public List<PdpStatistics> getFilteredPdpStatistics(String name, String pdpGroupName, String pdpSubGroup,
 216             Date startTimeStamp, Date endTimeStamp, String sortOrder, int getRecordNum) {
 217         // Not implemented
 218         return new ArrayList<>();
 219     }
 220
 221     @Override
 222     public List<PdpStatistics> createPdpStatistics(final List<PdpStatistics> pdpStatisticsList)
 223             throws PfModelException {
 224         // Not implemented
 225         return new ArrayList<>();
 226     }
 227
 228     @Override
 229     public List<PdpStatistics> updatePdpStatistics(final List<PdpStatistics> pdpStatisticsList)
 230             throws PfModelException {
 231         // Not implemented
 232         return new ArrayList<>();
 233     }
 234
 235     @Override
 236     public List<PdpStatistics> deletePdpStatistics(final String name, final Date timestamp) {
 237         // Not implemented
 238         return new ArrayList<>();
 239     }
 240
 241     /**
 242      * Return a ToscaServicetemplate dummy response.
 243      *
 244      * @param fileName the file name containing the dummy response
 245      * @return the ToscaServiceTemplate with the dummy response
 246      */
 247     protected ToscaServiceTemplate getDummyResponse(final String fileName) {
 248         StandardCoder standardCoder = new StandardCoder();
 249         ToscaServiceTemplate serviceTemplate;
 250
 251         try {
 252             serviceTemplate =
 253                     standardCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
 254             if (serviceTemplate == null) {
 255                 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, "error reading specified file");
 256             }
 257         } catch (Exception exc) {
 258             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "error serializing object", exc);
 259         }
 260
 261         return serviceTemplate;
 262     }
 263 }