com.sun.xml.ws.policy.sourcemodel

Class AssertionData

java.lang.Object

com.sun.xml.ws.policy.sourcemodel.AssertionData

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class AssertionData
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Wrapper class for possible data that each "assertion" and "assertion parameter content" policy source model node may have attached.

This data, when stored in an 'assertion' model node, is intended to be used as input parameter when creating PolicyAssertion objects via PolicyAssertionCreator implementations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<javax.xml.namespace.QName,java.lang.String>	attributes
private boolean	ignorable
private static PolicyLogger	LOGGER
private javax.xml.namespace.QName	name
private boolean	optional
private static long	serialVersionUID
private ModelNode.Type	type
private java.lang.String	value

Constructor Summary

Constructors

Constructor and Description
AssertionData(AssertionData data) Copy constructor.
AssertionData(javax.xml.namespace.QName name, java.lang.String value, java.util.Map<javax.xml.namespace.QName,java.lang.String> attributes, ModelNode.Type type, boolean optional, boolean ignorable) Constructs assertion data wrapper instance for an assertion or assertion parameter that contains a value or some attributes.

Method Summary

Modifier and Type	Method and Description
protected AssertionData	clone()
boolean	containsAttribute(javax.xml.namespace.QName name) Returns true if the given attribute exists, false otherwise.
static AssertionData	createAssertionData(javax.xml.namespace.QName name) Constructs assertion data wrapper instance for an assertion that does not contain any value nor any attributes.
static AssertionData	createAssertionData(javax.xml.namespace.QName name, java.lang.String value, java.util.Map<javax.xml.namespace.QName,java.lang.String> attributes, boolean optional, boolean ignorable) Constructs assertion data wrapper instance for an assertion that does contain a value or attributes.
static AssertionData	createAssertionParameterData(javax.xml.namespace.QName name) Constructs assertion data wrapper instance for an assertion parameter that does not contain any value nor any attributes.
static AssertionData	createAssertionParameterData(javax.xml.namespace.QName name, java.lang.String value, java.util.Map<javax.xml.namespace.QName,java.lang.String> attributes) Constructs assertion data wrapper instance for an assertion parameter that contains a value or attributes
boolean	equals(java.lang.Object obj)
java.util.Map<javax.xml.namespace.QName,java.lang.String>	getAttributes() Returns the disconnected map of attributes attached to the assertion.
java.util.Set<java.util.Map.Entry<javax.xml.namespace.QName,java.lang.String>>	getAttributesSet() Returns the disconnected set of attributes attached to the assertion.
java.lang.String	getAttributeValue(javax.xml.namespace.QName name) Returns the value of the given attribute.
javax.xml.namespace.QName	getName() Returns the name of the assertion.
ModelNode.Type	getNodeType()
java.lang.String	getValue() Returns the value of the assertion.
int	hashCode() An Object.hashCode() method override.
boolean	isIgnorableAttributeSet() Tests if the ignorable attribute is set.
boolean	isOptionalAttributeSet() Tests if the optional attribute is set.
boolean	isPrivateAttributeSet() Method specifies whether the assertion data contain proprietary visibility element set to "private" value.
java.lang.String	removeAttribute(javax.xml.namespace.QName name) Removes the given attribute from the assertion data.
void	setAttribute(javax.xml.namespace.QName name, java.lang.String value) Adds or overwrites an attribute.
void	setIgnorableAttribute(boolean value) Sets the ignorable attribute.
private void	setModelNodeType(ModelNode.Type type)
void	setOptionalAttribute(boolean value) Sets the optional attribute.
java.lang.String	toString()
java.lang.StringBuffer	toString(int indentLevel, java.lang.StringBuffer buffer) A helper method that appends indented string representation of this instance to the input string buffer.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

LOGGER

private static final PolicyLogger LOGGER

name

private final javax.xml.namespace.QName name

value

private final java.lang.String value

attributes

private final java.util.Map<javax.xml.namespace.QName,java.lang.String> attributes

type

private ModelNode.Type type

optional

private boolean optional

ignorable

private boolean ignorable

Constructor Detail

AssertionData

AssertionData(javax.xml.namespace.QName name,
              java.lang.String value,
              java.util.Map<javax.xml.namespace.QName,java.lang.String> attributes,
              ModelNode.Type type,
              boolean optional,
              boolean ignorable)
       throws java.lang.IllegalArgumentException

Constructs assertion data wrapper instance for an assertion or assertion parameter that contains a value or some attributes. Whether the data wrapper is constructed for assertion or assertion parameter node is distinguished by the supplied type parameter.

Parameters:

name - the FQN of the assertion or assertion parameter

value - a String representation of model node value

attributes - map of model node's <attribute name, attribute value> pairs

type - specifies whether the data will belong to the assertion or assertion parameter node. This is a workaround solution that allows us to transfer this information about the owner node to a policy assertion instance factory without actualy having to touch the PolicyAssertionCreator interface and protected PolicyAssertion constructors.

Throws:

java.lang.IllegalArgumentException - in case the type parameter is not ASSERTION or ASSERTION_PARAMETER_NODE

AssertionData

AssertionData(AssertionData data)

Copy constructor.

Parameters:

data - The instance that is to be copied.

Method Detail

createAssertionData

public static AssertionData createAssertionData(javax.xml.namespace.QName name)
                                         throws java.lang.IllegalArgumentException

Constructs assertion data wrapper instance for an assertion that does not contain any value nor any attributes.

Parameters:

name - the FQN of the assertion

Throws:

