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

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