Thor.API.Operations
Interface tcAccessPolicyOperationsIntf

public interface tcAccessPolicyOperationsIntf

Method Summary

void	assignGroups(long policyKey, long[] groupKeys) This method assigns objects to be denied to the given access policy.
void	assignObjects(long policyKey, long[] objectKeys, java.util.Map attributeList) This method assigns objects to be provisioned or denied to the given access policy.
long	createAccessPolicy(java.util.Map attributeList, long[] provObjKeys, boolean[] revokeObjectIfNotApply, long[] denyObjKeys, long[] groupKeys) This method creates an access policy with the given information and the given assigned objects and user groups.
long	createAccessPolicy(java.util.Map attributeList, long[] provObjKeys, boolean[] revokeObjectIfNotApply, long[] denyObjKeys, long[] groupKeys, com.thortech.xl.vo.AccessPolicyResourceData[] resourceData) This method creates an access policy with the given information and the given assigned objects and user groups.
Thor.API.tcResultSet	evaluatePolicyEffect(long userKey, long groupKey) Given a specific user, this method will answer the hypothetical question regarding which resources would get provisioned to that user if the user were made a member of the specified group.
Thor.API.tcResultSet	findAccessPolicies(java.util.Map attributeList) This method returns a resultset containing the access policy that matches the given attributes.
Thor.API.tcResultSet	getAssignableGroups() Returns a list of groups (in the form of a tcResultSet) that can be assigned to any policy.
Thor.API.tcResultSet	getAssignableObjects() Returns a list of objects (in the form of a tcResultSet) that can be provisioned or denied by any policy.
Thor.API.tcResultSet	getAssignedGroups(long policyKey) Returns a list of groups (in the form of a tcResultSet) that are assigned to the policy.
Thor.API.tcResultSet	getAssignedObjects(long policyKey) Returns a list of objects (in the form of a tcResultSet) that are assigned for provisioning to the policy.
Thor.API.tcResultSet	getDataSpecifiedFor(long policyKey) Gets the Objects and corresponding Forms for which data has been specified in the Access Policy.
com.thortech.xl.vo.AccessPolicyResourceData	getDataSpecifiedForObject(long policyKey, long objectKey, long formKey) Returns the data specified for a particular form (including child tables) in an Access Policy.
com.thortech.xl.vo.AccessPolicyResourceData[]	getDataSpecifiedForObjects(long policyKey) Returns the data defined for all forms (including child tables) for all the resources in the Access Policy.
int	getLowestPriority() Returns the lowest priority number of all the policies in the system.
Thor.API.tcResultSet	getUnassignedGroups(long policyKey) Returns a list of groups (in the form of a tcResultSet) that can be assigned to the policy.
Thor.API.tcResultSet	getUnassignedObjects(long policyKey) Returns a list of objects (in the form of a tcResultSet) that can be provisioned or denied by the policy.
void	removeDataSpecifiedForObject(long policyKey, long objectKey, long formKey) Removes the policy data specified for a particular form (including child tables) in an Access Policy.
void	setDataSpecifiedForObject(long policyKey, long objectKey, long formKey, com.thortech.xl.vo.AccessPolicyResourceData resourceData) Sets the data defined for a form (including adding/deleting child table records) in an Access Policy.
void	setDataSpecifiedForObjects(long policyKey, com.thortech.xl.vo.AccessPolicyResourceData[] resourceData) Sets the data for forms (including child tables) of resources in the Access Policy.
void	unAssignGroups(long policyKey, long[] groupKeys) This method unassign the given groups from the access policy.
void	unAssignObjects(long policyKey, long[] objectKeys) This method unassign the given objects that can be provisioned or denied by the access policy.
void	updateAccessPolicy(Thor.API.tcResultSet accessPolicyResultSet, java.util.Map attributeList) This method updates the attributes of an access policy

Method Detail

getUnassignedObjects

public Thor.API.tcResultSet getUnassignedObjects(long policyKey)
                                          throws Thor.API.Exceptions.tcPolicyNotFoundException,
                                                 Thor.API.Exceptions.tcAPIException,
                                                 tcAPIException

Returns a list of objects (in the form of a tcResultSet) that can be provisioned or denied by the policy. The objects are based on the user that is currently logged on.

Parameters:

policyKey - the policy key for the object to be assigned.

Returns:

a result set that returns all the available objects that can be provisioned or denied that are not currently in the policy.

• Objects.Allow All
• Objects.Allow Multiple
• Objects.Auto Launch
• Objects.Auto Prepopulate
• Objects.Auto Save
• Objects.Key
• Objects.Name
• Objects.Note
• Objects.Order For
• Objects.Row Version
• Objects.Self Request Allowed
• Objects.Type

