Skip navigation links

oracle.wsm.policymanager.internal
Interface IStringUpdateService

All Known Subinterfaces:

IStringUpdateServiceLocal, IStringUpdateServiceRemote

All Known Implementing Classes:

UpdateService, UpdateService

public interface IStringUpdateService

Method Summary

IPolicySubjectAttachmentResultStr	addAttachmentEntriesAsString(String polSubjectStr, List<String> polRefsStr) Given a policy subject - represented by a resource pattern and a list of policy references for the policy subject - add attachments - if the referenced Policy does not exist - then that entry will be ignored (will not thrown an exception) and processing will continue Duplicate policy references are handled automatically as well as duplicate calls for the same resource pattern.
List<IPolicyAttachmentResultStr>	addAttachmentEntriesString(String resourcePattern, List<String> polRefStrs) Deprecated. use addAttachmentEntries(IPolicySubject polSubject, List<IPolicyReference> polRefs)
void	addAttachmentEntryForPolicyString(String policy, List<String> resourcePatterns) Deprecated.
boolean	areTransactionsSupported() This methods lets you know if transactionality is supported by the backed datastore used by the policymanager.
String	createAssertionTemplateFromString(String assertionTemplateStr) Adds a new Assertion template to the backend datastore
List<String>	createPoliciesFromString(List<String> polStrs) Bulk creation of policies
String	createPolicyFromString(String policyStr) Adds a new policy to the backend datastore
void	deleteAllAssertionTemplates() PERMENENTLY deletes ALL assertion templates from the datastore Assertion templates once deleted cannot be retrived
void	deleteAllAttachments() This API deletes all attachments
void	deleteAllPolicies() PERMENENTLY deletes ALL policies from the datastore Policies once deleted cannot be retrived
void	deleteAssertionTemplate(String templateName) Delete an Assertion template from backend datastore
void	deleteAssertionTemplates(List<String> assertionTemplateNames) Delete all the policies corresponding to the policy names passed
void	deleteAssertionTemplateString(String assertionTemplateStr) Delete an Assertion template from backend datastore
void	deleteAssertionTemplateVersions(String assertionTemplateName, List<Long> versionNumbers) Delete all the specified versions of an assertion template
void	deleteAttachmentEntries(List<String> policySubject) Disassociate a policy subject, represented by a resource pattern, with all policies that it may be associated with.
void	deleteAttachmentEntries(String resourcePattern) Disassociate a policy subject, represented by a resource pattern, with all policies that it may be associated with.
IPolicySubjectAttachmentResultStr	deleteAttachmentEntriesForPolSubjectString(String polSubjectStr, List<String> polRefsStr) Disassociate a policy subject, represented by a resource pattern, with all policies pointed to by the passed policy reference list Given a policy subject - represented by a resource pattern and a list of policy references for the policy subject - deletes all the attachment entries for the corresponding combination of <resource pattern, IPolicyReference>.
List<IPolicyAttachmentResultStr>	deleteAttachmentEntriesForResourcePattern(String resourcePattern, List<String> polRefStrs) Deprecated. use deleteAttachmentEntries(IPolicySubject polSubject, List<IPolicyReference> polRefs)
void	deletePolicies(List<String> polNameList) Delete all the policies corresponding to the policy names passed
void	deletePolicy(String policyName) Deletes a policy to the backend datastore
void	deletePolicyString(String policyStr) Deletes a policy to the backend datastore
void	deletePolicyVersions(String policyName, List<Long> versionNumbers) Delete all the specified versions of a policy
String	promoteAssertionTemplateToTipString(String assertionTemplateName, long version) Promote a previous policy version to the latest.
String	promotePolicyToTipString(String policyName, long version) Promote a previous policy version to the latest.
void	removeAttachmentEntryString(String policyStr, List<String> resourcePatterns) Deprecated.
String	updateAssertionTemplateFromString(String assertionTemplateStr) Update an existing Assertion Template
IPolicySubjectAttachmentResultStr	updateAttachmentEntriesForPolSubject(String polSubjectStr, List<String> polRefStrs) This API is equivalent to calling deleteAttachmentEntries(String resourcePattern) and calling addAttachmentEntries(String resourcePattern, List<IPolicyReference> polRefs)
IPolicySubjectAttachmentResultStr	updateAttachmentEntriesForPolSubject(String polSubjectStr, List<String> polRefStrs, boolean runPolSubjVal) This method is similar to @see IUpdateService#updateAttachmentEntries(IPolicySubject, List) The variation of this method is it performs Policy subject validation
List<IPolicyAttachmentResultStr>	updateAttachmentEntriesForResourcePattern(String resourcePattern, List<String> polRefStrs) Deprecated. use updateAttachmentEntries(IPolicySubject polSubject, List<IPolicyReference> polRefs)
List<String>	updatePoliciesFromString(List<String> policies) Updates policies to the backend datastore
String	updatePolicyFromString(String policyStr) Updates a policy to the backend datastore

