Skip navigation links

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

E10689-01


oracle.wsm.policy.model.impl
Class PolicySet

java.lang.Object
  extended by oracle.wsm.policy.model.impl.PolicySet

All Implemented Interfaces:
Serializable, IPolicySet

public class PolicySet
extends Object
implements IPolicySet
See Also:
Serialized Form

Nested Class Summary

 

Nested classes/interfaces inherited from interface oracle.wsm.policy.model.IPolicySet
IPolicySet.LOCAL_OPTIMIZATION, IPolicySet.POLICYSET_STATUS

 

Constructor Summary
PolicySet()
           

 

Method Summary
 void addCause(IValidationError error)
           
 void addPolicy(IPolicy policy)
          Adds the policy in the PolicySet.
 void addPolicy(IPolicy policy, String name)
          Adds the policy in the PolicySet.
 void addPolicyAttachment(IPolicyAttachment attachment)
          Adds PolicyAttachment to the PolicySet.
 IPolicySet.LOCAL_OPTIMIZATION checkLocalOptimization()
          This method will return the local optimzation value of this policyset
 void clearPolicies()
          Clears the policy in the PolicySet.
 void clearPolicyAttachments()
           
 IPolicy dereference(IPolicyReference polRef)
          Gets the policy from its policy reference.
 boolean equals(Object obj)
          Compare two policy sets for equality.
 List<IValidationError> getCause()
          Each IValidatoinError object contains the appropriate error code and corresponding message about what went wrong in retrieving the policies.
 List<IPolicy> getPolicies()
           
 List<IPolicy> getPolicies(String category)
          Returns list of policies that matches the given category
 List<IPolicy> getPolicies(String category, String resourcePattern)
          Returns the Policy Object
 List<IPolicyAttachment> getPolicyAttachments()
          Gets the policy attachements from the PolicySet.
 QName getQName()
           
 IPolicySet.POLICYSET_STATUS getStatus()
          Provides POLICYSET_STATUS enumeration object indicating the status of policyset.
 Date getTimestamp()
          Get timestamp of policy store from when this set was constructed.
 int hashCode()
           
 void removePolicy(IPolicy policy)
          Removes the policy from the PolicySet.
 void removePolicyAttachment(IPolicyAttachment policyAttachment)
           
 void setCause(List<IValidationError> cause)
          sets the error objects
 void setPolicies(List<IPolicy> policies)
          set Policies in the PolicySet
 void setStatus(IPolicySet.POLICYSET_STATUS psStatus)
          Set the status of the policyset
 void setTimestamp(Date setTimestamp)
          Set timestamp of store form which the policies were obtained.
 String toString()
           
 void validate(IValidationContext context)
          Performs PolicySet validation.

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Constructor Detail

PolicySet

public PolicySet()

Method Detail

getQName

public QName getQName()
Specified by:
getQName in interface IPolicySet

setPolicies

public void setPolicies(List<IPolicy> policies)
Description copied from interface: IPolicySet
set Policies in the PolicySet
Specified by:
setPolicies in interface IPolicySet

addPolicy

public void addPolicy(IPolicy policy)
Adds the policy in the PolicySet.
Parameters:
policy -

addPolicy

public void addPolicy(IPolicy policy,
                      String name)
Adds the policy in the PolicySet.
Parameters:
policy - Policy to add
name - Name to use for policy

clearPolicies

public void clearPolicies()
Clears the policy in the PolicySet.

removePolicy

public void removePolicy(IPolicy policy)
Removes the policy from the PolicySet.
Parameters:
policy -

getPolicyAttachments

public List<IPolicyAttachment> getPolicyAttachments()
Gets the policy attachements from the PolicySet.
Specified by:
getPolicyAttachments in interface IPolicySet
Returns:

addPolicyAttachment

public void addPolicyAttachment(IPolicyAttachment attachment)
Adds PolicyAttachment to the PolicySet.
Specified by:
addPolicyAttachment in interface IPolicySet
Parameters:
attachment - PolicyAttachment

clearPolicyAttachments

public void clearPolicyAttachments()

removePolicyAttachment

public void removePolicyAttachment(IPolicyAttachment policyAttachment)

dereference

public IPolicy dereference(IPolicyReference polRef)
Gets the policy from its policy reference.
Specified by:
dereference in interface IPolicySet
Parameters:
polRef -
Returns:

equals

public boolean equals(Object obj)
Compare two policy sets for equality. This comparison only evaluates the policies and policy attachments contained in the objects.
Overrides:
equals in class Object
Parameters:
obj - The PolicySet object to compare

getPolicies

public List<IPolicy> getPolicies(String category,
                                 String resourcePattern)
                          throws PolicyModelException
Returns the Policy Object
Specified by:
getPolicies in interface IPolicySet
Parameters:
category - the category Type
resourcePattern - the resource Pattern
Returns:
policyObject
Throws:
PolicyModelException - if no polices found for given resource pattern and category

getPolicies

public List<IPolicy> getPolicies(String category)
                          throws PolicyModelException
Returns list of policies that matches the given category
Specified by:
getPolicies in interface IPolicySet
Parameters:
category - category name
Returns:
list of policies
Throws:
PolicyModelException

getPolicies

public List<IPolicy> getPolicies()
Specified by:
getPolicies in interface IPolicySet
Returns:
List of <IPolicy>

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getCause

public List<IValidationError> getCause()
Description copied from interface: IPolicySet
Each IValidatoinError object contains the appropriate error code and corresponding message about what went wrong in retrieving the policies.
Specified by:
getCause in interface IPolicySet
Returns:
IValidatoinError object

setCause

public void setCause(List<IValidationError> cause)
Description copied from interface: IPolicySet
sets the error objects
Specified by:
setCause in interface IPolicySet
Parameters:
cause - all the errro messages

addCause

public void addCause(IValidationError error)
Specified by:
addCause in interface IPolicySet

getStatus

public IPolicySet.POLICYSET_STATUS getStatus()
Description copied from interface: IPolicySet
Provides POLICYSET_STATUS enumeration object indicating the status of policyset.
Specified by:
getStatus in interface IPolicySet
Returns:
FAILURE if there is any error in retrieving policyset or any invalid policy references etc and SUCCESS , in case of valid Policy References. *

setStatus

public void setStatus(IPolicySet.POLICYSET_STATUS psStatus)
Description copied from interface: IPolicySet
Set the status of the policyset
Specified by:
setStatus in interface IPolicySet

validate

public void validate(IValidationContext context)
Description copied from interface: IPolicySet
Performs PolicySet validation. A PolicySet contains a number of Policy Attachments and Policies. For each Policy Attachment performs Policy Subject Validation. The getErrorCode(), getCause(), etc are unrelated to errors returned by the Policy Subject Validation.
Specified by:
validate in interface IPolicySet

checkLocalOptimization

public IPolicySet.LOCAL_OPTIMIZATION checkLocalOptimization()
Description copied from interface: IPolicySet
This method will return the local optimzation value of this policyset
Specified by:
checkLocalOptimization in interface IPolicySet
Returns:

getTimestamp

public Date getTimestamp()
Description copied from interface: IPolicySet
Get timestamp of policy store from when this set was constructed.
Specified by:
getTimestamp in interface IPolicySet
Returns:
timestamp

setTimestamp

public void setTimestamp(Date setTimestamp)
Set timestamp of store form which the policies were obtained.
Parameters:
setTimestamp - timestamp of store

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.