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 import lombok.NonNull;
  31
  32 import org.apache.commons.lang3.tuple.Pair;
  33 import org.onap.policy.common.utils.coder.StandardCoder;
  34 import org.onap.policy.common.utils.resources.ResourceUtils;
  35 import org.onap.policy.models.base.PfModelException;
  36 import org.onap.policy.models.base.PfModelRuntimeException;
  37 import org.onap.policy.models.pdp.concepts.Pdp;
  38 import org.onap.policy.models.pdp.concepts.PdpGroup;
  39 import org.onap.policy.models.pdp.concepts.PdpStatistics;
  40 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  41 import org.onap.policy.models.provider.PolicyModelsProvider;
  42 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  43 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  44 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  45 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  46 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
  47 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
  48 import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
  49
  50 /**
  51  * This class provides a dummy implementation of the Policy Models Provider for the ONAP Policy Framework.
  52  *
  53  * @author Liam Fallon (liam.fallon@est.tech)
  54  * @author Chenfei Gao (cgao@research.att.com)
  55  */
  56 public class DummyPolicyModelsProviderImpl implements PolicyModelsProvider {
  57     /**
  58      * Constructor that takes the parameters.
  59      *
  60      * @param parameters the parameters for the provider
  61      */
  62     public DummyPolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) {}
  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     @Override
  75     public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
  76         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
  77     }
  78
  79     @Override
  80     public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
  81         return new ArrayList<>();
  82     }
  83
  84     @Override
  85     public ToscaServiceTemplate getLatestPolicyTypes(final String name) throws PfModelException {
  86         return null;
  87     }
  88
  89     @Override
  90     public List<ToscaPolicyType> getLatestPolicyTypeList(final String name) throws PfModelException {
  91         return new ArrayList<>();
  92     }
  93
  94     @Override
  95     public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
  96             throws PfModelException {
  97         return serviceTemplate;
  98     }
  99
 100     @Override
 101     public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
 102             throws PfModelException {
 103         return serviceTemplate;
 104     }
 105
 106     @Override
 107     public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
 108             throws PfModelException {
 109         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeDeleteResponse.json");
 110     }
 111
 112     @Override
 113     public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
 114         return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
 115     }
 116
 117     @Override
 118     public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
 119         return new ArrayList<>();
 120     }
 121
 122     @Override
 123     public ToscaServiceTemplate getPolicies4PolicyType(@NonNull String policyTypeName, String policyTypeVersion)
 124             throws PfModelException {
 125         return null;
 126     }
 127
 128     @Override
 129     public List<ToscaPolicy> getPolicyList4PolicyType(@NonNull final String policyTypeName,
 130             final String policyTypeVersion) throws PfModelException {
 131         return new ArrayList<>();
 132     }
 133
 134     @Override
 135     public ToscaServiceTemplate getLatestPolicies(final String name) throws PfModelException {
 136         return null;
 137     }
 138
 139     @Override
 140     public List<ToscaPolicy> getLatestPolicyList(final String name) throws PfModelException {
 141         return new ArrayList<>();
 142     }
 143
 144     @Override
 145     public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
 146             throws PfModelException {
 147         return serviceTemplate;
 148     }
 149
 150     @Override
 151     public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
 152             throws PfModelException {
 153         return serviceTemplate;
 154     }
 155
 156     @Override
 157     public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
 158             throws PfModelException {
 159         return getDummyResponse("dummyimpl/DummyToscaPolicyDeleteResponse.json");
 160     }
 161
 162     @Override
 163
 164     public LegacyOperationalPolicy getOperationalPolicy(@NonNull final String policyId) throws PfModelException {
 165         return new LegacyOperationalPolicy();
 166     }
 167
 168     @Override
 169     public LegacyOperationalPolicy createOperationalPolicy(
 170             @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
 171         return legacyOperationalPolicy;
 172     }
 173
 174     @Override
 175     public LegacyOperationalPolicy updateOperationalPolicy(
 176             @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException {
 177         return legacyOperationalPolicy;
 178     }
 179
 180     @Override
 181     public LegacyOperationalPolicy deleteOperationalPolicy(@NonNull final String policyId) throws PfModelException {
 182         return new LegacyOperationalPolicy();
 183     }
 184
 185     @Override
 186     public Map<String, LegacyGuardPolicyOutput> getGuardPolicy(@NonNull final String policyId) throws PfModelException {
 187         return new HashMap<>();
 188     }
 189
 190     @Override
 191     public Map<String, LegacyGuardPolicyOutput> createGuardPolicy(
 192             @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
 193         return new HashMap<>();
 194     }
 195
 196     @Override
 197     public Map<String, LegacyGuardPolicyOutput> updateGuardPolicy(
 198             @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException {
 199         return new HashMap<>();
 200     }
 201
 202     @Override
 203     public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(@NonNull final String policyId)
 204             throws PfModelException {
 205         return new HashMap<>();
 206     }
 207
 208     @Override
 209     public List<PdpGroup> getPdpGroups(final String name, final String version) throws PfModelException {
 210         return new ArrayList<>();
 211     }
 212
 213     @Override
 214     public List<PdpGroup> getLatestPdpGroups(final String name) throws PfModelException {
 215         return new ArrayList<>();
 216     }
 217
 218     @Override
 219     public List<PdpGroup> getFilteredPdpGroups(final String pdpType,
 220             @NonNull final List<Pair<String, String>> supportedPolicyTypes) {
 221         return new ArrayList<>();
 222     }
 223
 224     @Override
 225     public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
 226         return new ArrayList<>();
 227     }
 228
 229     @Override
 230     public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
 231         return new ArrayList<>();
 232     }
 233
 234     @Override
 235     public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final String pdpGroupVersion,
 236             @NonNull final PdpSubGroup pdpSubGroup) throws PfModelException {
 237         // Not implemented
 238     }
 239
 240     @Override
 241     public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpGroupVersion,
 242             @NonNull String pdpSubGroup, @NonNull Pdp pdp) throws PfModelException {
 243         // Not implemented
 244     }
 245
 246     @Override
 247     public PdpGroup deletePdpGroup(@NonNull final String name, @NonNull final String version) throws PfModelException {
 248         return null;
 249     }
 250
 251     @Override
 252     public List<PdpStatistics> getPdpStatistics(final String name, final String version) throws PfModelException {
 253         return new ArrayList<>();
 254     }
 255
 256     @Override
 257     public void updatePdpStatistics(@NonNull final String pdpGroupName, @NonNull final String pdpGroupVersion,
 258             @NonNull final String pdpType, @NonNull final String pdpInstanceId,
 259             @NonNull final PdpStatistics pdppStatistics) throws PfModelException {
 260         // Not implemented
 261     }
 262
 263     @Override
 264     public Map<Pair<String, String>, List<ToscaPolicy>> getDeployedPolicyList(final String name)
 265             throws PfModelException {
 266         return null;
 267     }
 268
 269     /**
 270      * Return a ToscaServicetemplate dummy response.
 271      *
 272      * @param fileName the file name containing the dummy response
 273      * @return the ToscaServiceTemplate with the dummy response
 274      */
 275     protected ToscaServiceTemplate getDummyResponse(@NonNull final String fileName) {
 276         StandardCoder standardCoder = new StandardCoder();
 277         ToscaServiceTemplate serviceTemplate;
 278
 279         try {
 280             serviceTemplate =
 281                     standardCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
 282             if (serviceTemplate == null) {
 283                 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, "error reading specified file");
 284             }
 285         } catch (Exception exc) {
 286             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "error serializing object", exc);
 287         }
 288
 289         return serviceTemplate;
 290     }
 291 }