org.openecomp.policy.pap.xacml.rest.components

Interface PolicyDBDaoTransaction

public interface PolicyDBDaoTransaction

Method Summary

Modifier and Type	Method and Description
void	addPdpToGroup(String pdpID, String groupID, String pdpName, String pdpDescription, int pdpJmxPort, String username) Add a new PDP to an existing group
void	addPolicyToGroup(String group, String policyID, String username) Add an existing policy to an existing group
void	changeDefaultGroup(org.openecomp.policy.xacml.api.pap.EcompPDPGroup group, String username) Change the default group in the database to the group provided.
void	clonePolicy(String oldPolicyPath, String newPolicyPath, String username)
void	close() Close the PolicyDBDaoTransaction without rolling back or doing anything.
void	commitTransaction() Commits (makes permanent) the current transaction.
void	createGroup(String groupID, String groupName, String groupDescription, String username) Create a new PDP group in the database
void	createPolicy(Policy policy, String username) Create or update a policy
void	createPolicy(String filePath, String username) Create or update a policy
void	deleteGroup(org.openecomp.policy.xacml.api.pap.EcompPDPGroup group, org.openecomp.policy.xacml.api.pap.EcompPDPGroup moveToGroup, String username) Delete an existing PDP group
void	deletePolicy(String policyToDelete) Delete an existing policy
org.openecomp.policy.rest.jpa.GroupEntity	getGroup(long groupKey)
org.openecomp.policy.rest.jpa.GroupEntity	getGroup(String groupId)
org.openecomp.policy.rest.jpa.PdpEntity	getPdp(long pdpKey)
List<?>	getPdpsInGroup(long groupKey)
boolean	isTransactionOpen() Check if the PolicyDBDaoTransaction is currently open
void	movePdp(org.openecomp.policy.xacml.api.pap.EcompPDP pdp, org.openecomp.policy.xacml.api.pap.EcompPDPGroup group, String username) Moves a PDP to a new group.
void	removePdpFromGroup(String pdpID, String username) Removes an existing PDP from its group and deletes it.
void	renamePolicy(String oldPath, String newPath, String username)
void	rollbackTransaction() Rollback (undo) the current transaction.
void	updateGroup(org.openecomp.policy.xacml.api.pap.EcompPDPGroup group, String username) Updates a group in the database with a new name of description
void	updatePdp(org.openecomp.policy.xacml.api.pap.EcompPDP pdp, String username) Updates a PDP in the database with new information

Method Detail

commitTransaction

void commitTransaction()

Commits (makes permanent) the current transaction. Also, notifies other PolicyDBDao instances on other PAP servers of the update.

Throws:

IllegalStateException - if the PolicyDBDao transaction has not been used or has been committed already.

javax.persistence.PersistenceException - if the commit fails for some reason

createPolicy

void createPolicy(Policy policy,
                  String username)
           throws IllegalStateException,
                  javax.persistence.PersistenceException,
                  IllegalArgumentException

Create or update a policy

Parameters:

policy - A Policy object representing the policy to store or update

username - A string of the username you want to be stored for doing this operation

Throws:

IllegalStateException - If a transaction is open that has not yet been committed

javax.persistence.PersistenceException - If a database error occurs

IllegalArgumentException - If the Policy's PolicyRestAdapter contains incorrect data.

createPolicy

void createPolicy(String filePath,
                  String username)
           throws IllegalStateException,
                  javax.persistence.PersistenceException,
                  IllegalArgumentException

Create or update a policy

Parameters:

filePath - The file path of the policy xml file

username - A string of the username you want to be stored for doing this operation

Throws:

IllegalStateException - If a transaction is open that has not yet been committed

javax.persistence.PersistenceException - If a database error occurs

IllegalArgumentException - If the file path is incorrect, or if it refers to a Config policy

isTransactionOpen

boolean isTransactionOpen()

Check if the PolicyDBDaoTransaction is currently open

Returns:

False if the PolicyDBDao transaction has not been used or has been committed already, true if it is open.

deletePolicy

void deletePolicy(String policyToDelete)
           throws IllegalStateException,
                  javax.persistence.PersistenceException,
                  IllegalArgumentException

Delete an existing policy

Parameters:

policyToDelete - The file path of the policy to delete

Throws:

IllegalArgumentException - If the file path given can not be parsed

IllegalStateException - If a transaction is open that has not yet been committed

javax.persistence.PersistenceException - If a database error occurs

rollbackTransaction

void rollbackTransaction()

Rollback (undo) the current transaction.

close

void close()

Close the PolicyDBDaoTransaction without rolling back or doing anything. Just used to close the EntityManager

createGroup

