Add Service Template TOSCA handling
[policy/models.git] / models-provider / src / main / java / org / onap / policy / models / provider / PolicyModelsProvider.java
index 767a0fb..1e8fd24 100644 (file)
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2019-2020 Nordix Foundation.
+ *  Modifications Copyright (C) 2020 Bell Canada. 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.
@@ -22,7 +23,6 @@ package org.onap.policy.models.provider;
 
 import java.util.Date;
 import java.util.List;
-import java.util.Map;
 import lombok.NonNull;
 import org.onap.policy.models.base.PfModelException;
 import org.onap.policy.models.pdp.concepts.Pdp;
@@ -35,9 +35,7 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
-import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
-import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
-import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplateFilter;
 
 /**
  * This interface describes the operations that are provided to users and components for reading objects from and
@@ -56,6 +54,58 @@ public interface PolicyModelsProvider extends AutoCloseable {
     @Override
     public void close() throws PfModelException;
 
+    /**
+     * Get service templates.
+     *
+     * @param name the name of the topology template to get, set to null to get all service templates
+     * @param version the version of the service template to get, set to null to get all service templates
+     * @return the topology templates found
+     * @throws PfModelException on errors getting service templates
+     */
+    public List<ToscaServiceTemplate> getServiceTemplateList(final String name, final String version)
+            throws PfModelException;
+
+    /**
+     * Get filtered service templates.
+     *
+     * @param filter the filter for the service templates to get
+     * @return the service templates found
+     * @throws PfModelException on errors getting service templates
+     */
+    public List<ToscaServiceTemplate> getFilteredServiceTemplateList(@NonNull final ToscaServiceTemplateFilter filter)
+            throws PfModelException;
+
+    /**
+     * Create service template.
+     *
+     * @param serviceTemplate the service template to be created
+     * @return the created service template
+     * @throws PfModelException on errors creating the service template
+     */
+    public ToscaServiceTemplate createServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
+            throws PfModelException;
+
+    /**
+     * Update service template.
+     *
+     * @param serviceTemplate the service template to be updated
+     * @return the updated service template
+     * @throws PfModelException on errors updating the service template
+     */
+    public ToscaServiceTemplate updateServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
+            throws PfModelException;
+
+    /**
+     * Delete service template.
+     *
+     * @param name the name of the service template to delete.
+     * @param version the version of the service template to delete.
+     * @return the TOSCA service template that was deleted
+     * @throws PfModelException on errors deleting policy types
+     */
+    public ToscaServiceTemplate deleteServiceTemplate(@NonNull final String name, @NonNull final String version)
+            throws PfModelException;
+
     /**
      * Get policy types.
      *
@@ -107,7 +157,7 @@ public interface PolicyModelsProvider extends AutoCloseable {
             throws PfModelException;
 
     /**
-     * Create policy types.
+     * Update policy types.
      *
      * @param serviceTemplate the service template containing the definition of the policy types to be modified
      * @return the TOSCA service template containing the modified policy types
@@ -122,7 +172,7 @@ public interface PolicyModelsProvider extends AutoCloseable {
      * @param name the name of the policy type to delete.
      * @param version the version of the policy type to delete.
      * @return the TOSCA service template containing the policy type that was deleted
-     * @throws PfModelException on errors deleting policy types
+     * @throws PfModelException on errors deleting the policy type
      */
     public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
             throws PfModelException;
@@ -196,90 +246,6 @@ public interface PolicyModelsProvider extends AutoCloseable {
     public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
             throws PfModelException;
 
-    /**
-     * Get legacy operational policy.
-     *
-     * @param policyId ID of the policy
-     * @param policyVersion version of the policy, set to null to get the latest policy
-     * @return the policies found
-     * @throws PfModelException on errors getting policies
-     */
-    public LegacyOperationalPolicy getOperationalPolicy(@NonNull final String policyId, final String policyVersion)
-            throws PfModelException;
-
-    /**
-     * Create legacy operational policy.
-     *
-     * @param legacyOperationalPolicy the definition of the policy to be created.
-     * @return the created policy
-     * @throws PfModelException on errors creating policies
-     */
-    public LegacyOperationalPolicy createOperationalPolicy(
-            @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException;
-
-    /**
-     * Update legacy operational policy.
-     *
-     * @param legacyOperationalPolicy the definition of the policy to be updated
-     * @return the updated policy
-     * @throws PfModelException on errors updating policies
-     */
-    public LegacyOperationalPolicy updateOperationalPolicy(
-            @NonNull final LegacyOperationalPolicy legacyOperationalPolicy) throws PfModelException;
-
-    /**
-     * Delete legacy operational policy.
-     *
-     * @param policyId ID of the policy.
-     * @param policyVersion version of the policy
-     * @return the deleted policy
-     * @throws PfModelException on errors deleting policies
-     */
-    public LegacyOperationalPolicy deleteOperationalPolicy(@NonNull final String policyId,
-            @NonNull final String policyVersion) throws PfModelException;
-
-    /**
-     * Get legacy guard policy.
-     *
-     * @param policyId ID of the policy
-     * @param policyVersion version of the policy, set to null to get the latest policy
-     * @return the policies found
-     * @throws PfModelException on errors getting policies
-     */
-    public Map<String, LegacyGuardPolicyOutput> getGuardPolicy(@NonNull final String policyId,
-            final String policyVersion) throws PfModelException;
-
-    /**
-     * Create legacy guard policy.
-     *
-     * @param legacyGuardPolicy the definition of the policy to be created.
-     * @return the created policy
-     * @throws PfModelException on errors creating policies
-     */
-    public Map<String, LegacyGuardPolicyOutput> createGuardPolicy(
-            @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException;
-
-    /**
-     * Update legacy guard policy.
-     *
-     * @param legacyGuardPolicy the definition of the policy to be updated
-     * @return the updated policy
-     * @throws PfModelException on errors updating policies
-     */
-    public Map<String, LegacyGuardPolicyOutput> updateGuardPolicy(
-            @NonNull final LegacyGuardPolicyInput legacyGuardPolicy) throws PfModelException;
-
-    /**
-     * Delete legacy guard policy.
-     *
-     * @param policyId ID of the policy.
-     * @param policyVersion version of the policy
-     * @return the deleted policy
-     * @throws PfModelException on errors deleting policies
-     */
-    public Map<String, LegacyGuardPolicyOutput> deleteGuardPolicy(@NonNull final String policyId,
-            @NonNull final String policyVersion) throws PfModelException;
-
     /**
      * Get PDP groups.
      *