java.lang.IllegalArgumentException - in case the type parameter is not ASSERTION or ASSERTION_PARAMETER_NODE

createAssertionParameterData

public static AssertionData createAssertionParameterData(javax.xml.namespace.QName name)
                                                  throws java.lang.IllegalArgumentException

Constructs assertion data wrapper instance for an assertion parameter that does not contain any value nor any attributes.

Parameters:

name - the FQN of the assertion parameter

Throws:

java.lang.IllegalArgumentException - in case the type parameter is not ASSERTION or ASSERTION_PARAMETER_NODE

createAssertionData

public static AssertionData createAssertionData(javax.xml.namespace.QName name,
                                                java.lang.String value,
                                                java.util.Map<javax.xml.namespace.QName,java.lang.String> attributes,
                                                boolean optional,
                                                boolean ignorable)
                                         throws java.lang.IllegalArgumentException

Constructs assertion data wrapper instance for an assertion that does contain a value or attributes.

Parameters:

name - the FQN of the assertion

value - a String representation of model node value

attributes - map of model node's <attribute name, attribute value> pairs

optional - flag indicating whether the assertion is optional or not

ignorable - flag indicating whether the assertion is ignorable or not

Throws:

java.lang.IllegalArgumentException - in case the type parameter is not ASSERTION or ASSERTION_PARAMETER_NODE

createAssertionParameterData

public static AssertionData createAssertionParameterData(javax.xml.namespace.QName name,
                                                         java.lang.String value,
                                                         java.util.Map<javax.xml.namespace.QName,java.lang.String> attributes)
                                                  throws java.lang.IllegalArgumentException

Constructs assertion data wrapper instance for an assertion parameter that contains a value or attributes

Parameters:

name - the FQN of the assertion parameter

value - a String representation of model node value

attributes - map of model node's <attribute name, attribute value> pairs

Throws:

java.lang.IllegalArgumentException - in case the type parameter is not ASSERTION or ASSERTION_PARAMETER_NODE

setModelNodeType

private void setModelNodeType(ModelNode.Type type)
                       throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

clone

protected AssertionData clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

containsAttribute

public boolean containsAttribute(javax.xml.namespace.QName name)

Returns true if the given attribute exists, false otherwise.

Parameters:

name - The name of the attribute. Must not be null.

Returns:

True if the given attribute exists, false otherwise.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAttributeValue

public java.lang.String getAttributeValue(javax.xml.namespace.QName name)

Returns the value of the given attribute. Returns null if the attribute does not exist.

Parameters:

name - The name of the attribute. Must not be null.

Returns:

The value of the given attribute. Returns null if the attribute does not exist.

getAttributes

public java.util.Map<javax.xml.namespace.QName,java.lang.String> getAttributes()

Returns the disconnected map of attributes attached to the assertion.

'Disconnected' means, that the result of this method will not be synchronized with any consequent assertion's attribute modification. It is also important to notice that a manipulation with returned set of attributes will not have any effect on the actual assertion's attributes.

Returns:

disconnected map of attributes attached to the assertion.

getAttributesSet

public java.util.Set<java.util.Map.Entry<javax.xml.namespace.QName,java.lang.String>> getAttributesSet()

Returns the disconnected set of attributes attached to the assertion. Each attribute is represented as a single Map.Entry<attributeName, attributeValue> element.

'Disconnected' means, that the result of this method will not be synchronized with any consequent assertion's attribute modification. It is also important to notice that a manipulation with returned set of attributes will not have any effect on the actual assertion's attributes.

Returns:

disconnected set of attributes attached to the assertion.

getName

public javax.xml.namespace.QName getName()

Returns the name of the assertion.

Returns:

assertion's name

getValue

public java.lang.String getValue()

Returns the value of the assertion.

Returns:

assertion's value

hashCode

public int hashCode()

An Object.hashCode() method override.

Overrides:

hashCode in class java.lang.Object

isPrivateAttributeSet

public boolean isPrivateAttributeSet()

Method specifies whether the assertion data contain proprietary visibility element set to "private" value.

Returns:

'true' if the attribute is present and set properly (i.e. the node containing this assertion data instance should not be marshaled into generated WSDL documents). Returns false otherwise.

removeAttribute

public java.lang.String removeAttribute(javax.xml.namespace.QName name)

Removes the given attribute from the assertion data.

Parameters:

name - The name of the attribute. Must not be null

Returns:

The value of the removed attribute.

setAttribute

public void setAttribute(javax.xml.namespace.QName name,
                         java.lang.String value)

Adds or overwrites an attribute.

Parameters:

name - The name of the attribute.

value - The value of the attribute.

setOptionalAttribute

public void setOptionalAttribute(boolean value)

Sets the optional attribute.

Parameters:

value - The value of the optional attribute.

isOptionalAttributeSet

public boolean isOptionalAttributeSet()

Tests if the optional attribute is set.

Returns:

True if optional is set and is true. False otherwise.

setIgnorableAttribute

public void setIgnorableAttribute(boolean value)

Sets the ignorable attribute.

Parameters:

value - The value of the ignorable attribute.

isIgnorableAttributeSet

public boolean isIgnorableAttributeSet()

Tests if the ignorable attribute is set.

Returns:

True if ignorable is set and is true. False otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.StringBuffer toString(int indentLevel,
                                       java.lang.StringBuffer buffer)

A helper method that appends indented string representation of this instance to the input string buffer.

Parameters:

indentLevel - indentation level to be used.

buffer - buffer to be used for appending string representation of this instance

Returns:

modified buffer containing new string representation of the instance

getNodeType

public ModelNode.Type getNodeType()