void createGroup(String groupID,
                 String groupName,
                 String groupDescription,
                 String username)
          throws IllegalArgumentException,
                 IllegalStateException,
                 javax.persistence.PersistenceException

Create a new PDP group in the database

Parameters:

groupID - The ID to name the new group (use PolicyDBDao.createNewPDPGroupId)

groupName - The name to use for the new group

groupDescription - Description of the new group (optional)

username - Username of the user performing the operation

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs

updateGroup

void updateGroup(org.openecomp.policy.xacml.api.pap.EcompPDPGroup group,
                 String username)
          throws IllegalArgumentException,
                 IllegalStateException,
                 javax.persistence.PersistenceException

Updates a group in the database with a new name of description

Parameters:

group - The group with updated information. The id must match an existing group, but the name and description can be changed.

username - Username of the user performing the operation

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs or if the group can not be found

updatePdp

void updatePdp(org.openecomp.policy.xacml.api.pap.EcompPDP pdp,
               String username)
        throws IllegalArgumentException,
               IllegalStateException,
               javax.persistence.PersistenceException

Updates a PDP in the database with new information

Parameters:

pdp - The PDP to update

username - Username of the user performing the operation

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs or if the pdp can not be found

changeDefaultGroup

void changeDefaultGroup(org.openecomp.policy.xacml.api.pap.EcompPDPGroup group,
                        String username)
                 throws IllegalArgumentException,
                        IllegalStateException,
                        javax.persistence.PersistenceException

Change the default group in the database to the group provided.

Parameters:

group - The new group which should be set as default in the database

username - Username of the user performing the operation

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs

movePdp

void movePdp(org.openecomp.policy.xacml.api.pap.EcompPDP pdp,
             org.openecomp.policy.xacml.api.pap.EcompPDPGroup group,
             String username)
      throws IllegalArgumentException,
             IllegalStateException,
             javax.persistence.PersistenceException

Moves a PDP to a new group.

Parameters:

pdp - The PDP which is to be moved to a new group

group - The new group which the PDP should be added to

username - Username of the user performing the operation

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs

addPdpToGroup

void addPdpToGroup(String pdpID,
                   String groupID,
                   String pdpName,
                   String pdpDescription,
                   int pdpJmxPort,
                   String username)
            throws IllegalArgumentException,
                   IllegalStateException,
                   javax.persistence.PersistenceException

Add a new PDP to an existing group

Parameters:

pdpID - The ID to name the new PDP

groupID - The ID of the existing group to add the PDP to

pdpName - The name to use for the new PDP

pdpDescription - Description of the new PDP (optional)

pdpJmxPort -

username - Username of the user performing the operation

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs

addPolicyToGroup

void addPolicyToGroup(String group,
                      String policyID,
                      String username)
               throws IllegalArgumentException,
                      IllegalStateException,
                      javax.persistence.PersistenceException

Add an existing policy to an existing group

Parameters:

group - The ID of the existing group to add the policy to

policyID - The ID of an existing policy

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs

deleteGroup

void deleteGroup(org.openecomp.policy.xacml.api.pap.EcompPDPGroup group,
                 org.openecomp.policy.xacml.api.pap.EcompPDPGroup moveToGroup,
                 String username)
          throws IllegalArgumentException,
                 IllegalStateException,
                 javax.persistence.PersistenceException,
                 com.att.research.xacml.api.pap.PAPException

Delete an existing PDP group

Parameters:

group - A PDPGroup object representing the group to delete

moveToGroup - A PDPGroup object representing another existing group which PDPs in the group being deleted should be moved to

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs

com.att.research.xacml.api.pap.PAPException - If an error relating to how groups are handled occurs

removePdpFromGroup

void removePdpFromGroup(String pdpID,
                        String username)
                 throws IllegalArgumentException,
                        IllegalStateException,
                        javax.persistence.PersistenceException

Removes an existing PDP from its group and deletes it.

Parameters:

pdpID - The ID of the existing PDP which should be deleted

Throws:

IllegalArgumentException - If non-optional parameters are null or empty strings

IllegalStateException - If a transaction is already open

javax.persistence.PersistenceException - If a database error occurs

getGroup

org.openecomp.policy.rest.jpa.GroupEntity getGroup(long groupKey)

getGroup

org.openecomp.policy.rest.jpa.GroupEntity getGroup(String groupId)

getPdpsInGroup

List<?> getPdpsInGroup(long groupKey)

getPdp

org.openecomp.policy.rest.jpa.PdpEntity getPdp(long pdpKey)

renamePolicy

void renamePolicy(String oldPath,
                  String newPath,
                  String username)

clonePolicy

void clonePolicy(String oldPolicyPath,
                 String newPolicyPath,
                 String username)