Throws:

tcPolicyNotFoundException - if the policy is not found in the database.

tcAPIException - if there is a problem retrieving the information

Since:

8.0

getAssignableObjects

public Thor.API.tcResultSet getAssignableObjects()
                                          throws Thor.API.Exceptions.tcAPIException,
                                                 tcAPIException

Returns a list of objects (in the form of a tcResultSet) that can be provisioned or denied by any policy. The objects are based on the user that is currently logged on.

Returns:

a result set that returns all the available objects that can be provisioned to any policy.

• Objects.Allow All
• Objects.Allow Multiple
• Objects.Auto Launch
• Objects.Auto Prepopulate
• Objects.Auto Save
• Objects.Key
• Objects.Name
• Objects.Note
• Objects.Order For
• Objects.Row Version
• Objects.Self Request Allowed
• Objects.Type

Throws:

tcAPIException - if there is a problem retrieving the information

Since:

8.0

getAssignedObjects

public Thor.API.tcResultSet getAssignedObjects(long policyKey)
                                        throws Thor.API.Exceptions.tcPolicyNotFoundException,
                                               Thor.API.Exceptions.tcAPIException,
                                               tcAPIException

Returns a list of objects (in the form of a tcResultSet) that are assigned for provisioning to the policy. The objects are based on the user that is currently logged on.

Parameters:

policyKey - the policy key.

Returns:

a result set that returns all the assigned objects that can be provisioned that are currently in the policy.

• Objects.Allow All
• Objects.Allow Multiple
• Objects.Auto Launch
• Objects.Auto Prepopulate
• Objects.Auto Save
• Objects.Key
• Objects.Name
• Objects.Note
• Objects.Order For
• Objects.Row Version
• Objects.Self Request Allowed
• Objects.Type
• Access Policy-Resource Objects.Created By
• Access Policy-Resource Objects.Creation Date
• Access Policy-Resource Objects.Denial
• Access Policy-Resource Objects.Note
• Access Policy-Resource Objects.Revoke Objects
• Access Policy-Resource Objects.Row Version
• Access Policy-Resource Objects.Update Date
• Access Policy-Resource Objects.Updated By

Throws:

tcPolicyNotFoundException - if the policy is not found in the database.

tcAPIException - if there is a problem retrieving the information

Since:

8.0

getUnassignedGroups

public Thor.API.tcResultSet getUnassignedGroups(long policyKey)
                                         throws Thor.API.Exceptions.tcAPIException,
                                                Thor.API.Exceptions.tcPolicyNotFoundException,
                                                tcAPIException

Returns a list of groups (in the form of a tcResultSet) that can be assigned to the policy. The groups are based on the user that is currently logged on.

Parameters:

policyKey - the policy key for the groups to be assigned.

Returns:

a result set that returns all the available objects that can be assigned that are not currently in the policy.

• Groups.Created By
• Groups.Creation Date
• Groups.E-mail
• Groups.Group Name
• Groups.Key
• Groups.Note
• Groups.Row Version
• Groups.Update Date
• Groups.Updated By

Throws:

tcAPIException - if there is a problem retrieving the information

tcPolicyNotFoundException - raise if the policy is not a valid policy key

Since:

8.0

getAssignableGroups

public Thor.API.tcResultSet getAssignableGroups()
                                         throws Thor.API.Exceptions.tcAPIException,
                                                tcAPIException

Returns a list of groups (in the form of a tcResultSet) that can be assigned to any policy. The groups are based on the user that is currently logged on.

Returns:

a result set that returns all the available objects that can be assigned.

• Groups.Created By
• Groups.Creation Date
• Groups.E-mail
• Groups.Group Name
• Groups.Key
• Groups.Note
• Groups.Row Version
• Groups.Update Date
• Groups.Updated By

Throws:

tcAPIException - if there is a problem retrieving the information

Since:

8.0

getAssignedGroups

public Thor.API.tcResultSet getAssignedGroups(long policyKey)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              Thor.API.Exceptions.tcPolicyNotFoundException,
                                              tcAPIException

Returns a list of groups (in the form of a tcResultSet) that are assigned to the policy. The groups are based on the user that is currently logged on.

Parameters:

policyKey - the policy key for the groups to be assigned.

Returns:

a result set that returns all the available objects that are assigned to the policy.

• Groups.Created By
• Groups.Creation Date
• Groups.E-mail
• Groups.Group Name
• Groups.Key
• Groups.Note
• Groups.Row Version
• Groups.Update Date
• Groups.Updated By

Throws:

