|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
getAccessPolicyByResourceName(java.lang.String objName) Returns all the access policies related to the resource object provided |
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 |
void |
updateAllDataSpecifiedForObject(long policyKey, long objectKey, long formKey, com.thortech.xl.vo.AccessPolicyResourceData resourceData) Updates all the data defined for a form (including adding/deleting child table records) in an Access Policy. |
Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf |
---|
close, getName, setCountry, setLanguage, setVariant |
Method Detail |
---|
Thor.API.tcResultSet getUnassignedObjects(long policyKey) throws tcPolicyNotFoundException, tcAPIException, tcAPIException
policyKey
- the policy key for the object to be assigned.tcPolicyNotFoundException
- if the policy is not found in the database.tcAPIException
- if there is a problem retrieving the informationThor.API.tcResultSet getAssignableObjects() throws tcAPIException, tcAPIException
tcAPIException
- if there is a problem retrieving the informationThor.API.tcResultSet getAssignedObjects(long policyKey) throws tcPolicyNotFoundException, tcAPIException, tcAPIException
policyKey
- the policy key.tcPolicyNotFoundException
- if the policy is not found in the database.tcAPIException
- if there is a problem retrieving the informationThor.API.tcResultSet getUnassignedGroups(long policyKey) throws tcAPIException, tcPolicyNotFoundException, tcAPIException
policyKey
- the policy key for the groups to be assigned.tcAPIException
- if there is a problem retrieving the informationtcPolicyNotFoundException
- raise if the policy is not a valid policy keyThor.API.tcResultSet getAssignableGroups() throws tcAPIException, tcAPIException
tcAPIException
- if there is a problem retrieving the informationThor.API.tcResultSet getAssignedGroups(long policyKey) throws tcAPIException, tcPolicyNotFoundException, tcAPIException
policyKey
- the policy key for the groups to be assigned.tcAPIException
- if there is a problem retrieving the informationtcPolicyNotFoundException
- raised if the policy is not foundlong createAccessPolicy(java.util.Map attributeList, long[] provObjKeys, boolean[] revokeObjectIfNotApply, long[] denyObjKeys, long[] groupKeys) throws tcObjectNotFoundException, tcGroupNotFoundException, tcInvalidAttributeException, tcAPIException, tcAPIException
attributeList
- the access policy information to create the policy:
provObjKeys
- array of object keys to be assigned to be provisioningrevokeObjectIfNotApply
- 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 deniedgroupKeys
- array of group keys to be assignedtcObjectNotFoundException
- if any object key is not valid.tcGroupNotFoundException
- if any group key is not valid.tcInvalidAttributeException
- raise if one of the attributes is not validtcAPIException
- if there is any problem creating the access policy.long createAccessPolicy(java.util.Map attributeList, long[] provObjKeys, boolean[] revokeObjectIfNotApply, long[] denyObjKeys, long[] groupKeys, com.thortech.xl.vo.AccessPolicyResourceData[] resourceData) throws tcObjectNotFoundException, tcGroupNotFoundException, tcInvalidAttributeException, tcObjectNotAssignedException, tcAPIException, tcAPIException
attributeList
- the access policy information to create the policy:
provObjKeys
- array of object keys to be assigned to be provisioningrevokeObjectIfNotApply
- 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 deniedgroupKeys
- array of group keys to be assignedresourceData
- data for the default data for resourcestcObjectNotFoundException
- if any object key is not valid.tcGroupNotFoundException
- if any group key is not valid.tcInvalidAttributeException
- raise if one of the attributes is not validtcAPIException
- if there is any problem creating the access policy.tcObjectNotAssignedException
- if the object is not yet assigned to the access policy.void updateAccessPolicy(Thor.API.tcResultSet accessPolicyResultSet, java.util.Map attributeList) throws tcPolicyNotFoundException, tcInvalidAttributeException, tcAPIException, tcAPIException
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:
tcPolicyNotFoundException
- if the policy is not in the databasetcInvalidAttributeException
- raise if one of the attributes is not a valid attributetcAPIException
- if there is an error retrieving informationvoid assignObjects(long policyKey, long[] objectKeys, java.util.Map attributeList) throws tcPolicyNotFoundException, tcBulkException, tcInvalidAttributeException, tcAPIException, tcAPIException
policyKey
- the policy to assign the given objectsobjectKeys
- the object keys to assign.attributeList
- one of the following attributes for objects to assigned:
tcPolicyNotFoundException
- raised if the policy key is not validtcBulkException
- raise if one or more objects did not get assigned.tcInvalidAttributeException
- raise if one of the attributes is not a valid attributetcAPIException
- raised for any problem that might be encounteredvoid assignGroups(long policyKey, long[] groupKeys) throws tcPolicyNotFoundException, tcBulkException, tcAPIException, tcAPIException
policyKey
- the policy to assign the given objectsgroupKeys
- the object keys to assign.tcPolicyNotFoundException
- raised if the policy key is not validtcBulkException
- raise if one or more groups did not get assigned.tcAPIException
- raised for any problem that might be encounteredvoid unAssignObjects(long policyKey, long[] objectKeys) throws tcPolicyNotFoundException, tcAPIException, tcBulkException, tcAPIException
policyKey
- the access policy to unassign the object.objectKeys
- the objects to unassigned.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.void unAssignGroups(long policyKey, long[] groupKeys) throws tcPolicyNotFoundException, tcAPIException, tcBulkException, tcAPIException
policyKey
- the access policy to unassign the object.groupKeys
- the objects to unassigned.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.Thor.API.tcResultSet findAccessPolicies(java.util.Map attributeList) throws tcAPIException, tcAPIException
attributeList
- any attribute used to find the access policy:
tcAPIException
- raised if an error is encountered.com.thortech.xl.vo.AccessPolicyResourceData getDataSpecifiedForObject(long policyKey, long objectKey, long formKey) throws tcPolicyNotFoundException, tcAPIException, tcObjectNotAssignedException, tcAPIException
policyKey
- policy KeyobjectKey
- object keyformKey
- user defined form for which the access policy data is retrievedtcPolicyNotFoundException
- If the specified policy does not existtcAPIException
- If an error occurs while retrieving the datatcObjectNotAssignedException
- If the specified object is not assigned to the given policyvoid setDataSpecifiedForObject(long policyKey, long objectKey, long formKey, com.thortech.xl.vo.AccessPolicyResourceData resourceData) throws tcPolicyNotFoundException, tcObjectNotAssignedException, tcAPIException, tcAPIException
policyKey
- policy keyobjectKey
- object keyformKey
- user defined form on which the specified data will be setresourceData
- data that will be be set on the formtcPolicyNotFoundException
- If the specified policy does not existtcObjectNotAssignedException
- If the specified object is not assigned to the given policytcAPIException
- If an error occurs while setting the dataThor.API.tcResultSet getDataSpecifiedFor(long policyKey) throws tcPolicyNotFoundException, tcAPIException, tcAPIException
policyKey
- policy keytcPolicyNotFoundException
- If the specified policy does not existtcAPIException
- If an error occurs while retieving the dataThor.API.tcResultSet evaluatePolicyEffect(long userKey, long groupKey) throws tcUserNotFoundException, tcAPIException, tcAlreadyMemberException, tcAPIException
userKey
- user KeygroupKey
- group keytcUserNotFoundException
- If the specified user does not existtcAPIException
- If any error occurstcAlreadyMemberException
- If the user already a member of the specified groupint getLowestPriority() throws tcAPIException, tcAPIException
tcAPIException
- If an error occurs while retrieving the data or if no policies are defined in the systemcom.thortech.xl.vo.AccessPolicyResourceData[] getDataSpecifiedForObjects(long policyKey) throws tcPolicyNotFoundException, tcAPIException, tcAPIException
policyKey
- policy KeytcPolicyNotFoundException
- If the specified policy does not existtcAPIException
- If an error occurs while retrieving the datavoid setDataSpecifiedForObjects(long policyKey, com.thortech.xl.vo.AccessPolicyResourceData[] resourceData) throws tcPolicyNotFoundException, tcObjectNotAssignedException, tcAPIException, tcAPIException
policyKey
- policy KeyresourceData
- Array containing the data that needs to be set on the formstcPolicyNotFoundException
- If the specified policy does not existtcObjectNotAssignedException
- If one or many of the objects is not assigned to the given policytcAPIException
- If an error occurs while setting the datavoid removeDataSpecifiedForObject(long policyKey, long objectKey, long formKey) throws tcPolicyNotFoundException, tcAPIException, tcObjectNotAssignedException, tcAPIException
policyKey
- policy KeyobjectKey
- object keyformKey
- user defined form for which the access policy data is removedtcPolicyNotFoundException
- If the specified policy does not existtcAPIException
- If an error occurs while removing the datatcObjectNotAssignedException
- If the specified object is not assigned to the given policyvoid updateAllDataSpecifiedForObject(long policyKey, long objectKey, long formKey, com.thortech.xl.vo.AccessPolicyResourceData resourceData) throws tcPolicyNotFoundException, tcObjectNotAssignedException, tcAPIException, tcAPIException
policyKey
- policy keyobjectKey
- object keyformKey
- user defined form on which the specified data will be setresourceData
- data that will be be set on the formtcPolicyNotFoundException
- If the specified policy does not existtcObjectNotAssignedException
- If the specified object is not assigned to the given policytcAPIException
- If an error occurs while setting the dataThor.API.tcResultSet getAccessPolicyByResourceName(java.lang.String objName) throws tcAPIException, tcObjectNotFoundException, tcAPIException
objName
- the object name to get all the access policies relatedtcAPIException
- if there is a problem retrieving the informationtcObjectNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |