ONAP-PAP-REST/src/main/java/org/onap/policy/pap/xacml/rest/components/PolicyDBDaoTransaction.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP-PAP-REST
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.pap.xacml.rest.components;
  22
  23 import java.util.List;
  24
  25 import javax.persistence.PersistenceException;
  26
  27 import org.onap.policy.rest.dao.PolicyDBException;
  28 import org.onap.policy.rest.jpa.GroupEntity;
  29 import org.onap.policy.rest.jpa.PdpEntity;
  30 import org.onap.policy.xacml.api.pap.OnapPDP;
  31 import org.onap.policy.xacml.api.pap.OnapPDPGroup;
  32 import org.onap.policy.xacml.std.pap.StdPDPGroup;
  33
  34 import com.att.research.xacml.api.pap.PAPException;
  35
  36 public interface PolicyDBDaoTransaction {
  37
  38     /**
  39      * Commits (makes permanent) the current transaction. Also, notifies other PolicyDBDao instances on other PAP servers of the update.
  40      * @throws IllegalStateException if the PolicyDBDao transaction has not been used or has been committed already.
  41      * @throws PersistenceException if the commit fails for some reason
  42      */
  43     public void commitTransaction();
  44
  45     /**
  46      * Create or update a policy
  47      * @param policy A Policy object representing the policy to store or update
  48      * @param username A string of the username you want to be stored for doing this operation
  49      * @throws IllegalStateException If a transaction is open that has not yet been committed
  50      * @throws PersistenceException If a database error occurs
  51      * @throws IllegalArgumentException If the Policy's PolicyRestAdapter contains incorrect data.
  52      */
  53     public void createPolicy(Policy policy, String username) throws PolicyDBException;
  54
  55     /**
  56      * Check if the PolicyDBDaoTransaction is currently open
  57      * @return False if the PolicyDBDao transaction has not been used or has been committed already, true if it is open.
  58      */
  59     public boolean isTransactionOpen();
  60
  61     /**
  62      * Rollback (undo) the current transaction.
  63      */
  64     public void rollbackTransaction();
  65
  66     /**
  67      * Close the PolicyDBDaoTransaction without rolling back or doing anything. Just used to close the EntityManager
  68      */
  69     public void close();
  70
  71
  72     /**
  73      * Create a new PDP group in the database
  74      * @param groupID The ID to name the new group (use PolicyDBDao.createNewPDPGroupId)
  75      * @param groupName The name to use for the new group
  76      * @param groupDescription Description of the new group (optional)
  77      * @param username Username of the user performing the operation
  78      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
  79      * @throws IllegalStateException If a transaction is already open
  80      * @throws PersistenceException If a database error occurs
  81      */
  82     public void createGroup(String groupID, String groupName, String groupDescription, String username) throws PolicyDBException;
  83
  84     /**
  85      * Updates a group in the database with a new name of description
  86      * @param group The group with updated information. The id must match an existing group, but the name and description can be changed.
  87      * @param username Username of the user performing the operation
  88      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
  89      * @throws IllegalStateException If a transaction is already open
  90      * @throws PersistenceException If a database error occurs or if the group can not be found
  91      */
  92     public void updateGroup(OnapPDPGroup group, String username) throws PolicyDBException;
  93
  94     /**
  95      * Updates a PDP in the database with new information
  96      * @param pdp The PDP to update
  97      * @param username Username of the user performing the operation
  98      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
  99      * @throws IllegalStateException If a transaction is already open
 100      * @throws PersistenceException If a database error occurs or if the pdp can not be found
 101      */
 102     public void updatePdp(OnapPDP pdp, String username) throws PolicyDBException;
 103
 104     /**
 105      * Change the default group in the database to the group provided.
 106      * @param group The new group which should be set as default in the database
 107      * @param username Username of the user performing the operation
 108      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 109      * @throws IllegalStateException If a transaction is already open
 110      * @throws PersistenceException If a database error occurs
 111      */
 112     public void changeDefaultGroup(OnapPDPGroup group, String username) throws PolicyDBException;
 113
 114     /**
 115      * Moves a PDP to a new group.
 116      * @param pdp The PDP which is to be moved to a new group
 117      * @param group The new group which the PDP should be added to
 118      * @param username Username of the user performing the operation
 119      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 120      * @throws IllegalStateException If a transaction is already open
 121      * @throws PersistenceException If a database error occurs
 122      */
 123     public void movePdp(OnapPDP pdp, OnapPDPGroup group, String username) throws PolicyDBException;
 124
 125     /**
 126      * Add a new PDP to an existing group
 127      * @param pdpID The ID to name the new PDP
 128      * @param groupID The ID of the existing group to add the PDP to
 129      * @param pdpName The name to use for the new PDP
 130      * @param pdpDescription Description of the new PDP (optional)
 131      * @param pdpJmxPort
 132      * @param username Username of the user performing the operation
 133      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 134      * @throws IllegalStateException If a transaction is already open
 135      * @throws PersistenceException If a database error occurs
 136      */
 137     public void addPdpToGroup(String pdpID, String groupID, String pdpName, String pdpDescription, int pdpJmxPort, String username) throws PolicyDBException;
 138
 139     /**
 140      * Add an existing policy to an existing group
 141      * @param group The ID of the existing group to add the policy to
 142      * @param policyID The ID of an existing policy
 143      * @return
 144      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 145      * @throws IllegalStateException If a transaction is already open
 146      * @throws PersistenceException If a database error occurs
 147      * @throws PolicyDBException
 148      */
 149     public StdPDPGroup addPolicyToGroup(String group, String policyID, String username) throws PolicyDBException;
 150
 151
 152     /**
 153      * Delete an existing PDP groupPolicyDBException
 154      * @param group A PDPGroup object representing the group to delete
 155      * @param moveToGroup A PDPGroup object representing another existing group which PDPs in the group being deleted should be moved to
 156      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 157      * @throws IllegalStateException If a transaction is already open
 158      * @throws PersistenceException If a database error occurs
 159      * @throws PAPException If an error relating to how groups are handled occurs
 160      */
 161     public void deleteGroup(OnapPDPGroup group, OnapPDPGroup moveToGroup, String username)throws PolicyDBException;
 162
 163     /**
 164      * Removes an existing PDP from its group and deletes it.
 165      * @param pdpID The ID of the existing PDP which should be deleted
 166      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 167      * @throws IllegalStateException If a transaction is already open
 168      * @throws PersistenceException If a database error occurs
 169      */
 170     public void removePdpFromGroup(String pdpID, String username) throws PolicyDBException;
 171
 172     public GroupEntity getGroup(long groupKey);
 173     public GroupEntity getGroup(String groupId);
 174     public List<?> getPdpsInGroup(long groupKey);
 175     public PdpEntity getPdp(long pdpKey);
 176 }