com.soa.policy.wspolicy

Class XmlAssertionMarshaller

java.lang.Object

com.soa.policy.wspolicy.XmlAssertionMarshaller

All Implemented Interfaces:

AssertionMarshaller

public class XmlAssertionMarshaller
extends java.lang.Object
implements AssertionMarshaller

XmlAssertionMarshaller can marshal and unmarshal XmlAssertions.

Constructor Summary

Constructors

Constructor and Description
XmlAssertionMarshaller()

Method Summary

Modifier and Type	Method and Description
void	addSupportedAssertion(javax.xml.namespace.QName assertionName) Adds an assertion identified by QName to the list of supported assertions.
void	addSupportedAssertions(java.util.List assertionNames) Adds a list of supported assertions identified by QName.
javax.xml.namespace.QName[]	getSupportedAssertions() Returns an array of QNames, each representing the name of an assertion that this AssertionMarshaller can marshal and unmarshal.
void	marshal(Assertion assertion, org.w3c.dom.Element element) Marshals the given assertion to the given element.
Assertion	unmarshal(org.w3c.dom.Element element) Unmarshals the given element to a new assertion instance created by this class.
Assertion	unmarshal(org.w3c.dom.Element element, Policy subPolicy) Identical semantics as unmarshal(Element), except sub-policy was found as a child (or children, in the case of multiple policy) of the given element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlAssertionMarshaller

public XmlAssertionMarshaller()

Method Detail

getSupportedAssertions

public javax.xml.namespace.QName[] getSupportedAssertions()

Description copied from interface: AssertionMarshaller

Returns an array of QNames, each representing the name of an assertion that this AssertionMarshaller can marshal and unmarshal. PolicyMarshaller uses this association of names to marshallers when deciding which marshaller to call when it has an assertion that needs to be marshaled or unmarshaled.

Specified by:

getSupportedAssertions in interface AssertionMarshaller

See Also:

AssertionMarshaller.getSupportedAssertions()

addSupportedAssertions

public void addSupportedAssertions(java.util.List assertionNames)
                            throws com.digev.fw.exception.GException

Adds a list of supported assertions identified by QName.

Parameters:

assertionNames - List of supported assertion QNames.

Throws:

com.digev.fw.exception.GException - Thrown if a list item is not a QName.

addSupportedAssertion

public void addSupportedAssertion(javax.xml.namespace.QName assertionName)

Adds an assertion identified by QName to the list of supported assertions.

Parameters:

assertionName - QName of the supported assertion.

marshal

public void marshal(Assertion assertion,
                    org.w3c.dom.Element element)
             throws com.digev.fw.exception.GException

Description copied from interface: AssertionMarshaller

Marshals the given assertion to the given element. The assertion should be of a type that this marshaller can marshal. The element is the already created element of the marshaled assertion, not its parent. In this way, marshaling does not involve creating the assertion but only filling the assertion. Additionally, this class is only expected to marshal domain specific policy aspects. Policy specific aspects, such as assertion name, assertion optional, assertion ignorable, and assertion sub-policy are all handled by the policy framework.

Note that assertion sub-policy will be handled by the policy framework only if the assertion is of type SubPolicyAssertion.

Specified by:

marshal in interface AssertionMarshaller

Parameters:

assertion - - the assertion to be marshaled.

element - - the already created element representing the assertion. The element should be filled by this class with domain specific data.

Throws:

com.digev.fw.exception.GException

See Also:

AssertionMarshaller.marshal(com.soa.policy.wspolicy.Assertion, org.w3c.dom.Element)

unmarshal

public Assertion unmarshal(org.w3c.dom.Element element)

Description copied from interface: AssertionMarshaller

Unmarshals the given element to a new assertion instance created by this class. The element should represent an assertion that this class can unmarshal. This class is only expected to unmarshal domain specific policy aspects. Policy specific aspects, such as assertion name, assertion optional, assertion ignorable, and assertion sub-policy are all handled by the policy framework. Note that any assertion sub-policy is not available to this class during unmarshaling. Sub-policy, if it exists, is only set on the assertion later in the unmarshaling process.

This method implies that the given element contains no sub-policy, and implementors should not search for sub-policy. If an implementor cannot unmarshal their assertion without sub-policy, they should not implement this method. Instead, throw GException(PolicyErrorCode.SUB_POLICY_REQUIRED)

Specified by:

unmarshal in interface AssertionMarshaller

Parameters:

element - representing the assertion to be unmarshaled.

Returns:

- A new assertion representing the assertion in the element.

See Also:

AssertionMarshaller.unmarshal(org.w3c.dom.Element)

unmarshal

public Assertion unmarshal(org.w3c.dom.Element element,
                           Policy subPolicy)
                    throws com.digev.fw.exception.GException

Description copied from interface: AssertionMarshaller

Identical semantics as unmarshal(Element), except sub-policy was found as a child (or children, in the case of multiple policy) of the given element. If an implementor cannot unmarshal their assertion with sub-policy (sub-policy does not make sense for a given assertion), they should not implement this method. Instead, throw GException(PolicyErrorCode.SUB_POLICY_NOT_SUPPORTED)

Specified by:

unmarshal in interface AssertionMarshaller

Parameters:

element - representing the assertion to be unmarshaled.

subPolicy - the sub-policy found as a child of the given element.

Throws:

com.digev.fw.exception.GException