Skip navigation links

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

E10689-01


oracle.wsm.policy.model
Interface IPolicy

All Superinterfaces:
IAndCompositeAssertion, IAssertion, IAssertionAdvertiser, ICompositeAssertion, Serializable
All Known Implementing Classes:
Policy

public interface IPolicy
extends IAndCompositeAssertion

Represents a wsp:Policy XML element.
A wsp:Policy has the same semantics as wsp:All in terms of the normalization, merge intersection semantics.


Nested Class Summary
static class IPolicy.STATUS
          Currently only enabled, disabled are used.

 

Nested classes/interfaces inherited from interface oracle.wsm.policy.model.IAssertion
IAssertion.AssertionTypes

 

Field Summary
static String DISABLED
           
static QName displayNameAttrQName
           
static String ENABLED
           
static QName idAttrQName
           
static QName localOptimizationAttrQName
           
static QName nameAttrQName
           
static QName oracleSmartDigestAttrQName
           
static QName pipelineAttrQName
           
static QName revPipelineAttrQName
           
static QName smartDigestAttrQName
           
static QName validationClassNameAttrQName
           

 

Method Summary
 IPolicyReference createLocalPolicyReference(boolean includeOracleExtensions)
          WS-Policy Attachment defines two types of Policy Referneces.
 IPolicyReference createRemotePolicyReference(boolean includeOracleExtensions)
          WS-Policy Attachment defines two types of Policy Referneces.
 String getAttachTo()
           
 String getCategory()
          Convenience method to retrive the orawsp:category attribute on a <wsp:Policy> element.
 String getDescription()
          Convenience method to retrive the orawsp:description attribute on a <wsp:Policy> element.
 String getDescription(Locale locale)
          Convenience method to retrive localized orawsp:description attribute on a <wsp:Policy> element.
 String getDisplayName()
          Convenience method to retrive the orawsp:displayName attribute on a <wsp:Policy> element.
 String getDisplayName(Locale locale)
          Convenience method to retrive localized orawsp:displayName attribute on a <wsp:Policy> element.
 String getLocalOptimization()
          Returns the local-optimzation attribute value of the policy
 String getOracleSmartDigest()
          Return the oracle fast path digest for the policy
 String getPolicyId()
          Convenience method to retrive the wsu:Id attribute on a <wsp:Policy> element.
 String getPolicyName()
          Convenience method to retrive the wsp:Name attribute on a <wsp:Policy> element.
 String getSmartDigest()
          Return the smart digest for the policy
 IPolicy.STATUS getStatus()
           
 int getSubjectCount()
          Get a count of subject to which this policy is attached to
 String getValidatorClass()
          Returns the name of validator class set for this Policy object
 List<String> getValidAttachToValues()
           
 IVersionInfo getVersionInfo()
           
 boolean hasPolicyAlternatives()
          Returns true if the Policy has alternatives i.e.
 boolean isEnabled()
          Convenience method returns true if getStatus() returns STATUS.enabled
 boolean isPipeline()
          Convenience method to retrive the orawsp:Pipeline attribute on a <wsp:Policy> element.
 boolean isReferenceablePolicy()
           
 boolean isReversePipeline()
          Convenience method to set the orawsp:ReversePipeline attribute on a <wsp:Policy> element.
 void setAttachTo(String attachTo)
           
 void setCategory(String category)
          Set category
 void setDescription(String description)
          Set description
 void setDisplayName(String displayName)
          Convenience method to set the orawsp:displayName attribute on a <wsp:Policy> element.
 void setLocalOptimzation(String localOptimization)
          Sets the local-optimzation parameter value
 void setOracleSmartDigest(String digest)
          Set the value for the attribute "oraSmartDigest" - it represents the "hash" of the value returned by the getDigest call for Policies containing oracle scenario assertions.
 void setPipeline(boolean isPipeline)
          Set the orawsp:Pipeline attribute
 void setPolicyId(String id)
           
 void setPolicyName(String name)
           
 void setReversePipeline(boolean revPipeline)
          Convenience method to set the orawsp:ReversePipeline attribute on a <wsp:Policy> element.
 void setSmartDigest(String digest)
          Set the value for the attribute "smartDigest" - it represents the "hash" of the value returned by the getDigest call.
 void setStatus(IPolicy.STATUS status)
           
 void setSubjectCount(int subjectCount)
          Set the number of end-points that reference this policy
 void setValidatorClass(String className)
          Sets the class name of the java class to validate this policy
 void setVersionInfo(IVersionInfo versionInfo)
           

 

