org.apache.neethi
Class Policy

java.lang.Object
  extended by org.apache.neethi.AbstractPolicyOperator
      extended by org.apache.neethi.All
          extended by org.apache.neethi.Policy
All Implemented Interfaces:
PolicyComponent, PolicyOperator

public class Policy
extends All

Policy is a PolicyOperator that requires to statisfy all of its PolicyComponents. It is always the outermost component of a Policy.


Field Summary
 
Fields inherited from class org.apache.neethi.AbstractPolicyOperator
policyComponents
 
Constructor Summary
Policy()
           
 
Method Summary
 void addAttribute(javax.xml.namespace.QName name, java.lang.String value)
          Adds an attribute to self.
 java.util.Iterator getAlternatives()
          Returns an Iterator that will return a list of assertions correspond to a Policy alternative if any.
 java.lang.String getAttribute(javax.xml.namespace.QName name)
          Returns the value of the attribute specified by the QName.
 java.util.Map getAttributes()
          Returns a Map of all attributes of self.
 java.lang.String getId()
          Returns the Id attribute of self.
 java.lang.String getName()
          Returns the Name attribute of self.
 short getType()
          Returns Constants.TYPE_POLICY
 Policy intersect(Policy policy)
          Throws an UnSupportedOpertionException.
 Policy merge(Policy policy)
          Returns a Policy that is the merge of specified Policy and self.
 PolicyComponent normalize(boolean deep)
          Returns a Normalized version of self.
 PolicyComponent normalize(PolicyRegistry reg, boolean deep)
          Returns a normalized version of self.If deep is set false then the assertions are not normalized and it returns a partially normalized version of self.
 void serialize(javax.xml.stream.XMLStreamWriter writer)
          Serializes the Policy to a XMLStreamWriter.
 void setId(java.lang.String id)
          Sets the wsu:Id attribute of self.
 void setName(java.lang.String name)
          Sets the Name attribute of self.
 
Methods inherited from class org.apache.neethi.All
addAssertion, getAssertions
 
Methods inherited from class org.apache.neethi.AbstractPolicyOperator
addPolicyComponent, addPolicyComponents, equal, getFirstPolicyComponent, getPolicyComponents, isEmpty, normalize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Policy

public Policy()
Method Detail

normalize

public PolicyComponent normalize(boolean deep)
Returns a Normalized version of self. If deep is set false then the assertions are not normalized and it returns a partially normalized version of self.

Parameters:
deep - a flag to indicate whether to normalize the assertions
Returns:
a PolicyComponent that is normalized version of self

normalize

public PolicyComponent normalize(PolicyRegistry reg,
                                 boolean deep)
Returns a normalized version of self.If deep is set false then the assertions are not normalized and it returns a partially normalized version of self.

Parameters:
reg - a PolicyRegistry from which the PolicyReferences are resolved
deep - a flag to indicate whether to normalize the assertions
Returns:
a normalzied version of self

merge

public Policy merge(Policy policy)
Returns a Policy that is the merge of specified Policy and self.

Parameters:
policy - the Policy to be merged with self
Returns:
a Policy that is the merge of the specified Policy and self

intersect

public Policy intersect(Policy policy)
Throws an UnSupportedOpertionException. TODO for a next version.


serialize

public void serialize(javax.xml.stream.XMLStreamWriter writer)
               throws javax.xml.stream.XMLStreamException
Serializes the Policy to a XMLStreamWriter.

Specified by:
serialize in interface PolicyComponent
Overrides:
serialize in class All
Parameters:
writer - the writer that the component should write itself
Throws:
javax.xml.stream.XMLStreamException - if an errors in the process of serialization of the PolicyComponent.

getType

public short getType()
Returns Constants.TYPE_POLICY

Specified by:
getType in interface PolicyComponent
Overrides:
getType in class All
Returns:
Constants.POLICY for Policy type PolicyComponent Constants.EXACTLYONE for ExactlyOne type PolicyComponent Constants.ALL for All type PolicyComponent Constants.ASSERTION for Assertion type PolicyComponent

getAlternatives

public java.util.Iterator getAlternatives()
Returns an Iterator that will return a list of assertions correspond to a Policy alternative if any. The iterator.next() will return a list of assertions correspond to a Policy alternative if any and iterator.hasNext() will indicates whether there is another Policy alternative.

Returns:

addAttribute

public void addAttribute(javax.xml.namespace.QName name,
                         java.lang.String value)
Adds an attribute to self.

Parameters:
name - the name of the attribute
value - the value of the attribute

getAttribute

public java.lang.String getAttribute(javax.xml.namespace.QName name)
Returns the value of the attribute specified by the QName. Returns null if not present.

Parameters:
name - the QName of the attribute
Returns:
the value of the attribute specified by the QName

getAttributes

public java.util.Map getAttributes()
Returns a Map of all attributes of self.

Returns:
a Map of all attributes of self

setName

public void setName(java.lang.String name)
Sets the Name attribute of self.

Parameters:
name - the Name attribute of self

getName

public java.lang.String getName()
Returns the Name attribute of self.

Returns:
the Name attribute of self

setId

public void setId(java.lang.String id)
Sets the wsu:Id attribute of self.

Parameters:
id - the Id attribute of self

getId

public java.lang.String getId()
Returns the Id attribute of self.

Returns:
the Id attribute of self


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.