tcAPIException - if there is a problem retrieving the information

tcPolicyNotFoundException - raised if the policy is not found

Since:

8.0

createAccessPolicy

public long createAccessPolicy(java.util.Map attributeList,
                               long[] provObjKeys,
                               boolean[] revokeObjectIfNotApply,
                               long[] denyObjKeys,
                               long[] groupKeys)
                        throws Thor.API.Exceptions.tcObjectNotFoundException,
                               Thor.API.Exceptions.tcGroupNotFoundException,
                               Thor.API.Exceptions.tcInvalidAttributeException,
                               Thor.API.Exceptions.tcAPIException,
                               tcAPIException

This method creates an access policy with the given information and the given assigned objects and user groups.

Parameters:

attributeList - the access policy information to create the policy:

• Access Policies.Description
• Access Policies.Name
• Access Policies.Note
• Access Policies.Retrofit Flag
• Access Policies.By Request

provObjKeys - array of object keys to be assigned to be provisioning

revokeObjectIfNotApply - same size array as provObjKeys and should contain a boolean value that signifies if the provObjeKey in the same index as provObjKeys needs to be revoke when the object doesn't apply any longer.

denyObjKeys - array of object keys to be assigned to be denied

groupKeys - array of group keys to be assigned

Returns:

the access policy key

Throws:

tcObjectNotFoundException - if any object key is not valid.

tcGroupNotFoundException - if any group key is not valid.

tcInvalidAttributeException - raise if one of the attributes is not valid

tcAPIException - if there is any problem creating the access policy.

Since:

8.0

createAccessPolicy

public long createAccessPolicy(java.util.Map attributeList,
                               long[] provObjKeys,
                               boolean[] revokeObjectIfNotApply,
                               long[] denyObjKeys,
                               long[] groupKeys,
                               com.thortech.xl.vo.AccessPolicyResourceData[] resourceData)
                        throws Thor.API.Exceptions.tcObjectNotFoundException,
                               Thor.API.Exceptions.tcGroupNotFoundException,
                               Thor.API.Exceptions.tcInvalidAttributeException,
                               Thor.API.Exceptions.tcObjectNotAssignedException,
                               Thor.API.Exceptions.tcAPIException,
                               tcAPIException

This method creates an access policy with the given information and the given assigned objects and user groups.

Parameters:

attributeList - the access policy information to create the policy:

• Access Policies.Description
• Access Policies.Name
• Access Policies.Note
• Access Policies.Retrofit Flag
• Access Policies.By Request

provObjKeys - array of object keys to be assigned to be provisioning

revokeObjectIfNotApply - same size array as provObjKeys and should contain a boolean value that signifies if the provObjeKey in the same index as provObjKeys needs to be revoke when the object doesn't apply any longer.

denyObjKeys - array of object keys to be assigned to be denied

groupKeys - array of group keys to be assigned

resourceData - data for the default data for resources

Returns:

the access policy key

Throws:

tcObjectNotFoundException - if any object key is not valid.

tcGroupNotFoundException - if any group key is not valid.

tcInvalidAttributeException - raise if one of the attributes is not valid

tcAPIException - if there is any problem creating the access policy.

tcObjectNotAssignedException - if the object is not yet assigned to the access policy.

Since:

8.0

updateAccessPolicy

public void updateAccessPolicy(Thor.API.tcResultSet accessPolicyResultSet,
                               java.util.Map attributeList)
                        throws Thor.API.Exceptions.tcPolicyNotFoundException,
                               Thor.API.Exceptions.tcInvalidAttributeException,
                               Thor.API.Exceptions.tcAPIException,
                               tcAPIException

This method updates the attributes of an access policy

Parameters:

accessPolicyResultSet - A result set containing at the minimum the access policy key and the rowver of the policy record to update.

attributeList - A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this access policy. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set:

• Access Policies.Description
• Access Policies.Name
• Access Policies.Key

Throws:

tcPolicyNotFoundException - if the policy is not in the database

tcInvalidAttributeException - raise if one of the attributes is not a valid attribute

tcAPIException - if there is an error retrieving information

Since:

8.0

assignObjects

public void assignObjects(long policyKey,
                          long[] objectKeys,
                          java.util.Map attributeList)
                   throws Thor.API.Exceptions.tcPolicyNotFoundException,
                          Thor.API.Exceptions.tcBulkException,
                          Thor.API.Exceptions.tcInvalidAttributeException,
                          Thor.API.Exceptions.tcAPIException,
                          tcAPIException

This method assigns objects to be provisioned or denied to the given access policy.

Parameters:

policyKey - the policy to assign the given objects

objectKeys - the object keys to assign.

