aaf/authz - ARCHIVED- 2022-02-15 at the request of the project

diff options

author	Instrumental <jgonap@stl.gathman.org>	2020-03-04 09:21:22 -0600
committer	Jessica Wagantall <jwagantall@linuxfoundation.org>	2020-03-05 15:40:38 +0000
commit	3e96ae3a95da9a507ad92767030f729e484f885f (patch)
tree	3d0649c8a0c1c441da3121ca314b88a1c7458392 /auth
parent	add60903781f8bb4cbe59555bf79181cb5f73b8c (diff)

2.1.17-container

Issue-ID: AAF-1081 Signed-off-by: Instrumental <jgonap@stl.gathman.org> Change-Id: I86e3e38619bb5b350cfbd98670a42542d4202f65

Diffstat (limited to 'auth')

0 files changed, 0 insertions, 0 deletions

/*- * ============LICENSE_START======================================================= * Copyright (C) 2019-2020 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.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; import org.onap.policy.models.pdp.concepts.PdpGroup; import org.onap.policy.models.pdp.concepts.PdpGroupFilter; 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; 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; /** * This interface describes the operations that are provided to users and components for reading objects from and * writing objects to the database. * * @author Liam Fallon (liam.fallon@est.tech) */ public interface PolicyModelsProvider extends AutoCloseable { /** * Open the policy model provider initializing whatever internal handling it needs. * * @throws PfModelException on errors opening the models provider */ public void init() throws PfModelException; @Override public void close() throws PfModelException; /** * Get policy types. * * @param name the name of the policy type to get, set to null to get all policy types * @param version the version of the policy type to get, set to null to get all versions * @return the policy types found * @throws PfModelException on errors getting policy types */ public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException; /** * Get policy types. * * @param name the name of the policy type to get, set to null to get all policy types * @param version the version of the policy type to get, set to null to get all versions * @return the policy types found * @throws PfModelException on errors getting policy types */ public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException; /** * Get filtered policy types. * * @param filter the filter for the policy types to get * @return the policy types found * @throws PfModelException on errors getting policy types */ public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull final ToscaPolicyTypeFilter filter) throws PfModelException; /** * Get filtered policy types. * * @param filter the filter for the policy types to get * @return the policy types found * @throws PfModelException on errors getting policy types */ public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull final ToscaPolicyTypeFilter filter) throws PfModelException; /** * Create policy types. * * @param serviceTemplate the service template containing the definition of the policy types to be created * @return the TOSCA service template containing the created policy types * @throws PfModelException on errors creating policy types */ public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException; /** * Create 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 * @throws PfModelException on errors updating policy types */ public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException; /** * Delete policy type. * * @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 */ public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version) throws PfModelException; /** * Get policies. * * @param name the name of the policy to get, null to get all policies * @param version the version of the policy to get, null to get all versions of a policy * @return the policies found * @throws PfModelException on errors getting policies */ public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException; /** * Get policies. * * @param name the name of the policy to get, null to get all policies * @param version the version of the policy to get, null to get all versions of a policy * @return the policies found * @throws PfModelException on errors getting policies */ public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException; /** * Get filtered policies. * * @param filter the filter for the policies to get * @return the policies found * @throws PfModelException on errors getting policies */ public ToscaServiceTemplate getFilteredPolicies(@NonNull final ToscaPolicyFilter filter) throws PfModelException; /** * Get filtered policies. * * @param filter the filter for the policies to get * @return the policies found * @throws PfModelException on errors getting policies */ public List<ToscaPolicy> getFilteredPolicyList(@NonNull final ToscaPolicyFilter filter) throws PfModelException; /** * Create policies. * * @param serviceTemplate the service template containing the definitions of the new policies to be created. * @return the TOSCA service template containing the policy types that were created * @throws PfModelException on errors creating policies */ public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException; /** * Update policies. * * @param serviceTemplate the service template containing the definitions of the policies to be updated. * @return the TOSCA service template containing the policies that were updated * @throws PfModelException on errors updating policies */ public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate) throws PfModelException; /** * Delete policy. * * @param name the name of the policy to delete. * @param version the version of the policy to delete. * @return the TOSCA service template containing the policy that was deleted * @throws PfModelException on errors deleting a policy */ 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. * * @param name the name of the policy to get, null to get all PDP groups * @return the PDP groups found * @throws PfModelException on errors getting PDP groups */ public List<PdpGroup> getPdpGroups(final String name) throws PfModelException; /** * Get filtered PDP groups. * * @param filter the filter for the PDP groups to get * @return the PDP groups found * @throws PfModelException on errors getting policies */ public List<PdpGroup> getFilteredPdpGroups(@NonNull final PdpGroupFilter filter) throws PfModelException; /** * Creates PDP groups. * * @param pdpGroups a specification of the PDP groups to create * @return the PDP groups created * @throws PfModelException on errors creating PDP groups */ public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException; /** * Updates PDP groups. * * @param pdpGroups a specification of the PDP groups to update * @return the PDP groups updated * @throws PfModelException on errors updating PDP groups */ public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException; /** * Update a PDP subgroup. * * @param pdpGroupName the name 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 String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup) throws PfModelException; /** * Update a PDP. * * @param pdpGroupName the name 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 String pdpGroupName, @NonNull final String pdpSubGroup, @NonNull final Pdp pdp) throws PfModelException; /** * Delete a PDP group. * * @param name the name of the policy to get, null to get all PDP groups * @return the PDP group deleted * @throws PfModelException on errors deleting PDP groups */ public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException; /** * Get PDP statistics. * * @param name the name of the PDP group to get statistics for, null to get all PDP groups * @return the statistics found * @throws PfModelException on errors getting statistics */ public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException; /** * Get filtered PdpStatistics. * * @param name the pdpInstance name for the PDP statistics to get * @param pdpGroupName pdpGroupName to filter statistics * @param pdpSubGroup pdpSubGroupType name to filter statistics * @param startTimeStamp startTimeStamp to filter statistics * @param endTimeStamp endTimeStamp to filter statistics * @param sortOrder sortOrder to query database * @param getRecordNum Total query count from database * @return the PDP statistics found * @throws PfModelException on errors getting policies */ public List<PdpStatistics> getFilteredPdpStatistics(String name, @NonNull String pdpGroupName, String pdpSubGroup, Date startTimeStamp, Date endTimeStamp, String sortOrder, int getRecordNum) throws PfModelException; /** * Creates PDP statistics. * * @param pdpStatisticsList a specification of the PDP statistics to create * @return the PDP statistics created * @throws PfModelException on errors creating PDP statistics */ public List<PdpStatistics> createPdpStatistics(@NonNull List<PdpStatistics> pdpStatisticsList) throws PfModelException; /** * Updates PDP statistics. * * @param pdpStatisticsList a specification of the PDP statistics to update * @return the PDP statistics updated * @throws PfModelException on errors updating PDP statistics */ public List<PdpStatistics> updatePdpStatistics(@NonNull List<PdpStatistics> pdpStatisticsList) throws PfModelException; /** * Delete a PDP statistics. * * @param name the name of the policy to get, null to get all PDP statistics * @param timestamp the timestamp of statistics to delete, null to delete all statistics record of given pdp * @return the PDP statistics deleted * @throws PfModelException on errors deleting PDP statistics */ public List<PdpStatistics> deletePdpStatistics(@NonNull String name, Date timestamp) throws PfModelException; }


context:
space:
mode: