Package Thor.API.Operations
Interface tcAccessPolicyOperationsIntf
- All Superinterfaces:
tcUtilityOperationsIntf
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
static enum
-
Method Summary
Modifier and TypeMethodDescriptionvoid
assignGroups
(long policyKey, long[] groupKeys) This method assigns objects to be denied to the given access policy.void
assignGroupToPolicies
(long groupKey, long[] polKeys) This method assigns a group to multiple access policies.void
assignObjects
(long policyKey, long[] objectKeys, Map attributeList) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}long
createAccessPolicy
(Map attributeList, long[] provObjKeys, boolean[] revokeObjectIfNotApply, long[] denyObjKeys, long[] groupKeys) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}long
createAccessPolicy
(Map attributeList, long[] provObjKeys, boolean[] revokeObjectIfNotApply, long[] denyObjKeys, long[] groupKeys, AccessPolicyResourceData[] resourceData) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}long
createAccessPolicy
(Map attributeList, long[] provObjKeys, tcAccessPolicyOperationsIntf.PolicyNLAObjectActionType[] actionIfPolNotApply, long[] denyObjKeys) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}long
createAccessPolicy
(Map attributeList, long[] provObjKeys, tcAccessPolicyOperationsIntf.PolicyNLAObjectActionType[] actionIfPolNotApply, long[] denyObjKeys, long[] groupKeys) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}long
createAccessPolicy
(Map attributeList, long[] provObjKeys, tcAccessPolicyOperationsIntf.PolicyNLAObjectActionType[] actionIfPolNotApply, long[] denyObjKeys, long[] groupKeys, AccessPolicyResourceData[] resourceData) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}long
createAccessPolicy
(Map attributeList, long[] provObjKeys, tcAccessPolicyOperationsIntf.PolicyNLAObjectActionType[] actionIfPolNotApply, long[] denyObjKeys, AccessPolicyResourceData[] resourceData) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}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
(Map attributeList) Deprecated.As of 12c useoracle.iam.accesspolicy.api.AccessPolicyService#findAccessPolicies(SearchCriteria searchCriteria, Map<String, Object> configParams)
Thor.API.tcResultSet
getAccessPolicyByResourceName
(String objName) Returns all the access policies related to the resource object providedThor.API.tcResultSet
Returns a list of groups (in the form of a tcResultSet) that can be assigned to any policy.Thor.API.tcResultSet
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) Deprecated.Thor.API.tcResultSet
getDataSpecifiedFor
(long policyKey) Deprecated.getDataSpecifiedForObject
(long policyKey, long objectKey, long formKey) Deprecated.As of 12c useoracle.iam.accesspolicy.api.AccessPolicyService#getDefaultParentDataIDList(String peID)
getDataSpecifiedForObjects
(long policyKey) Deprecated.int
Deprecated.As of 12c useAccessPolicyService.getLowestPriority()
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) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}boolean
removeEntitlementFromPolicy
(Long polKey, Long objKey, String formFldName, String formFldVal) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}void
setDataSpecifiedForObject
(long policyKey, long objectKey, long formKey, AccessPolicyResourceData resourceData) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}void
setDataSpecifiedForObjects
(long policyKey, AccessPolicyResourceData[] resourceData) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}void
unAssignGroups
(long policyKey, long[] groupKeys) This method unassign the given groups from the access policy.void
unAssignObjects
(long policyKey, long[] objectKeys) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}void
updateAccessPolicy
(Thor.API.tcResultSet accessPolicyResultSet, Map attributeList) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}void
updateAllDataSpecifiedForObject
(long policyKey, long objectKey, long formKey, AccessPolicyResourceData resourceData) Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf
close, getName, setCountry, setLanguage, setVariant
-
Method Details
-
getUnassignedObjects
Thor.API.tcResultSet getUnassignedObjects(long policyKey) throws tcPolicyNotFoundException, 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
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
@Deprecated Thor.API.tcResultSet getAssignedObjects(long policyKey) throws tcPolicyNotFoundException, tcAPIException, tcAPIException Deprecated.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
Thor.API.tcResultSet getUnassignedGroups(long policyKey) throws tcAPIException, 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 informationtcPolicyNotFoundException
- raise if the policy is not a valid policy key- Since:
- 8.0
-
getAssignableGroups
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
Thor.API.tcResultSet getAssignedGroups(long policyKey) throws tcAPIException, 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 informationtcPolicyNotFoundException
- raised if the policy is not found- Since:
- 8.0
-
createAccessPolicy
@Deprecated long createAccessPolicy(Map attributeList, long[] provObjKeys, tcAccessPolicyOperationsIntf.PolicyNLAObjectActionType[] actionIfPolNotApply, long[] denyObjKeys, long[] groupKeys) throws tcObjectNotFoundException, tcGroupNotFoundException, tcInvalidAttributeException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}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
- Access Policies.Owner
- Access Policies.Owner Type
provObjKeys
- array of object keys to be assigned to be provisioningactionIfPolNotApply
- same size array as provObjKeys and should contain an action value that signifies the action to be taken on the provObjKey in the same index - revoke, disabledenyObjKeys
- array of object keys to be assigned to be deniedgroupKeys
- 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 validtcAPIException
- if there is any problem creating the access policy.- Since:
- 8.0
-
createAccessPolicy
@Deprecated long createAccessPolicy(Map attributeList, long[] provObjKeys, boolean[] revokeObjectIfNotApply, long[] denyObjKeys, long[] groupKeys) throws tcObjectNotFoundException, tcGroupNotFoundException, tcInvalidAttributeException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}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
- Access Policies.Owner
- Access Policies.Owner Type
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 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 validtcAPIException
- if there is any problem creating the access policy.- Since:
- 8.0
-
createAccessPolicy
@Deprecated long createAccessPolicy(Map attributeList, long[] provObjKeys, tcAccessPolicyOperationsIntf.PolicyNLAObjectActionType[] actionIfPolNotApply, long[] denyObjKeys, long[] groupKeys, AccessPolicyResourceData[] resourceData) throws tcObjectNotFoundException, tcGroupNotFoundException, tcInvalidAttributeException, tcObjectNotAssignedException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}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
- Access Policies.Owner
- Access Policies.Owner Type
provObjKeys
- array of object keys to be assigned to be provisioningactionIfPolNotApply
- same size array as provObjKeys and should contain action value that signifies the action on the provObjeKey in the same index as provObjKeys when policy no longer appliesdenyObjKeys
- array of object keys to be assigned to be deniedgroupKeys
- array of group keys to be assignedresourceData
- 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 validtcAPIException
- if there is any problem creating the access policy.tcObjectNotAssignedException
- if the object is not yet assigned to the access policy.- Since:
- 8.0
-
createAccessPolicy
@Deprecated long createAccessPolicy(Map attributeList, long[] provObjKeys, boolean[] revokeObjectIfNotApply, long[] denyObjKeys, long[] groupKeys, AccessPolicyResourceData[] resourceData) throws tcObjectNotFoundException, tcGroupNotFoundException, tcInvalidAttributeException, tcObjectNotAssignedException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}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
- Access Policies.Owner
- Access Policies.Owner Type
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 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 validtcAPIException
- 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
@Deprecated void updateAccessPolicy(Thor.API.tcResultSet accessPolicyResultSet, Map attributeList) throws tcPolicyNotFoundException, tcInvalidAttributeException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}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
- Access Policies.Owner
- Access Policies.Owner Type
- Throws:
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 information- Since:
- 8.0
-
assignObjects
@Deprecated void assignObjects(long policyKey, long[] objectKeys, Map attributeList) throws tcPolicyNotFoundException, tcBulkException, tcInvalidAttributeException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}This method assigns objects to be provisioned or denied to the given access policy.- Parameters:
policyKey
- the policy to assign the given objectsobjectKeys
- 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
- Throws:
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 encountered- Since:
- 8.0
-
assignGroups
void assignGroups(long policyKey, long[] groupKeys) throws tcPolicyNotFoundException, tcBulkException, tcAPIException, tcAPIException This method assigns objects to be denied to the given access policy.- Parameters:
policyKey
- the policy to assign the given objectsgroupKeys
- the object keys to assign.- Throws:
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 encountered- Since:
- 8.0
-
unAssignObjects
@Deprecated void unAssignObjects(long policyKey, long[] objectKeys) throws tcPolicyNotFoundException, tcAPIException, tcBulkException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}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
void unAssignGroups(long policyKey, long[] groupKeys) throws tcPolicyNotFoundException, tcAPIException, 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
@Deprecated Thor.API.tcResultSet findAccessPolicies(Map attributeList) throws tcAPIException, tcAPIException Deprecated.As of 12c useoracle.iam.accesspolicy.api.AccessPolicyService#findAccessPolicies(SearchCriteria searchCriteria, Map<String, Object> configParams)
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
- Access Policies.Owner
- Access Policies.Owner Type
- 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
- Access Policies.Owner
- Access Policies.Owner Type
- Throws:
tcAPIException
- raised if an error is encountered.- Since:
- 8.0
-
getDataSpecifiedForObject
@Deprecated AccessPolicyResourceData getDataSpecifiedForObject(long policyKey, long objectKey, long formKey) throws tcPolicyNotFoundException, tcAPIException, tcObjectNotAssignedException, tcAPIException Deprecated.As of 12c useoracle.iam.accesspolicy.api.AccessPolicyService#getDefaultParentDataIDList(String peID)
Returns the data specified for a particular form (including child tables) in an Access Policy.- Parameters:
policyKey
- policy KeyobjectKey
- object keyformKey
- user defined form for which the access policy data is retrieved- Returns:
- an AccessPolicyResourceData value object
- Throws:
tcPolicyNotFoundException
- 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 policy- Since:
- 8.0
-
setDataSpecifiedForObject
@Deprecated void setDataSpecifiedForObject(long policyKey, long objectKey, long formKey, AccessPolicyResourceData resourceData) throws tcPolicyNotFoundException, tcObjectNotAssignedException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}Sets the data defined for a form (including adding/deleting child table records) in an Access Policy.- Parameters:
policyKey
- policy keyobjectKey
- object keyformKey
- user defined form on which the specified data will be setresourceData
- data that will be be set on the form- Throws:
tcPolicyNotFoundException
- 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 data- Since:
- 8.0
-
getDataSpecifiedFor
@Deprecated Thor.API.tcResultSet getDataSpecifiedFor(long policyKey) throws tcPolicyNotFoundException, tcAPIException, tcAPIException Deprecated.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 existtcAPIException
- If an error occurs while retieving the data- Since:
- 8.0
-
evaluatePolicyEffect
Thor.API.tcResultSet evaluatePolicyEffect(long userKey, long groupKey) throws tcUserNotFoundException, tcAPIException, 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 KeygroupKey
- group key- Returns:
- a ResultSet containing
- Access Policies.Key
- Objects.Key
- Throws:
tcUserNotFoundException
- If the specified user does not existtcAPIException
- If any error occurstcAlreadyMemberException
- If the user already a member of the specified group- Since:
- 8.0
-
getLowestPriority
Deprecated.As of 12c useAccessPolicyService.getLowestPriority()
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
@Deprecated AccessPolicyResourceData[] getDataSpecifiedForObjects(long policyKey) throws tcPolicyNotFoundException, tcAPIException, tcAPIException Deprecated.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 existtcAPIException
- If an error occurs while retrieving the data- Since:
- 8.0
-
setDataSpecifiedForObjects
@Deprecated void setDataSpecifiedForObjects(long policyKey, AccessPolicyResourceData[] resourceData) throws tcPolicyNotFoundException, tcObjectNotAssignedException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}Sets the data for forms (including child tables) of resources in the Access Policy.- Parameters:
policyKey
- policy KeyresourceData
- Array containing the data that needs to be set on the forms- Throws:
tcPolicyNotFoundException
- 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 data- Since:
- 8.0
-
removeDataSpecifiedForObject
@Deprecated void removeDataSpecifiedForObject(long policyKey, long objectKey, long formKey) throws tcPolicyNotFoundException, tcAPIException, tcObjectNotAssignedException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}Removes the policy data specified for a particular form (including child tables) in an Access Policy.- Parameters:
policyKey
- policy KeyobjectKey
- object keyformKey
- user defined form for which the access policy data is removed- Throws:
tcPolicyNotFoundException
- 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 policy- Since:
- 8.0
-
updateAllDataSpecifiedForObject
@Deprecated void updateAllDataSpecifiedForObject(long policyKey, long objectKey, long formKey, AccessPolicyResourceData resourceData) throws tcPolicyNotFoundException, tcObjectNotAssignedException, tcAPIException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}Updates all the data defined for a form (including adding/deleting child table records) in an Access Policy.- Parameters:
policyKey
- policy keyobjectKey
- object keyformKey
- user defined form on which the specified data will be setresourceData
- data that will be be set on the form- Throws:
tcPolicyNotFoundException
- 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 data- Since:
- 11.1.1.3
-
getAccessPolicyByResourceName
Thor.API.tcResultSet getAccessPolicyByResourceName(String objName) throws tcAPIException, tcObjectNotFoundException, tcAPIException Returns all the access policies related to the resource object provided- Parameters:
objName
- the object name to get all the access policies related- Returns:
- a result set that returns all the available Access Policies related to the Resource object provided list of Column Metadata Code returned in tcResultSet
- Access Policies.Key
- Access Policies.Name
- Access Policies.Description
- Users.User ID
- Throws:
tcAPIException
- if there is a problem retrieving the informationtcObjectNotFoundException
- Since:
- 11.1.1.4.0
-
removeEntitlementFromPolicy
@Deprecated boolean removeEntitlementFromPolicy(Long polKey, Long objKey, String formFldName, String formFldVal) throws tcPolicyNotFoundException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#updateAccessPolicy(final AccessPolicy policy)}Remove a specific entitlement data from a resource object for an access policy.- Parameters:
polKey
- - Policy KeyobjKey
- - resource object keyformFldName
- - form field nameformFldVal
- - form field value- Returns:
- true if entitlement was actually removed from the policy. Otherwise false - if entitlement value does not exist in the policy throws AccessPolicyServiceException, PolicyNotFoundException
- Throws:
tcPolicyNotFoundException
tcAPIException
-
createAccessPolicy
@Deprecated long createAccessPolicy(Map attributeList, long[] provObjKeys, tcAccessPolicyOperationsIntf.PolicyNLAObjectActionType[] actionIfPolNotApply, long[] denyObjKeys) throws tcObjectNotFoundException, tcInvalidAttributeException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}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
- Access Policies.Owner
- Access Policies.Owner Type
provObjKeys
- array of object keys to be assigned to be provisioningactionIfPolNotApply
- same size array as provObjKeys and should contain an action value that signifies the action to be taken on the provObjKey in the same index - revoke, disabledenyObjKeys
- array of object keys to be assigned to be denied- Returns:
- the access policy key
- Throws:
tcObjectNotFoundException
- if any object key is not valid.tcInvalidAttributeException
- raise if one of the attributes is not validtcAPIException
- if there is any problem creating the access policy.- Since:
- 11.1.2.3.0
-
createAccessPolicy
@Deprecated long createAccessPolicy(Map attributeList, long[] provObjKeys, tcAccessPolicyOperationsIntf.PolicyNLAObjectActionType[] actionIfPolNotApply, long[] denyObjKeys, AccessPolicyResourceData[] resourceData) throws tcObjectNotFoundException, tcInvalidAttributeException, tcObjectNotAssignedException, tcAPIException Deprecated.As of 12c use {@link oracle.iam.accesspolicy.api.AccessPolicyService#createAccessPolicy(final AccessPolicy policy)}This method creates an access policy with the given information and the given assigned objects.- 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
- Access Policies.Owner
- Access Policies.Owner Type
provObjKeys
- array of object keys to be assigned to be provisioningactionIfPolNotApply
- same size array as provObjKeys and should contain action value that signifies the action on the provObjeKey in the same index as provObjKeys when policy no longer appliesdenyObjKeys
- array of object keys to be assigned to be deniedresourceData
- data for the default data for resources- Returns:
- the access policy key
- Throws:
tcObjectNotFoundException
- if any object 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.- Since:
- 11.1.2.3.0
-
assignGroupToPolicies
void assignGroupToPolicies(long groupKey, long[] polKeys) throws tcPolicyNotFoundException, tcGroupNotFoundException, tcAPIException This method assigns a group to multiple access policies. We ignore policies in the input that are already associated with the specified group- Parameters:
groupKey
- a group key to be associated with policiespolKeys
- array of policy keys- Throws:
tcPolicyNotFoundException
- if an invalid policy key is found in the input array of policyKeystcGroupNotFoundException
- if the specified group key does not existtcAPIException
- Since:
- 11.1.2.3.0
-