Methods inherited from interface oracle.wsm.policy.model.ICompositeAssertion
addAssertion, addAssertion, addAssertions, clearAssertions, getAssertion, getAssertions, getAssertionsArray, getAssertionsByQName, isEmpty, removeAssertion, removeAssertions, setAssertions, size

 

Methods inherited from interface oracle.wsm.policy.model.IAssertion
addAttribute, createInstance, getAssertionType, getAttribute, getAttributes, getDigest, getDigest, getParent, getQName, getStringForMatching, hasParent, intersect, intersect, isIdentical, isNormalized, isOptional, merge, merge, normalize, normalize, removeAttribute, setAttributes, setNormalized, setOptional, setParent, validate

 

Methods inherited from interface oracle.wsm.policy.advertisement.IAssertionAdvertiser
advertiseOracleWSPolicy, advertiseWSPolicy

 

Field Detail

ENABLED

static final String ENABLED
See Also:
Constant Field Values

DISABLED

static final String DISABLED
See Also:
Constant Field Values

idAttrQName

static final QName idAttrQName

nameAttrQName

static final QName nameAttrQName

revPipelineAttrQName

static final QName revPipelineAttrQName

pipelineAttrQName

static final QName pipelineAttrQName

validationClassNameAttrQName

static final QName validationClassNameAttrQName

localOptimizationAttrQName

static final QName localOptimizationAttrQName

displayNameAttrQName

static final QName displayNameAttrQName

smartDigestAttrQName

static final QName smartDigestAttrQName

oracleSmartDigestAttrQName

static final QName oracleSmartDigestAttrQName

Method Detail

isReferenceablePolicy

boolean isReferenceablePolicy()

getPolicyId

String getPolicyId()
Convenience method to retrive the wsu:Id attribute on a <wsp:Policy> element.
This is equivalent to getAttributes().get(idAttrQName).

setReversePipeline

void setReversePipeline(boolean revPipeline)
Convenience method to set the orawsp:ReversePipeline attribute on a <wsp:Policy> element.

isReversePipeline

boolean isReversePipeline()
Convenience method to set the orawsp:ReversePipeline attribute on a <wsp:Policy> element.
This is equivalent to setAttributes().get(revPipelineAttrQName).

getPolicyName

String getPolicyName()
Convenience method to retrive the wsp:Name attribute on a <wsp:Policy> element.
This is equivalent to getAttributes().get(nameAttrQName).

setPolicyId

void setPolicyId(String id)

setPolicyName

void setPolicyName(String name)

hasPolicyAlternatives

boolean hasPolicyAlternatives()
Returns true if the Policy has alternatives i.e. it is not an empty Policy.
Returns:

getCategory

String getCategory()
Convenience method to retrive the orawsp:category attribute on a <wsp:Policy> element.
This is equivalent to getAttributes().get(categoryAttrQName).

setCategory

void setCategory(String category)
Set category
Parameters:
category -

setDescription

void setDescription(String description)
Set description
Parameters:
description -

getDescription

String getDescription()
Convenience method to retrive the orawsp:description attribute on a <wsp:Policy> element.
This is equivalent to getAttributes().get(categoryAttrQName).

getDescription

String getDescription(Locale locale)
Convenience method to retrive localized orawsp:description attribute on a <wsp:Policy> element.
This will check if the description field has the above key for the provided locale. If so it will lookup the resource bundle and return the localized description.
Parameters:
locale -

createLocalPolicyReference

