Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Web Services Manager
11g (11.1.1)

E10689-01


oracle.wsm.policymanager
Interface IUpdateService

All Known Subinterfaces:
IUpdateServiceLocal, IUpdateServiceRemote
All Known Implementing Classes:
UpdateService, UpdateService, UpdateServiceDelegate

public interface IUpdateService

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.
 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
 IPolicy createPolicy(IPolicy policy)
          Adds a new policy to the backend datastore
 List<IPolicy> createPolicy(List<IPolicy> polList)
          Bulk creation of policies
 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 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.
 void deletePolicies(List<String> polNameList)
          Delete all the policies corresponding to the policy names passed
 void deletePolicy(IPolicy policy)
          Deletes a policy to the backend datastore
 void deletePolicy(String policyName)
          Deletes a policy to the backend datastore
 void deletePolicyVersions(String policyName, List<Long> versionNumbers)
          Delete all the specified versions of a policy
 IAssertionTemplate promoteAssertionTemplateToTip(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.
 IAssertionTemplate updateAssertionTemplate(IAssertionTemplate assertionTemplate)
          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
 List<IPolicy> updatePolicies(List<IPolicy> policies)
          Updates policies to the backend datastore
 IPolicy updatePolicy(IPolicy policy)
          Updates a policy to the backend datastore

 

Method Detail

createPolicy

IPolicy createPolicy(IPolicy policy)
                     throws PolicyManagerException
Adds a new policy to the backend datastore
Parameters:
policy - object to add
Returns:
The newly created policy object
Throws:
PolicyManagerException

createPolicy

List<IPolicy> createPolicy(List<IPolicy> polList)
                           throws PolicyManagerException
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

updatePolicy

IPolicy updatePolicy(IPolicy policy)
                     throws PolicyManagerException
Updates a policy to the backend datastore
Parameters:
Modified - policy object
Returns:
The modified policy objects
Throws:
PolicyManagerException

updatePolicies

List<IPolicy> updatePolicies(List<IPolicy> policies)
                             throws PolicyManagerException
Updates policies to the backend datastore
Parameters:
List - of policy objects to be modified
Returns:
List of the modified policy objects
Throws:
PolicyManagerException

deletePolicy

void deletePolicy(IPolicy policy)
                  throws PolicyManagerException
Deletes a policy to the backend datastore
Parameters:
policy - object
Throws:
PolicyManagerException

deletePolicy

void deletePolicy(String policyName)
                  throws PolicyManagerException
Deletes a policy to the backend datastore
Parameters:
String - policy name
Throws:
PolicyManagerException

createAssertionTemplate

IAssertionTemplate createAssertionTemplate(IAssertionTemplate assertionTemplate)
                                           throws PolicyManagerException
Adds a new Assertion template to the backend datastore
Parameters:
assertionTemplate - The AssertionTemplate object to add
Throws:
PolicyManagerException

deleteAssertionTemplate

void deleteAssertionTemplate(IAssertionTemplate assertionTemplate)
                             throws PolicyManagerException
Delete an Assertion template from backend datastore
Parameters:
assertionTemplate - The assertion Template object to be deleted
Throws:
PolicyManagerException

deleteAssertionTemplate

void deleteAssertionTemplate(String templateName)
                             throws PolicyManagerException
Delete an Assertion template from backend datastore
Parameters:
templateName - Name of the assertion template to be deleted
Throws:
PolicyManagerException

updateAssertionTemplate

IAssertionTemplate updateAssertionTemplate(IAssertionTemplate assertionTemplate)
                                           throws PolicyManagerException
Update an existing Assertion Template
Parameters:
assertionTemplate - The Assertion template object to be modified
Throws:
PolicyManagerException

promotePolicyToTip

IPolicy promotePolicyToTip(String policyName,
                           long version)
                           throws PolicyManagerException
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

deletePolicyVersions

void deletePolicyVersions(String policyName,
                          List<Long> versionNumbers)
                          throws PolicyManagerException
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

promoteAssertionTemplateToTip

IAssertionTemplate promoteAssertionTemplateToTip(String assertionTemplateName,
                                                 long version)
                                                 throws PolicyManagerException
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

deleteAssertionTemplateVersions

void deleteAssertionTemplateVersions(String assertionTemplateName,
                                     List<Long> versionNumbers)
                                     throws PolicyManagerException
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

deleteAllPolicies

void deleteAllPolicies()
                       throws PolicyManagerException
PERMENENTLY deletes ALL policies from the datastore Policies once deleted cannot be retrived
Throws:
PolicyManagerException

deletePolicies

void deletePolicies(List<String> polNameList)
                    throws PolicyManagerException
Delete all the policies corresponding to the policy names passed
Parameters:
polNameList - List of policy names to be be deleted
Throws:
PolicyManagerException

deleteAllAssertionTemplates

void deleteAllAssertionTemplates()
                                 throws PolicyManagerException
PERMENENTLY deletes ALL assertion templates from the datastore Assertion templates once deleted cannot be retrived
Throws:
PolicyManagerException

deleteAssertionTemplates

void deleteAssertionTemplates(List<String> assertionTemplateNames)
                              throws PolicyManagerException
Delete all the policies corresponding to the policy names passed
Parameters:
assertionTemplateNames - List of assertion template names to be be deleted
Throws:
PolicyManagerException

addAttachmentEntries

IPolicySubjectAttachmentResult addAttachmentEntries(IPolicySubject polSubject,
                                                    List<IPolicyReference> polRefs)
                                                    throws PolicyManagerException
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
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

deleteAttachmentEntries

IPolicySubjectAttachmentResult deleteAttachmentEntries(IPolicySubject polSubject,
                                                       List<IPolicyReference> polRefs)
                                                       throws PolicyManagerException
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

deleteAttachmentEntries

void deleteAttachmentEntries(String resourcePattern)
                             throws PolicyManagerException
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

deleteAttachmentEntries

void deleteAttachmentEntries(List<String> policySubject)
                             throws PolicyManagerException
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

updateAttachmentEntries

IPolicySubjectAttachmentResult updateAttachmentEntries(IPolicySubject polSubject,
                                                       List<IPolicyReference> polRefs)
                                                       throws PolicyManagerException
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

updateAttachmentEntries

IPolicySubjectAttachmentResult updateAttachmentEntries(IPolicySubject polSubject,
                                                       List<IPolicyReference> polRefs,
                                                       boolean runPolSubjVal)
                                                       throws PolicyManagerException
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

deleteAllAttachments

void deleteAllAttachments()
                          throws PolicyManagerException
Deletes all policy attachments from data store
Throws:
PolicyManagerException

areTransactionsSupported

boolean areTransactionsSupported()
                                 throws PolicyManagerException
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

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Web Services Manager
11g (11.1.1)

E10689-01


Copyright © 2007, 2009, Oracle and/or its affiliates. All rights reserved.