Method Detail

createPolicyFromString

String createPolicyFromString(String policyStr)
                              throws PolicyManagerException,
                                     RemoteException

Adds a new policy to the backend datastore

Parameters:

policy - object to add

Returns:

The newly created policy object

Throws:

PolicyManagerException

RemoteException

createPoliciesFromString

List<String> createPoliciesFromString(List<String> polStrs)
                                      throws PolicyManagerException,
                                             RemoteException

Bulk creation of policies

Parameters:

polList - A list of IPolicy objects representing the polices to be created

List - of newly created policy Objects

Throws:

PolicyManagerException

RemoteException

updatePolicyFromString

String updatePolicyFromString(String policyStr)
                              throws PolicyManagerException,
                                     RemoteException

Updates a policy to the backend datastore

Parameters:

Modified - policy object

Returns:

The modified policy objects

Throws:

PolicyManagerException

RemoteException

updatePoliciesFromString

List<String> updatePoliciesFromString(List<String> policies)
                                      throws PolicyManagerException,
                                             RemoteException

Updates policies to the backend datastore

Parameters:

List - of policy objects to be modified

Returns:

List of the modified policy objects

Throws:

PolicyManagerException

RemoteException

deletePolicyString

void deletePolicyString(String policyStr)
                        throws PolicyManagerException,
                               RemoteException

Deletes a policy to the backend datastore

Parameters:

policy - object

Throws:

PolicyManagerException

RemoteException

deletePolicy

void deletePolicy(String policyName)
                  throws PolicyManagerException,
                         RemoteException

Deletes a policy to the backend datastore

Parameters:

String - policy name

Throws:

PolicyManagerException

RemoteException

createAssertionTemplateFromString

String createAssertionTemplateFromString(String assertionTemplateStr)
                                         throws PolicyManagerException,
                                                RemoteException

Adds a new Assertion template to the backend datastore

Parameters:

assertionTemplate - The AssertionTemplate object to add

Throws:

PolicyManagerException

RemoteException

deleteAssertionTemplateString

void deleteAssertionTemplateString(String assertionTemplateStr)
                                   throws PolicyManagerException,
                                          RemoteException

Delete an Assertion template from backend datastore

Parameters:

assertionTemplate - The assertion Template object to be deleted

Throws:

PolicyManagerException

RemoteException

deleteAssertionTemplate

void deleteAssertionTemplate(String templateName)
                             throws PolicyManagerException,
                                    RemoteException

Delete an Assertion template from backend datastore

Parameters:

templateName - Name of the assertion template to be deleted

Throws:

PolicyManagerException

RemoteException

updateAssertionTemplateFromString

String updateAssertionTemplateFromString(String assertionTemplateStr)
                                         throws PolicyManagerException,
                                                RemoteException

Update an existing Assertion Template

Parameters:

assertionTemplate - The Assertion template object to be modified

Throws:

PolicyManagerException

RemoteException

promotePolicyToTipString

String promotePolicyToTipString(String policyName,
                                long version)
                                throws PolicyManagerException,
                                       RemoteException

Promote a previous policy version to the latest.

Parameters:

policyName - Name the of policy to be updated

version - The version to be promoted to the tip