IPolicyReference createLocalPolicyReference(boolean includeOracleExtensions)
WS-Policy Attachment defines two types of Policy Referneces.
References to Policy within an XML document - a.k.a intra-document linkages and References to Policy external to the XML document.
This method creates a PolicyReference that can be used for intra-document linkages i.e. the URI attribute is set to Id attribute of the Policy (actually #<value-of-Id> attribute).
Returns null if getPolicyId() returns null i.e. if the Policy does not have an wsu:Id attribute then the Policy does not support intra-document linkages.
Note: Both wsu:Id and wsp:Name can be null.
If the includeOracleExtensions is true then the category, etc is included in the PolicyReference.
Returns:

createRemotePolicyReference

IPolicyReference createRemotePolicyReference(boolean includeOracleExtensions)
WS-Policy Attachment defines two types of Policy Referneces.
References to Policy within an XML document - a.k.a intra-document linkages and References to Policy external to the XML document.
This method creates a PolicyReference that can be used for inter-document linkages i.e. the URI attribute is set to 'Name' of the Policy.
Returns null if getPolicyName() returns null i.e. if the Policy does not have an wsp:Name attribute then the Policy does not support inter-document linkages.
Note: Both wsu:Id and wsp:Name can be null.
If the includeOracleExtensions is true then the category, etc is included in the PolicyReference.
Returns:

isPipeline

boolean isPipeline()
Convenience method to retrive the orawsp:Pipeline attribute on a <wsp:Policy> element.
Attribute to indicate that ordering of the Assertions is important.
This attribute is ignored in the intersection, merge, normalization semantics.
Returns:

setPipeline

void setPipeline(boolean isPipeline)
Set the orawsp:Pipeline attribute
Parameters:
isPipeline - - true if it is a pipeline

isEnabled

boolean isEnabled()
Convenience method returns true if getStatus() returns STATUS.enabled
Returns:

setStatus

void setStatus(IPolicy.STATUS status)

getStatus

IPolicy.STATUS getStatus()

getAttachTo

String getAttachTo()

setAttachTo

void setAttachTo(String attachTo)

setVersionInfo

void setVersionInfo(IVersionInfo versionInfo)

getVersionInfo

IVersionInfo getVersionInfo()

setValidatorClass

void setValidatorClass(String className)
Sets the class name of the java class to validate this policy
Parameters:
className - fully qualified class name of the validator class

getValidatorClass

String getValidatorClass()
Returns the name of validator class set for this Policy object
Returns:
Fully qualified class name of the validating class

getValidAttachToValues

List<String> getValidAttachToValues()
Returns:
the valid attach to values

getSubjectCount

int getSubjectCount()
Get a count of subject to which this policy is attached to
Returns:

setSubjectCount

void setSubjectCount(int subjectCount)
Set the number of end-points that reference this policy
Parameters:
subjectCount -

getLocalOptimization

String getLocalOptimization()
Returns the local-optimzation attribute value of the policy
Returns:

setLocalOptimzation

void setLocalOptimzation(String localOptimization)
Sets the local-optimzation parameter value
Parameters:
localOptimization -

getDisplayName

String getDisplayName()
Convenience method to retrive the orawsp:displayName attribute on a <wsp:Policy> element.
This is equivalent to getAttributes().get(displayNameAttrQName).

getDisplayName

String getDisplayName(Locale locale)
Convenience method to retrive localized orawsp:displayName attribute on a <wsp:Policy> element.
This will check if the description field has the above key for the provided locale. If so it will lookup the resource bundle and return the localized description.
Parameters:
locale -

setDisplayName

void setDisplayName(String displayName)
Convenience method to set the orawsp:displayName attribute on a <wsp:Policy> element.

setSmartDigest

void setSmartDigest(String digest)
Set the value for the attribute "smartDigest" - it represents the "hash" of the value returned by the getDigest call.
Parameters:
digest - - This is the string representation of the "hash" of the value returned by the method

getSmartDigest

String getSmartDigest()
Return the smart digest for the policy
Returns:
String - returns the value of the attribute "smartDigest"

setOracleSmartDigest

void setOracleSmartDigest(String digest)
Set the value for the attribute "oraSmartDigest" - it represents the "hash" of the value returned by the getDigest call for Policies containing oracle scenario assertions.
Parameters:
digest - - This is the string representation of the "hash" of the value returned by the method

getOracleSmartDigest

String getOracleSmartDigest()
Return the oracle fast path digest for the policy
Returns:
This is the string representation of the "hash" of the value returned by the method

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.