attributeList - one of the following attributes for objects to assigned:

• Access Policy-Resource Objects.Denial
• Access Policy-Resource Objects.Note
• Access Policy-Resource Objects.Revoke Objects

The attribute list is used for all the objects passed in the array of object keys.

Throws:

tcPolicyNotFoundException - raised if the policy key is not valid

tcBulkException - raise if one or more objects did not get assigned.

tcInvalidAttributeException - raise if one of the attributes is not a valid attribute

tcAPIException - raised for any problem that might be encountered

Since:

8.0

assignGroups

public void assignGroups(long policyKey,
                         long[] groupKeys)
                  throws Thor.API.Exceptions.tcPolicyNotFoundException,
                         Thor.API.Exceptions.tcBulkException,
                         Thor.API.Exceptions.tcAPIException,
                         tcAPIException

This method assigns objects to be denied to the given access policy.

Parameters:

policyKey - the policy to assign the given objects

groupKeys - the object keys to assign.

Throws:

tcPolicyNotFoundException - raised if the policy key is not valid

tcBulkException - raise if one or more groups did not get assigned.

tcAPIException - raised for any problem that might be encountered

Since:

8.0

unAssignObjects

public void unAssignObjects(long policyKey,
                            long[] objectKeys)
                     throws Thor.API.Exceptions.tcPolicyNotFoundException,
                            Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcBulkException,
                            tcAPIException

This method unassign the given objects that can be provisioned or denied by the access policy.

Parameters:

policyKey - the access policy to unassign the object.

objectKeys - the objects to unassigned.

Throws:

tcPolicyNotFoundException - raised if the policy is not found.

tcAPIException - raised if an error is encountered.

tcBulkException - raise if one or more objects did not get assigned.

Since:

8.0

unAssignGroups

public void unAssignGroups(long policyKey,
                           long[] groupKeys)
                    throws Thor.API.Exceptions.tcPolicyNotFoundException,
                           Thor.API.Exceptions.tcAPIException,
                           Thor.API.Exceptions.tcBulkException,
                           tcAPIException

This method unassign the given groups from the access policy.

Parameters:

policyKey - the access policy to unassign the object.

groupKeys - the objects to unassigned.

Throws:

tcPolicyNotFoundException - raised if the policy is not found.

tcAPIException - raised if an error is encountered.

tcBulkException - raise if one or more groups did not get assigned.

Since:

8.0

findAccessPolicies

public Thor.API.tcResultSet findAccessPolicies(java.util.Map attributeList)
                                        throws Thor.API.Exceptions.tcAPIException,
                                               tcAPIException

This method returns a resultset containing the access policy that matches the given attributes.

Parameters:

attributeList - any attribute used to find the access policy:

• Access Policies.Description
• Access Policies.Key
• Access Policies.Name
• Access Policies.Row Version
• Access Policies.Retrofit Flag

Returns:

a resultset with the access policy information:

• Access Policies.Created By
• Access Policies.Creation Date
• Access Policies.Description
• Access Policies.Key
• Access Policies.Name
• Access Policies.Note
• Access Policies.Row Version
• Access Policies.Update Date
• Access Policies.Updated By
• Access Policies.Retrofit Flag

Throws:

tcAPIException - raised if an error is encountered.

Since:

8.0

getDataSpecifiedForObject

public com.thortech.xl.vo.AccessPolicyResourceData getDataSpecifiedForObject(long policyKey,
                                                                             long objectKey,
                                                                             long formKey)
                                                                      throws Thor.API.Exceptions.tcPolicyNotFoundException,
                                                                             Thor.API.Exceptions.tcAPIException,
                                                                             Thor.API.Exceptions.tcObjectNotAssignedException,
                                                                             tcAPIException

Returns the data specified for a particular form (including child tables) in an Access Policy.

Parameters:

policyKey - policy Key

objectKey - object key

formKey - user defined form for which the access policy data is retrieved

Returns:

an AccessPolicyResourceData value object

Throws:

tcPolicyNotFoundException - If the specified policy does not exist

tcAPIException - If an error occurs while retrieving the data

tcObjectNotAssignedException - If the specified object is not assigned to the given policy

Since:

8.0

setDataSpecifiedForObject

public void setDataSpecifiedForObject(long policyKey,
                                      long objectKey,
                                      long formKey,
                                      com.thortech.xl.vo.AccessPolicyResourceData resourceData)
                               throws Thor.API.Exceptions.tcPolicyNotFoundException,
                                      Thor.API.Exceptions.tcObjectNotAssignedException,
                                      Thor.API.Exceptions.tcAPIException,
                                      tcAPIException