Returns:

Latest (promoted) version of the policy

Throws:

PolicyManagerException

RemoteException

deletePolicyVersions

void deletePolicyVersions(String policyName,
                          List<Long> versionNumbers)
                          throws PolicyManagerException,
                                 RemoteException

Delete all the specified versions of a policy

Parameters:

policyName - Name of the policy whose versions are to be deleted

versions - List of (long) versions numbers to be deleted

Throws:

PolicyManagerException

RemoteException

promoteAssertionTemplateToTipString

String promoteAssertionTemplateToTipString(String assertionTemplateName,
                                           long version)
                                           throws PolicyManagerException,
                                                  RemoteException

Promote a previous policy version to the latest.

Parameters:

policyName - Name the of policy to be updated

version - The version to be promoted to the tip

Returns:

Latest (promoted) version of the policy

Throws:

PolicyManagerException

RemoteException

deleteAssertionTemplateVersions

void deleteAssertionTemplateVersions(String assertionTemplateName,
                                     List<Long> versionNumbers)
                                     throws PolicyManagerException,
                                            RemoteException

Delete all the specified versions of an assertion template

Parameters:

assertionTemplateName - Name of the assertion template whose versions are to be deleted

versionNumbers - List of (long) versions numbers to be deleted

Throws:

PolicyManagerException

RemoteException

deleteAllPolicies

void deleteAllPolicies()
                       throws PolicyManagerException,
                              RemoteException

PERMENENTLY deletes ALL policies from the datastore Policies once deleted cannot be retrived

Throws:

RemoteException

PolicyManagerException

deletePolicies

void deletePolicies(List<String> polNameList)
                    throws PolicyManagerException,
                           RemoteException

Delete all the policies corresponding to the policy names passed

Parameters:

polNameList - List of policy names to be be deleted

Throws:

PolicyManagerException

RemoteException

deleteAllAssertionTemplates

void deleteAllAssertionTemplates()
                                 throws PolicyManagerException,
                                        RemoteException

PERMENENTLY deletes ALL assertion templates from the datastore Assertion templates once deleted cannot be retrived

Throws:

PolicyManagerException

RemoteException

deleteAssertionTemplates

void deleteAssertionTemplates(List<String> assertionTemplateNames)
                              throws PolicyManagerException,
                                     RemoteException

Delete all the policies corresponding to the policy names passed

Parameters:

assertionTemplateNames - List of assertion template names to be be deleted

Throws:

PolicyManagerException

RemoteException

addAttachmentEntriesAsString

IPolicySubjectAttachmentResultStr addAttachmentEntriesAsString(String polSubjectStr,
                                                               List<String> polRefsStr)
                                                               throws PolicyManagerException,
                                                                      RemoteException

Given a policy subject - represented by a resource pattern and a list of policy references for the policy subject - add attachments - if the referenced Policy does not exist - then that entry will be ignored (will not thrown an exception) and processing will continue Duplicate policy references are handled automatically as well as duplicate calls for the same resource pattern. Note: Duplicate policy references in the polRefs list if the Policy Reference is valid will result in a status ATTACHMENT_STATUS_ENUM.success.

Parameters:

polSubject - policy subject to be added

polRefsStr - Policy reference the policy subject needs to be associated with

Returns:

IPolicySubjectAttachmentResult IPolicySubjectAttachmentResult.getAttachmentResults() has the following semantics: returns null if polRefs is null returns null if polSubject is null returns null if polSubject.getResourcePattern() is null or empty string List size is 0 if polRefs size is 0

Throws:

RemoteException

PolicyManagerException

deleteAttachmentEntriesForPolSubjectString

IPolicySubjectAttachmentResultStr deleteAttachmentEntriesForPolSubjectString(String polSubjectStr,
                                                                             List<String> polRefsStr)
                                                                             throws PolicyManagerException,
                                                                                    RemoteException

