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-2019 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 com.att.research.xacml.api.pap.PAPException;
  24 import java.util.List;
  25 import javax.persistence.PersistenceException;
  26 import org.onap.policy.rest.dao.PolicyDBException;
  27 import org.onap.policy.rest.jpa.GroupEntity;
  28 import org.onap.policy.rest.jpa.PdpEntity;
  29 import org.onap.policy.xacml.api.pap.OnapPDP;
  30 import org.onap.policy.xacml.api.pap.OnapPDPGroup;
  31 import org.onap.policy.xacml.std.pap.StdPDPGroup;
  32
  33 public interface PolicyDBDaoTransaction {
  34
  35     /**
  36      * Commits (makes permanent) the current transaction. Also, notifies other PolicyDBDao instances
  37      * on other PAP servers of the update.
  38      *
  39      * @throws IllegalStateException if the PolicyDBDao transaction has not been used or has been
  40      *         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      *
  58      * @return False if the PolicyDBDao transaction has not been used or has been committed already,
  59      *         true if it is open.
  60      */
  61     public boolean isTransactionOpen();
  62
  63     /**
  64      * Rollback (undo) the current transaction.
  65      */
  66     public void rollbackTransaction();
  67
  68     /**
  69      * Close the PolicyDBDaoTransaction without rolling back or doing anything. Just used to close
  70      * the Hibernate session.
  71      */
  72     public void close();
  73
  74
  75     /**
  76      * Create a new PDP group in the database
  77      * @param groupID The ID to name the new group (use PolicyDBDao.createNewPDPGroupId)
  78      * @param groupName The name to use for the new group
  79      * @param groupDescription Description of the new group (optional)
  80      * @param username Username of the user performing the operation
  81      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
  82      * @throws IllegalStateException If a transaction is already open
  83      * @throws PersistenceException If a database error occurs
  84      */
  85     public void createGroup(String groupID, String groupName, String groupDescription, String username)
  86             throws PolicyDBException;
  87
  88     /**
  89      * Updates a group in the database with a new name of description
  90      * @param group The group with updated information. The id must match an existing group, but the name and description can be changed.
  91      * @param username Username of the user performing the operation
  92      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
  93      * @throws IllegalStateException If a transaction is already open
  94      * @throws PersistenceException If a database error occurs or if the group can not be found
  95      */
  96     public void updateGroup(OnapPDPGroup group, String requestType, String username) throws PolicyDBException;
  97
  98     /**
  99      * Updates a PDP in the database with new information
 100      * @param pdp The PDP to update
 101      * @param username Username of the user performing the operation
 102      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 103      * @throws IllegalStateException If a transaction is already open
 104      * @throws PersistenceException If a database error occurs or if the pdp can not be found
 105      */
 106     public void updatePdp(OnapPDP pdp, String username) throws PolicyDBException;
 107
 108     /**
 109      * Change the default group in the database to the group provided.
 110      * @param group The new group which should be set as default in the database
 111      * @param username Username of the user performing the operation
 112      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 113      * @throws IllegalStateException If a transaction is already open
 114      * @throws PersistenceException If a database error occurs
 115      */
 116     public void changeDefaultGroup(OnapPDPGroup group, String username) throws PolicyDBException;
 117
 118     /**
 119      * Moves a PDP to a new group.
 120      * @param pdp The PDP which is to be moved to a new group
 121      * @param group The new group which the PDP should be added to
 122      * @param username Username of the user performing the operation
 123      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 124      * @throws IllegalStateException If a transaction is already open
 125      * @throws PersistenceException If a database error occurs
 126      */
 127     public void movePdp(OnapPDP pdp, OnapPDPGroup group, String username) throws PolicyDBException;
 128
 129     /**
 130      * Add a new PDP to an existing group
 131      * @param pdpID The ID to name the new PDP
 132      * @param groupID The ID of the existing group to add the PDP to
 133      * @param pdpName The name to use for the new PDP
 134      * @param pdpDescription Description of the new PDP (optional)
 135      * @param pdpJmxPort
 136      * @param username Username of the user performing the operation
 137      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 138      * @throws IllegalStateException If a transaction is already open
 139      * @throws PersistenceException If a database error occurs
 140      */
 141     public void addPdpToGroup(String pdpID, String groupID, String pdpName, String pdpDescription, int pdpJmxPort, String username) throws PolicyDBException;
 142
 143     /**
 144      * Add an existing policy to an existing group
 145      * @param group The ID of the existing group to add the policy to
 146      * @param policyID The ID of an existing policy
 147      * @return
 148      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 149      * @throws IllegalStateException If a transaction is already open
 150      * @throws PersistenceException If a database error occurs
 151      * @throws PolicyDBException
 152      */
 153     public StdPDPGroup addPolicyToGroup(String group, String policyID, String requestType, String username)
 154             throws PolicyDBException;
 155
 156
 157     /**
 158      * Delete an existing PDP groupPolicyDBException
 159      * @param group A PDPGroup object representing the group to delete
 160      * @param moveToGroup A PDPGroup object representing another existing group which PDPs in the group being deleted should be moved to
 161      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 162      * @throws IllegalStateException If a transaction is already open
 163      * @throws PersistenceException If a database error occurs
 164      * @throws PAPException If an error relating to how groups are handled occurs
 165      */
 166     public void deleteGroup(OnapPDPGroup group, OnapPDPGroup moveToGroup, String username) throws PolicyDBException;
 167
 168     /**
 169      * Removes an existing PDP from its group and deletes it.
 170      * @param pdpID The ID of the existing PDP which should be deleted
 171      * @throws IllegalArgumentException If non-optional parameters are null or empty strings
 172      * @throws IllegalStateException If a transaction is already open
 173      * @throws PersistenceException If a database error occurs
 174      */
 175     public void removePdpFromGroup(String pdpID, String username) throws PolicyDBException;
 176
 177     public GroupEntity getGroup(long groupKey);
 178     public GroupEntity getGroup(String groupId);
 179     public List<?> getPdpsInGroup(long groupKey);
 180     public PdpEntity getPdp(long pdpKey);
 181 }