/*- * ============LICENSE_START======================================================= * Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * SPDX-License-Identifier: Apache-2.0 * ============LICENSE_END========================================================= */ 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 javax.ws.rs.core.Response; import lombok.NonNull; import org.apache.commons.lang3.tuple.Pair; import org.onap.policy.models.base.PfConceptKey; import org.onap.policy.models.base.PfModelException; import org.onap.policy.models.base.PfModelRuntimeException; import org.onap.policy.models.base.PfReferenceKey; import org.onap.policy.models.base.PfValidationResult; import org.onap.policy.models.dao.PfDao; import org.onap.policy.models.pdp.concepts.Pdp; import org.onap.policy.models.pdp.concepts.PdpGroup; import org.onap.policy.models.pdp.concepts.PdpStatistics; import org.onap.policy.models.pdp.concepts.PdpSubGroup; import org.onap.policy.models.pdp.persistence.concepts.JpaPdp; import org.onap.policy.models.pdp.persistence.concepts.JpaPdpGroup; import org.onap.policy.models.pdp.persistence.concepts.JpaPdpSubGroup; import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * This class provides the provision of information on PAP concepts in the database to callers. * * @author Liam Fallon (liam.fallon@est.tech) */ public class PdpProvider { private static final Logger LOGGER = LoggerFactory.getLogger(PdpProvider.class); // Recurring string constants private static final String NOT_VALID = "\" is not valid \n"; /** * Get 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 * @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 List getPdpGroups(@NonNull final PfDao dao, final String name, final String version) throws PfModelException { List foundPdpGroups = dao.getFiltered(JpaPdpGroup.class, new PfConceptKey(name, version)); if (foundPdpGroups != null) { return asPdpGroupList(foundPdpGroups); } else { String errorMessage = "no PDP groups found for filter " + name + ":" + version; LOGGER.warn(errorMessage); throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } } /** * Get latest PDP Groups, returns PDP groups in all states. * * @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 List getLatestPdpGroups(@NonNull final PfDao dao, final String name) throws PfModelException { List returnList = new ArrayList<>(); if (name == null) { returnList.add(dao.getLatestVersion(JpaPdpGroup.class, name)); } else { returnList.addAll(dao.getLatestVersions(JpaPdpGroup.class)); } return asPdpGroupList(returnList); } /** * Get a filtered list of PDP groups, returns only active PDP groups. * * @param dao the DAO to use to access the database * @param pdpType The PDP type filter for the returned PDP groups, null to get policy types across PDP subgroups * @param supportedPolicyTypes a list of policy type name/version pairs that the PDP groups must support. * @return the PDP groups found */ public List getFilteredPdpGroups(@NonNull final PfDao dao, final String pdpType, @NonNull final List> supportedPolicyTypes) { return new ArrayList<>(); } /** * Creates PDP groups. * * @param dao the DAO to use to access the database * @param pdpGroups a specification of the PDP groups to create * @return the PDP groups created * @throws PfModelException on errors creating PDP groups */ public List createPdpGroups(@NonNull final PfDao dao, @NonNull final List pdpGroups) throws PfModelException { for (PdpGroup pdpGroup : pdpGroups) { JpaPdpGroup jpaPdpGroup = new JpaPdpGroup();; jpaPdpGroup.fromAuthorative(pdpGroup); PfValidationResult validationResult = jpaPdpGroup.validate(new PfValidationResult()); if (!validationResult.isOk()) { String errorMessage = "pdp group \"" + jpaPdpGroup.getId() + NOT_VALID + validationResult; LOGGER.warn(errorMessage); throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } dao.create(jpaPdpGroup); } // Return the created PDP groups List returnPdpGroups = new ArrayList<>(); for (PdpGroup pdpGroup : pdpGroups) { JpaPdpGroup jpaPdpGroup = dao.get(JpaPdpGroup.class, new PfConceptKey(pdpGroup.getName(), pdpGroup.getVersion())); returnPdpGroups.add(jpaPdpGroup.toAuthorative()); } return returnPdpGroups; } /** * Updates PDP groups. * * @param dao the DAO to use to access the database * @param pdpGroups a specification of the PDP groups to update * @return the PDP groups updated * @throws PfModelException on errors updating PDP groups */ public List updatePdpGroups(@NonNull final PfDao dao, @NonNull final List pdpGroups) throws PfModelException { for (PdpGroup pdpGroup : pdpGroups) { JpaPdpGroup jpaPdpGroup = new JpaPdpGroup();; jpaPdpGroup.fromAuthorative(pdpGroup); PfValidationResult validationResult = jpaPdpGroup.validate(new PfValidationResult()); if (!validationResult.isOk()) { String errorMessage = "pdp group \"" + jpaPdpGroup.getId() + NOT_VALID + validationResult; LOGGER.warn(errorMessage); throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } dao.update(jpaPdpGroup); } // Return the created PDP groups List returnPdpGroups = new ArrayList<>(); for (PdpGroup pdpGroup : pdpGroups) { JpaPdpGroup jpaPdpGroup = dao.get(JpaPdpGroup.class, new PfConceptKey(pdpGroup.getName(), pdpGroup.getVersion())); returnPdpGroups.add(jpaPdpGroup.toAuthorative()); } return returnPdpGroups; } /** * 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 { final PfReferenceKey subGroupKey = new PfReferenceKey(pdpGroupName, pdpGroupVersion, pdpSubGroup.getPdpType()); final JpaPdpSubGroup jpaPdpSubgroup = new JpaPdpSubGroup(subGroupKey); jpaPdpSubgroup.fromAuthorative(pdpSubGroup); PfValidationResult validationResult = jpaPdpSubgroup.validate(new PfValidationResult()); if (!validationResult.isOk()) { String errorMessage = "PDP subgroup \"" + jpaPdpSubgroup.getId() + NOT_VALID + validationResult; LOGGER.warn(errorMessage); throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } if (dao.update(jpaPdpSubgroup) == null) { String errorMessage = "update of PDP subgroup \"" + jpaPdpSubgroup.getId() + "\" failed"; throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } } /** * Update a PDP. * * @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 * @param pdp the PDP to be updated * @throws PfModelException on errors updating PDP subgroups */ public void updatePdp(@NonNull final PfDao dao, @NonNull final String pdpGroupName, @NonNull final String pdpGroupVersion, @NonNull final String pdpSubGroup, @NonNull final Pdp pdp) throws PfModelException { final PfReferenceKey pdpKey = new PfReferenceKey(pdpGroupName, pdpGroupVersion, pdpSubGroup, pdp.getInstanceId()); final JpaPdp jpaPdp = new JpaPdp(pdpKey); jpaPdp.fromAuthorative(pdp); PfValidationResult validationResult = jpaPdp.validate(new PfValidationResult()); if (!validationResult.isOk()) { String errorMessage = "PDP \"" + jpaPdp.getId() + NOT_VALID + validationResult; LOGGER.warn(errorMessage); throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } if (dao.update(jpaPdp) == null) { String errorMessage = "update of PDP \"" + jpaPdp.getId() + "\" failed"; throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } } /** * Delete a PDP group. * * @param dao the DAO to use to access the database * @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 PdpGroup deletePdpGroup(@NonNull final PfDao dao, @NonNull final String name, @NonNull final String version) throws PfModelException { PfConceptKey pdpGroupKey = new PfConceptKey(name, version); JpaPdpGroup jpaDeletePdpGroup = dao.get(JpaPdpGroup.class, pdpGroupKey); if (jpaDeletePdpGroup == null) { String errorMessage = "delete of PDP group \"" + pdpGroupKey.getId() + "\" failed, PDP group does not exist"; throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage); } dao.delete(jpaDeletePdpGroup); return jpaDeletePdpGroup.toAuthorative(); } /** * 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 deployed policies for, null to get all deployed policies * @return the policies deployed as a map of policy lists keyed by PDP group name and version * @throws PfModelException on errors getting policies */ public Map, List> getDeployedPolicyList(@NonNull final PfDao dao, final String name) throws PfModelException { return new LinkedHashMap<>(); } /** * Convert JPA PDP group list to an authorative PDP group list. * * @param foundPdpGroups the list to convert * @return the authorative list */ private List asPdpGroupList(List jpaPdpGroupList) { List pdpGroupList = new ArrayList<>(jpaPdpGroupList.size()); for (JpaPdpGroup jpaPdpGroup : jpaPdpGroupList) { pdpGroupList.add(jpaPdpGroup.toAuthorative()); } return pdpGroupList; } }