com.webify.wsf.engine.policy
Class Assertion

java.lang.Object
  extended by com.webify.wsf.engine.policy.Assertion

public abstract class Assertion
extends java.lang.Object

Policy assertion data type. Provides access to select meta-data, annotations, and asserted properties of a policy assertion. Not intended to be subclassed by clients.

Version:
$Revision: $
Author:
msanchez, dilumr@us.ibm.com

Field Summary
static java.lang.String SCOPE_ANY
           
static java.lang.String SCOPE_ENDPOINT_SELECTION
           
 
Constructor Summary
Assertion()
           
 
Method Summary
abstract  java.util.Set annotationPropertyNameSet()
          Gets the names of all the annotation properties bound to this assertion.
abstract  java.util.Set assertedPropertyNameSet()
          Gets the names of all the asserted properties bound to this assertion.
abstract  boolean equals(java.lang.Object other)
           
abstract  java.lang.String getAnnotation(java.lang.String name)
          Gets the annotation property with the specified name.
abstract  java.lang.Object getAssertedProperty(java.lang.String name)
          Gets the asserted property with the specified name.
abstract  java.lang.Object getProperty(java.lang.String name)
          Get the property with the specified name.
 java.lang.String getSourceUri()
          Gets the URI of the source or owner of this URI.
abstract  java.lang.String getType()
          Get the declared type of this assertion.
abstract  int hashCode()
           
abstract  boolean isAutomatic()
          Specifies whether this behaves as a placeholder in the composite policy in case a corresponding assertion is supplied in the context.
abstract  boolean isLocked()
          Determine the value of the locked property on this assertion.
abstract  boolean isRequired()
          Determine the value of the required property on this assertion.
abstract  boolean isVisible()
          Determine the value of the visible property on this assertion.
abstract  java.util.Set propertyNameSet()
          Gets the names of all the properties bound to this assertion.
abstract  void setAssertedProperty(java.lang.String name, java.lang.Object value)
          Sets the asserted property with the specified name.
abstract  void setAutomatic(boolean automatic)
           
abstract  void setLocked(boolean locked)
          Set the value of the locked property on this assertion.
abstract  void setRequired(boolean required)
          Set the value of the required property on this assertion.
abstract  void setVisible(boolean visible)
          Set the value of the visible property on this assertion.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCOPE_ANY

public static final java.lang.String SCOPE_ANY
See Also:
Constant Field Values

SCOPE_ENDPOINT_SELECTION

public static final java.lang.String SCOPE_ENDPOINT_SELECTION
See Also:
Constant Field Values
Constructor Detail

Assertion

public Assertion()
Method Detail

getType

public abstract java.lang.String getType()
Get the declared type of this assertion.

Returns:
a uri for the declated type of the assertion

getSourceUri

public java.lang.String getSourceUri()
Gets the URI of the source or owner of this URI.

Returns:
possibly null string.
Since:
WBSF 6.1

isRequired

public abstract boolean isRequired()
Determine the value of the required property on this assertion. The required property determines whether or not this assertion must be satisfied when considering its policy.

Returns:
true if the assertion is required, false otherwise

setRequired

public abstract void setRequired(boolean required)
Set the value of the required property on this assertion. The required property determines whether or not this assertion must be satisfied when considering its policy.

Parameters:
required - the new value of the required property

isLocked

public abstract boolean isLocked()
Determine the value of the locked property on this assertion. The locked property determines whether or not this assertion is locked at the associated level meaning it can not be overriden by a policy at a lower level.

Returns:
true if the assertion is locked, false otherwise

setLocked

public abstract void setLocked(boolean locked)
Set the value of the locked property on this assertion. The locked property determines whether or not this assertion is locked at the associated level meaning it can not be overriden by a policy at a lower level.

Parameters:
locked - the new value of the locked property

isAutomatic

public abstract boolean isAutomatic()
Specifies whether this behaves as a placeholder in the composite policy in case a corresponding assertion is supplied in the context. Assertions marked as automatic appear in the composite policy if any of their properties are included in the invocation context. All Assertions marked as automatic will have their property values replaced by the corresponding property value from the context, even those marked as DuplicateAllowed.

Returns:
true if the assertion is automatic, false otherwise

setAutomatic

public abstract void setAutomatic(boolean automatic)

isVisible

public abstract boolean isVisible()
Determine the value of the visible property on this assertion. The visible property determines whether or not this assertion is visible in the associated context.

Returns:
true if the assertion is visible, false otherwise

setVisible

public abstract void setVisible(boolean visible)
Set the value of the visible property on this assertion. The visible property determines whether or not this assertion is visible in the associated context.

Parameters:
visible - the new value of the visible property

propertyNameSet

public abstract java.util.Set propertyNameSet()
Gets the names of all the properties bound to this assertion.

Returns:
non-null set of property name URIs in String form; an empty set indicates that no properties are bound.

getProperty

public abstract java.lang.Object getProperty(java.lang.String name)
Get the property with the specified name.

Parameters:
name - the property name
Returns:
the property value for the specified name or null

assertedPropertyNameSet

public abstract java.util.Set assertedPropertyNameSet()
Gets the names of all the asserted properties bound to this assertion.

Returns:
the names of all the asserted properties or empty set if no asserted properties are bound

getAssertedProperty

public abstract java.lang.Object getAssertedProperty(java.lang.String name)
Gets the asserted property with the specified name.

Parameters:
name - the asserted property name
Returns:
the asserted property value or null

setAssertedProperty

public abstract void setAssertedProperty(java.lang.String name,
                                         java.lang.Object value)
Sets the asserted property with the specified name.

Parameters:
name - the asserted property name
value - the asserted property value

annotationPropertyNameSet

public abstract java.util.Set annotationPropertyNameSet()
Gets the names of all the annotation properties bound to this assertion.

Returns:
the names of all the annotation properties or empty set if no annotations properties are bound

getAnnotation

public abstract java.lang.String getAnnotation(java.lang.String name)
Gets the annotation property with the specified name.

Parameters:
name - the name of the annotation property
Returns:
the annotation property value or null

equals

public abstract boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

hashCode

public abstract int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2002-2009 IBM. All Rights Reserved.