Sets the data defined for a form (including adding/deleting child table records) in an Access Policy.

Parameters:

policyKey - policy key

objectKey - object key

formKey - user defined form on which the specified data will be set

resourceData - data that will be be set on the form

Throws:

tcPolicyNotFoundException - If the specified policy does not exist

tcObjectNotAssignedException - If the specified object is not assigned to the given policy

tcAPIException - If an error occurs while setting the data

Since:

8.0

getDataSpecifiedFor

public Thor.API.tcResultSet getDataSpecifiedFor(long policyKey)
                                         throws Thor.API.Exceptions.tcPolicyNotFoundException,
                                                Thor.API.Exceptions.tcAPIException,
                                                tcAPIException

Gets the Objects and corresponding Forms for which data has been specified in the Access Policy. The returning resultset contains the Object Keys and the Form Keys for which data has been specified

Parameters:

policyKey - policy key

Returns:

a ResultSet containing

• Structure Utility.Key
• Objects.Key

Throws:

tcPolicyNotFoundException - If the specified policy does not exist

tcAPIException - If an error occurs while retieving the data

Since:

8.0

evaluatePolicyEffect

public Thor.API.tcResultSet evaluatePolicyEffect(long userKey,
                                                 long groupKey)
                                          throws Thor.API.Exceptions.tcUserNotFoundException,
                                                 Thor.API.Exceptions.tcAPIException,
                                                 Thor.API.Exceptions.tcAlreadyMemberException,
                                                 tcAPIException

Given a specific user, this method will answer the hypothetical question regarding which resources would get provisioned to that user if the user were made a member of the specified group. The returned resultset would contain the list of resources, and which policy would govern each resources data

Parameters:

userKey - user Key

groupKey - group key

Returns:

a ResultSet containing

• Access Policies.Key
• Objects.Key

Throws:

tcUserNotFoundException - If the specified user does not exist

tcAPIException - If any error occurs

tcAlreadyMemberException - If the user already a member of the specified group

Since:

8.0

getLowestPriority

public int getLowestPriority()
                      throws Thor.API.Exceptions.tcAPIException,
                             tcAPIException

Returns the lowest priority number of all the policies in the system. If there are no policies defined in the system, -1 is returned

Returns:

the lowest priorty number

Throws:

tcAPIException - If an error occurs while retrieving the data or if no policies are defined in the system

Since:

8.0

getDataSpecifiedForObjects

public com.thortech.xl.vo.AccessPolicyResourceData[] getDataSpecifiedForObjects(long policyKey)
                                                                         throws Thor.API.Exceptions.tcPolicyNotFoundException,
                                                                                Thor.API.Exceptions.tcAPIException,
                                                                                tcAPIException

Returns the data defined for all forms (including child tables) for all the resources in the Access Policy.

Parameters:

policyKey - policy Key

Returns:

an array of AccessPolicyResourceData value objects containing the data for all forms for which there is some data specified

Throws:

tcPolicyNotFoundException - If the specified policy does not exist

tcAPIException - If an error occurs while retrieving the data

Since:

8.0

setDataSpecifiedForObjects

public void setDataSpecifiedForObjects(long policyKey,
                                       com.thortech.xl.vo.AccessPolicyResourceData[] resourceData)
                                throws Thor.API.Exceptions.tcPolicyNotFoundException,
                                       Thor.API.Exceptions.tcObjectNotAssignedException,
                                       Thor.API.Exceptions.tcAPIException,
                                       tcAPIException

Sets the data for forms (including child tables) of resources in the Access Policy.

Parameters:

policyKey - policy Key

resourceData - Array containing the data that needs to be set on the forms

Throws:

tcPolicyNotFoundException - If the specified policy does not exist

tcObjectNotAssignedException - If one or many of the objects is not assigned to the given policy

tcAPIException - If an error occurs while setting the data

Since:

8.0

removeDataSpecifiedForObject

public void removeDataSpecifiedForObject(long policyKey,
                                         long objectKey,
                                         long formKey)
                                  throws Thor.API.Exceptions.tcPolicyNotFoundException,
                                         Thor.API.Exceptions.tcAPIException,
                                         Thor.API.Exceptions.tcObjectNotAssignedException,
                                         tcAPIException

Removes the policy data specified for a particular form (including child tables) in an Access Policy.

Parameters:

policyKey - policy Key

objectKey - object key

formKey - user defined form for which the access policy data is removed

Throws:

tcPolicyNotFoundException - If the specified policy does not exist

tcAPIException - If an error occurs while removing the data

tcObjectNotAssignedException - If the specified object is not assigned to the given policy

Since:

8.0