Disassociate a policy subject, represented by a resource pattern, with all policies pointed to by the passed policy reference list Given a policy subject - represented by a resource pattern and a list of policy references for the policy subject - deletes all the attachment entries for the corresponding combination of <resource pattern, IPolicyReference>. If the referenced Policy does not exist but a Policy Attachment for the Policy exists, then it will be remove the resource pattern from the corresponding Policy Attachment. The API will not throw an exception if the Policy does not exist. Duplicate policy references are handled automatically. If the polRefs contains duplicate Policy References then the IPolicyAttachmentResult will have status ATTACHMENT_STATUS_ENUM.ignore for all duplicates. The behavior is undefined for duplicate API invocations. Note: Duplicate policy references in the polRefs list if the Policy Reference is valid will result in a status ATTACHMENT_STATUS_ENUM.success.

Parameters:

polSubject - Policy subject to be removed

polRefs - Policies from which the subject is to be detached

Returns:

IPolicySubjectAttachmentResult IPolicySubjectAttachmentResult.getAttachmentResults() has the following semantics: returns null if polRefs is null returns null if polSubject is null returns null if polSubject.getResourcePattern() is null or empty string List size is 0 if polRefs size is 0

Throws:

PolicyManagerException

RemoteException

deleteAttachmentEntries

void deleteAttachmentEntries(String resourcePattern)
                             throws PolicyManagerException,
                                    RemoteException

Disassociate a policy subject, represented by a resource pattern, with all policies that it may be associated with.

Parameters:

resourcePattern - Policy subject to be removed

polRefs - Policies from which the subject is to be detached

Throws:

PolicyManagerException

RemoteException

deleteAttachmentEntries

void deleteAttachmentEntries(List<String> policySubject)
                             throws PolicyManagerException,
                                    RemoteException

Disassociate a policy subject, represented by a resource pattern, with all policies that it may be associated with.

Parameters:

policySubject - list of Policy subject to be removed

Throws:

PolicyManagerException

RemoteException

updateAttachmentEntriesForPolSubject

IPolicySubjectAttachmentResultStr updateAttachmentEntriesForPolSubject(String polSubjectStr,
                                                                       List<String> polRefStrs)
                                                                       throws PolicyManagerException,
                                                                              RemoteException

This API is equivalent to calling deleteAttachmentEntries(String resourcePattern) and calling addAttachmentEntries(String resourcePattern, List<IPolicyReference> polRefs)

Returns:

IPolicySubjectAttachmentResult - IPolicySubjectAttachmentResult.getAttachmentResults() has the following semantics: returns null if polRefs is null returns null if polSubject is null returns null if polSubject.getResourcePattern() is null or empty string List size is 0 if polRefs size is 0

Throws:

PolicyManagerException

RemoteException

updateAttachmentEntriesForPolSubject

IPolicySubjectAttachmentResultStr updateAttachmentEntriesForPolSubject(String polSubjectStr,
                                                                       List<String> polRefStrs,
                                                                       boolean runPolSubjVal)
                                                                       throws PolicyManagerException,
                                                                              RemoteException

This method is similar to @see IUpdateService#updateAttachmentEntries(IPolicySubject, List) The variation of this method is it performs Policy subject validation

Parameters:

polSubject -

polRefs -

runPolSubjVal -

Returns:

Throws:

PolicyManagerException

RemoteException

deleteAllAttachments

void deleteAllAttachments()
                          throws PolicyManagerException,
                                 RemoteException

This API deletes all attachments

Throws:

PolicyManagerException

RemoteException

areTransactionsSupported

boolean areTransactionsSupported()
                                 throws PolicyManagerException,
                                        RemoteException

This methods lets you know if transactionality is supported by the backed datastore used by the policymanager. This method should be consulted before making any method calls that call any APIs dealing with bulk operations (create/update/delete)

Returns:

True if the back end datastore supports transactions, false otherwise

Throws:

PolicyManagerException

RemoteException

addAttachmentEntriesString

List<IPolicyAttachmentResultStr> addAttachmentEntriesString(String resourcePattern,
                                                            List<String> polRefStrs)
                                                            throws PolicyManagerException,
                                                                   RemoteException

Deprecated. use addAttachmentEntries(IPolicySubject polSubject, List<IPolicyReference> polRefs)

