UpdateService (Oracle Fusion Middleware Java API Reference for Oracle Web Services Manager)

Method Summary
`IPolicySubjectAttachmentResult`	`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.
`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)` 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.
`void`	`addAttachmentEntryForPolicyString(String policy, List<String> resourcePatterns)` 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.
`boolean`	`areTransactionsSupported()` This methods lets you know if transactionality is supported by the backed datastore used by the policymanager.
`IAssertionTemplate`	`createAssertionTemplate(IAssertionTemplate assertionTemplate)` Adds a new Assertion template to the backend datastore
`String`	`createAssertionTemplateFromString(String assertionTemplateStr)` Adds a new Assertion template to the backend datastore
`List<String>`	`createPoliciesFromString(List<String> polStrList)` Bulk creation of policies
`IPolicy`	`createPolicy(IPolicy policy)` This method will create the policy at datastore.
`List<IPolicy>`	`createPolicy(List<IPolicy> polList)` Bulk creation of policies.If policy is invalid disable it and create.
`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()` Deletes all policy attachments from data store
`void`	`deleteAllPolicies()` PERMENENTLY deletes ALL policies from the datastore Policies once deleted cannot be retrived
`void`	`deleteAssertionTemplate(IAssertionTemplate assertionTemplate)` Delete an Assertion template from backend datastore
`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
`IPolicySubjectAttachmentResult`	`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>.
`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)` 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>.
`void`	`deletePolicies(List<String> polNameList)` Delete all the policies corresponding to the policy names passed
`void`	`deletePolicy(IPolicy policy)` Delete a policy from the backend datastore
`void`	`deletePolicy(String policyName)` Delete a policy from 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
`protected boolean`	`existPolicy(String policyName)`
`protected String`	`getCreator()`
`protected void`	`init()` Initialize the MDS Accessor objects used by this class
`IAssertionTemplate`	`promoteAssertionTemplateToTip(String assertionTemplateName, long version)` Promote a previous policy version to the latest.
`String`	`promoteAssertionTemplateToTipString(String assertionTemplateName, long version)` Promote a previous policy version to the latest.
`IPolicy`	`promotePolicyToTip(String policyName, long version)` Promote a previous policy version to the latest.
`String`	`promotePolicyToTipString(String policyName, long version)` Promote a previous policy version to the latest.
`protected void`	`removeAttachmentEntries(String attachmentName, List<IPolicySubject> resourcePatterns)`
`void`	`removeAttachmentEntryString(String policyStr, List<String> resourcePatterns)` removes a resource pattern from a policy attachment.
`IAssertionTemplate`	`updateAssertionTemplate(IAssertionTemplate assertionTemplate)` Update an existing Assertion Template
`String`	`updateAssertionTemplateFromString(String assertionTemplateStr)` Update an existing Assertion Template
`IPolicySubjectAttachmentResult`	`updateAttachmentEntries(IPolicySubject polSubject, List<IPolicyReference> polRefs)` This API is equivalent to calling deleteAttachmentEntries(String resourcePattern) and calling addAttachmentEntries(String resourcePattern, List<IPolicyReference> polRefs)
`IPolicySubjectAttachmentResult`	`updateAttachmentEntries(IPolicySubject polSubject, List<IPolicyReference> polRefs, boolean runPolSubjVal)` This method is similar to @see IUpdateService#updateAttachmentEntries(IPolicySubject, List) The variation of this method is it performs Policy subject validation
`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)` This API is equivalent to calling deleteAttachmentEntries(String resourcePattern) and calling addAttachmentEntries(String resourcePattern, List<IPolicyReference> polRefs)
`List<IPolicy>`	`updatePolicies(List<IPolicy> policies)` Updates a list of policies
`List<String>`	`updatePoliciesFromString(List<String> policyStrs)` Updates policies to the backend datastore
`IPolicy`	`updatePolicy(IPolicy policy)` Updates the given policy, For policy that will fail the validation, the policy will be disabled and then saved to the data store.
`String`	`updatePolicyFromString(String policyStr)` Updates a policy to the backend datastore

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

UpdateService

public UpdateService()

Default constructor

UpdateService

public UpdateService(MDSConfig config)

Use this constructor for programmatic initialization of MDS

Parameters:: config - MDS configuration information

Method Detail

init

protected void init()

Initialize the MDS Accessor objects used by this class

createPolicy

public IPolicy createPolicy(IPolicy policy)
                     throws PolicyManagerException

This method will create the policy at datastore. If policy is invalid *disable* the policy.

Specified by:: createPolicy in interface IUpdateService

Parameters:: IPolicy -
Returns:: IPolicy
Throws:: PolicyManagerException

updatePolicy

public IPolicy updatePolicy(IPolicy policy)
                     throws PolicyManagerException

Updates the given policy, For policy that will fail the validation, the policy will be *disabled* and then *saved* to the data store.

Specified by:: updatePolicy in interface IUpdateService

Parameters:: policy - IPolicy object having the details and changes for the policy update
Returns:: The modified policy objects
Throws:: PolicyManagerException

updatePolicies

public List<IPolicy> updatePolicies(List<IPolicy> policies)
                             throws PolicyManagerException

Updates a list of policies

Specified by:: updatePolicies in interface IUpdateService

Parameters:: policies - A list of IPolicy objects to be updated
Returns:: List of the modified policy objects
Throws:: PolicyManagerException
See Also:: UpdateService.updatePolicy(IPolicy policy)

createPolicy

public List<IPolicy> createPolicy(List<IPolicy> polList)
                           throws PolicyManagerException

Bulk creation of policies.If policy is invalid *disable* it and create.

Specified by:: createPolicy in interface IUpdateService

Parameters:: polList - A list of IPolicy objects representing the polices to be created
Throws:: PolicyManagerException

deletePolicy

public void deletePolicy(String policyName)
                  throws PolicyManagerException

Delete a policy from the backend datastore

Specified by:: deletePolicy in interface IStringUpdateService
Specified by:: deletePolicy in interface IUpdateService

Parameters:: policyName - The name of policy to be deleted
Throws:: PolicyManagerException; PolicyManagerException

deletePolicy

public void deletePolicy(IPolicy policy)
                  throws PolicyManagerException

Delete a policy from the backend datastore

Specified by:: deletePolicy in interface IUpdateService

Parameters:: policy - Ipolicy object to representing the policy to be deleted
Throws:: PolicyManagerException

createAssertionTemplate

public IAssertionTemplate createAssertionTemplate(IAssertionTemplate assertionTemplate)
                                           throws PolicyManagerException

Adds a new Assertion template to the backend datastore

Specified by:: createAssertionTemplate in interface IUpdateService

Parameters:: assertionTemplate - The AssertionTemplate object to add
Throws:: PolicyManagerException

updateAssertionTemplate

public IAssertionTemplate updateAssertionTemplate(IAssertionTemplate assertionTemplate)
                                           throws PolicyManagerException

Update an existing Assertion Template

Specified by:: updateAssertionTemplate in interface IUpdateService

Parameters:: assertionTemplate - The Assertion template object to be modified
Throws:: PolicyManagerException

deleteAssertionTemplate

public void deleteAssertionTemplate(IAssertionTemplate assertionTemplate)
                             throws PolicyManagerException

Delete an Assertion template from backend datastore

Specified by:: deleteAssertionTemplate in interface IUpdateService

Parameters:: assertionTemplate - The assertion Template object to be deleted
Throws:: PolicyManagerException

deleteAssertionTemplate

public void deleteAssertionTemplate(String templateName)
                             throws PolicyManagerException

Description copied from interface: IUpdateService

Delete an Assertion template from backend datastore

Specified by:: deleteAssertionTemplate in interface IStringUpdateService
Specified by:: deleteAssertionTemplate in interface IUpdateService

Parameters:: templateName - Name of the assertion template to be deleted
Throws:: PolicyManagerException

existPolicy

protected boolean existPolicy(String policyName)

promotePolicyToTip

public IPolicy promotePolicyToTip(String policyName,
                                  long version)
                           throws PolicyManagerException

Description copied from interface: IUpdateService

Promote a previous policy version to the latest.

Specified by:: promotePolicyToTip in interface IUpdateService

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

promoteAssertionTemplateToTip

public IAssertionTemplate promoteAssertionTemplateToTip(String assertionTemplateName,
                                                        long version)
                                                 throws PolicyManagerException

Description copied from interface: IUpdateService

Promote a previous policy version to the latest.

Specified by:: promoteAssertionTemplateToTip in interface IUpdateService

version - The version to be promoted to the tip
Returns:: Latest (promoted) version of the policy
Throws:: PolicyManagerException

deletePolicyVersions

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

Description copied from interface: IUpdateService

Delete all the specified versions of a policy

Specified by:: deletePolicyVersions in interface IStringUpdateService
Specified by:: deletePolicyVersions in interface IUpdateService

Parameters:: policyName - Name of the policy whose versions are to be deleted
Throws:: PolicyManagerException

deleteAssertionTemplateVersions

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

Description copied from interface: IUpdateService

Delete all the specified versions of an assertion template

Specified by:: deleteAssertionTemplateVersions in interface IStringUpdateService
Specified by:: deleteAssertionTemplateVersions in interface IUpdateService

Parameters:: assertionTemplateName - Name of the assertion template whose versions are to be deleted; versionNumbers - List of (long) versions numbers to be deleted
Throws:: PolicyManagerException

deleteAllAssertionTemplates

public void deleteAllAssertionTemplates()
                                 throws PolicyManagerException

Description copied from interface: IUpdateService

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

Specified by:: deleteAllAssertionTemplates in interface IStringUpdateService
Specified by:: deleteAllAssertionTemplates in interface IUpdateService

Throws:: PolicyManagerException

deleteAllPolicies

public void deleteAllPolicies()
                       throws PolicyManagerException

Description copied from interface: IUpdateService

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

Specified by:: deleteAllPolicies in interface IStringUpdateService
Specified by:: deleteAllPolicies in interface IUpdateService

Throws:: PolicyManagerException

deleteAssertionTemplates

public void deleteAssertionTemplates(List<String> assertionTemplateNames)
                              throws PolicyManagerException

Description copied from interface: IUpdateService

Delete all the policies corresponding to the policy names passed

Specified by:: deleteAssertionTemplates in interface IStringUpdateService
Specified by:: deleteAssertionTemplates in interface IUpdateService

Parameters:: assertionTemplateNames - List of assertion template names to be be deleted
Throws:: PolicyManagerException

deletePolicies

public void deletePolicies(List<String> polNameList)
                    throws PolicyManagerException

Description copied from interface: IUpdateService

Delete all the policies corresponding to the policy names passed

Specified by:: deletePolicies in interface IStringUpdateService
Specified by:: deletePolicies in interface IUpdateService

Parameters:: polNameList - List of policy names to be be deleted
Throws:: PolicyManagerException

addAttachmentEntries

public IPolicySubjectAttachmentResult addAttachmentEntries(IPolicySubject polSubject,
                                                           List<IPolicyReference> polRefs)
                                                    throws PolicyManagerException

Description copied from interface: IUpdateService

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.

Specified by:: addAttachmentEntries in interface IUpdateService

Parameters:: polSubject - policy subject to be added; polRefs - 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:: PolicyManagerException

removeAttachmentEntries

protected void removeAttachmentEntries(String attachmentName,
                                       List<IPolicySubject> resourcePatterns)
                                throws PolicyManagerException

Throws:: PolicyManagerException

deleteAttachmentEntries

public IPolicySubjectAttachmentResult deleteAttachmentEntries(IPolicySubject polSubject,
                                                              List<IPolicyReference> polRefs)
                                                       throws PolicyManagerException

Description copied from interface: IUpdateService

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.

Specified by:: deleteAttachmentEntries in interface IUpdateService

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

deleteAttachmentEntries

public void deleteAttachmentEntries(String resourcePattern)
                             throws PolicyManagerException

Description copied from interface: IUpdateService

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

Specified by:: deleteAttachmentEntries in interface IStringUpdateService
Specified by:: deleteAttachmentEntries in interface IUpdateService

Parameters:: resourcePattern - Policy subject to be removed
Throws:: PolicyManagerException

updateAttachmentEntries

public IPolicySubjectAttachmentResult updateAttachmentEntries(IPolicySubject polSubject,
                                                              List<IPolicyReference> polRefs)
                                                       throws PolicyManagerException

Description copied from interface: IUpdateService

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

Specified by:: updateAttachmentEntries in interface IUpdateService

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

updateAttachmentEntries

public IPolicySubjectAttachmentResult updateAttachmentEntries(IPolicySubject polSubject,
                                                              List<IPolicyReference> polRefs,
                                                              boolean runPolSubjVal)
                                                       throws PolicyManagerException

Description copied from interface: IUpdateService

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

Specified by:: updateAttachmentEntries in interface IUpdateService

Returns:
Throws:: PolicyManagerException

deleteAllAttachments

public void deleteAllAttachments()
                          throws PolicyManagerException

Description copied from interface: IUpdateService

Deletes all policy attachments from data store

Specified by:: deleteAllAttachments in interface IStringUpdateService
Specified by:: deleteAllAttachments in interface IUpdateService

Throws:: PolicyManagerException

getCreator

protected String getCreator()

areTransactionsSupported

public boolean areTransactionsSupported()

Description copied from interface: IUpdateService

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)

Specified by:: areTransactionsSupported in interface IStringUpdateService
Specified by:: areTransactionsSupported in interface IUpdateService

Returns:: True if the back end datastore supports transactions, false otherwise