From 0664ecd9f945ffa27126707db144e91156313ba1 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Mon, 1 Apr 2019 21:03:34 +0000 Subject: Add extra methods to Provider interface This review provides the full specification of the Provider interfce and stups the new implemented methods into the relevant delegated providers. Issue-ID: POLICY-1095 Change-Id: I5f297f8dbbe4131ce910fce95459425ac8b7c3f9 Signed-off-by: liamfallon --- .../pdp/persistence/provider/PdpProvider.java | 110 +++++++++++++++++++-- 1 file changed, 103 insertions(+), 7 deletions(-) (limited to 'models-pdp/src') diff --git a/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/provider/PdpProvider.java b/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/provider/PdpProvider.java index fe0576dfe..6af2d211b 100644 --- a/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/provider/PdpProvider.java +++ b/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/provider/PdpProvider.java @@ -20,11 +20,21 @@ package org.onap.policy.models.pdp.persistence.provider; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + import lombok.NonNull; +import org.apache.commons.lang3.tuple.Pair; import org.onap.policy.models.base.PfModelException; import org.onap.policy.models.dao.PfDao; +import org.onap.policy.models.pdp.concepts.PdpGroup; import org.onap.policy.models.pdp.concepts.PdpGroups; +import org.onap.policy.models.pdp.concepts.PdpStatistics; +import org.onap.policy.models.pdp.concepts.PdpSubGroup; +import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy; /** * This class provides the provision of information on PAP concepts in the database to callers. @@ -36,15 +46,41 @@ public class PdpProvider { * Get PDP groups. * * @param dao the DAO to use to access the database - * @param pdpGroupFilter a filter for the get + * @param name the name of the policy to get, null to get all PDP groups + * @param version the version of the policy to get, null to get all versions of a PDP group * @return the PDP groups found * @throws PfModelException on errors getting PDP groups */ - public PdpGroups getPdpGroups(@NonNull final PfDao dao, @NonNull final String pdpGroupFilter) + public PdpGroups getPdpGroups(@NonNull final PfDao dao, final String name, final String version) throws PfModelException { return new PdpGroups(); } + /** + * Get latest PDP Groups. + * + * @param dao the DAO to use to access the database + * @param name the name of the PDP group to get, null to get all PDP groups + * @return the PDP groups found + * @throws PfModelException on errors getting policies + */ + public PdpGroups getLatestPdpGroups(@NonNull final PfDao dao, final String name) throws PfModelException { + return new PdpGroups(); + } + + /** + * Get a filtered list of PDP groups. + * + * @param dao the DAO to use to access the database + * @param pdpType The PDP type filter for the returned PDP groups + * @param supportedPolicyTypes a list of policy type name/version pairs that the PDP groups must support. + * @return the PDP groups found + */ + public PdpGroups getFilteredPdpGroups(@NonNull final PfDao dao, @NonNull final String pdpType, + @NonNull final List> supportedPolicyTypes) { + return new PdpGroups(); + } + /** * Creates PDP groups. * @@ -71,16 +107,76 @@ public class PdpProvider { return new PdpGroups(); } + + /** + * Update a PDP subgroup. + * + * @param dao the DAO to use to access the database + * @param pdpGroupName the name of the PDP group of the PDP subgroup + * @param pdpGroupVersion the version of the PDP group of the PDP subgroup + * @param pdpSubGroup the PDP subgroup to be updated + * @throws PfModelException on errors updating PDP subgroups + */ + public void updatePdpSubGroup(@NonNull final PfDao dao, @NonNull final String pdpGroupName, + @NonNull final String pdpGroupVersion, @NonNull final PdpSubGroup pdpSubGroup) throws PfModelException { + // Not implemented yet + } + /** - * Delete PDP groups. + * Delete a PDP group. * * @param dao the DAO to use to access the database - * @param pdpGroupFilter a filter for the get - * @return the PDP groups deleted + * @param name the name of the policy to get, null to get all PDP groups + * @param version the version of the policy to get, null to get all versions of a PDP group + * @return the PDP group deleted * @throws PfModelException on errors deleting PDP groups */ - public PdpGroups deletePdpGroups(@NonNull final PfDao dao, @NonNull final String pdpGroupFilter) + public PdpGroup deletePdpGroup(@NonNull final PfDao dao, @NonNull final String name, @NonNull final String version) throws PfModelException { - return new PdpGroups(); + return new PdpGroup(); + + } + + /** + * Get PDP statistics. + * + * @param dao the DAO to use to access the database + * @param name the name of the PDP group to get statistics for, null to get all PDP groups + * @param version the version of the PDP group to get statistics for, null to get all versions of a PDP group + * @return the statistics found + * @throws PfModelException on errors getting statistics + */ + public List getPdpStatistics(@NonNull final PfDao dao, final String name, final String version) + throws PfModelException { + return new ArrayList<>(); + } + + /** + * Update PDP statistics for a PDP. + * + * @param dao the DAO to use to access the database + * @param pdpGroupName the name of the PDP group containing the PDP that the statistics are for + * @param pdpGroupVersion the version of the PDP group containing the PDP that the statistics are for + * @param pdpType the PDP type of the subgroup containing the PDP that the statistics are for + * @param pdpInstanceId the instance ID of the PDP to update statistics for + * @throws PfModelException on errors updating statistics + */ + public void updatePdpStatistics(@NonNull final PfDao dao, @NonNull final String pdpGroupName, + @NonNull final String pdpGroupVersion, @NonNull final String pdpType, @NonNull final String pdpInstanceId, + @NonNull final PdpStatistics pdppStatistics) throws PfModelException { + // Not implemented yet + } + + /** + * Get deployed policies. + * + * @param dao the DAO to use to access the database + * @param name the name of the policy to get, null to get all policies + * @return the policies deployed as a map of policy lists keyed by PDP group + * @throws PfModelException on errors getting policies + */ + public Map> getDeployedPolicyList(@NonNull final PfDao dao, final String name) + throws PfModelException { + return new LinkedHashMap<>(); } } -- cgit 1.2.3-korg