Given a policy subject - represented by a resource pattern and a list of policy references for the policy subject - add attachments - if the referenced Policy does not exist - then that entry will be ignored (will not thrown an exception) and processing will continue Duplicate policy references are handled automatically as well as duplicate calls for the same resource pattern. Note: Duplicate policy references in the polRefs list if the Policy Reference is valid will result in a status ATTACHMENT_STATUS_ENUM.success.

Parameters:

resourcePattern - policy subject to be added

polRefs - Policy reference the policy subject needs to be associated with

Returns:

List<IPolicyAttachmentResult> - returns null if polRefs is null returns null if resourcePattern is null returns null if resourcePattern is empty string List size is 0 if polRefs size is 0

Throws:

PolicyManagerException

RemoteException

removeAttachmentEntryString

void removeAttachmentEntryString(String policyStr,
                                 List<String> resourcePatterns)
                                 throws PolicyManagerException,
                                        RemoteException

Deprecated.

removes a resource pattern from a policy attachment. If the removed resource pattern is the last then the policy attachment is automatically deleted.

Parameters:

policy -

resourcePatterns -

Throws:

PolicyManagerException

RemoteException

deleteAttachmentEntriesForResourcePattern

List<IPolicyAttachmentResultStr> deleteAttachmentEntriesForResourcePattern(String resourcePattern,
                                                                           List<String> polRefStrs)
                                                                           throws PolicyManagerException,
                                                                                  RemoteException

Deprecated. use deleteAttachmentEntries(IPolicySubject polSubject, List<IPolicyReference> polRefs)

Disassociate a policy subject, represented by a resource pattern, with all policies pointed to by the passed policy reference list Given a policy subject - represented by a resource pattern and a list of policy references for the policy subject - deletes all the attachment entries for the corresponding combination of <resource pattern, IPolicyReference>. If the referenced Policy does not exist but a Policy Attachment for the Policy exists, then it will be remove the resource pattern from the corresponding Policy Attachment. The API will not throw an exception if the Policy does not exist. Duplicate policy references are handled automatically. If the polRefs contains duplicate Policy References then the IPolicyAttachmentResult will have status ATTACHMENT_STATUS_ENUM.ignore for all duplicates. The behavior is undefined for duplicate API invocations. Note: Duplicate policy references in the polRefs list if the Policy Reference is valid will result in a status ATTACHMENT_STATUS_ENUM.success.

Parameters:

resourcePattern - Policy subject to be removed

polRefs - Policies from which the subject is to be detached

Returns:

List<IPolicyAttachmentResult> - returns null if polRefs is null returns null if resourcePattern is null returns null if resourcePattern is empty string List size is 0 if polRefs size is 0

Throws:

PolicyManagerException

RemoteException

updateAttachmentEntriesForResourcePattern

List<IPolicyAttachmentResultStr> updateAttachmentEntriesForResourcePattern(String resourcePattern,
                                                                           List<String> polRefStrs)
                                                                           throws PolicyManagerException,
                                                                                  RemoteException

Deprecated. use updateAttachmentEntries(IPolicySubject polSubject, List<IPolicyReference> polRefs)

This API is equivalent to calling deleteAttachmentEntries(String resourcePattern) and calling addAttachmentEntries(String resourcePattern, List<IPolicyReference> polRefs)

Returns:

List<IPolicyAttachmentResult> - returns null if polRefs is null returns null if resourcePattern is null returns null if resourcePattern is empty string List size is 0 if polRefs size is 0

Throws:

PolicyManagerException

RemoteException

addAttachmentEntryForPolicyString

void addAttachmentEntryForPolicyString(String policy,
                                       List<String> resourcePatterns)
                                       throws PolicyManagerException,
                                              RemoteException

Deprecated.

Associate given policy subjects with a policy If not attachment exists an attachment will be created, if attachment exists then the resourcePattern will be added to the existing entry.

Parameters:

policy - Policy object to which the passed policy subjects need to be associated

resourcePatterns - List of policy subjects to be added

Throws:

PolicyManagerException

RemoteException

Skip navigation links