Package com.aquima.interactions.communication.ds.xml.parsing

Class XmlRestMessageDS

java.lang.Object

com.aquima.interactions.foundation.report.ReportingDS

com.aquima.interactions.communication.ds.xml.parsing.XmlRestMessageDS

All Implemented Interfaces:

IRestMessageDS, IReportingDS

Direct Known Subclasses:

XmlRestRequestMessageDS

public class XmlRestMessageDS
extends ReportingDS
implements IRestMessageDS

Xml datasource implementation.

Since:

9.0

Author:

Arjan Pragt

Field Summary

Fields inherited from interface com.aquima.interactions.communication.ds.IRestMessageDS

CATEGORY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlRestMessageDS(IInitializationReport report, IXmlNode node)

Method Summary

Modifier and Type	Method	Description
String	getBodyAttributeName()	This method returns the attribute storing the xmlelement using as body, may be null.
IElementReferenceDS	getBodyElement()	This methods returns the qualified name of the element using as body of the message, may be null.
String	getBodySchema()	This method returns the name of the domain schema.
String	getEntityName()	This method returns the entity connected to the message.
void	iterateBodyValidations(IFieldValidationVisitor visitor)	This method iterates about the validations of the body attribute.
void	iterateHeaders(IRestHeaderVisitor visitor)	This method iterates about the headers of the message.

Methods inherited from class com.aquima.interactions.foundation.report.ReportingDS

addError, addMessage, getCategory, getReport

Methods inherited from class java.lang.Object

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

Constructor Details

XmlRestMessageDS

protected XmlRestMessageDS(IInitializationReport report,
 IXmlNode node)

Method Details

getEntityName

public String getEntityName()

Description copied from interface: IRestMessageDS

This method returns the entity connected to the message.

Specified by:

getEntityName in interface IRestMessageDS

Returns:

The name of the entity connected to the message, may be null

getBodyElement

public IElementReferenceDS getBodyElement()

Description copied from interface: IRestMessageDS

This methods returns the qualified name of the element using as body of the message, may be null. Must be null when using domain schemas.

Specified by:

getBodyElement in interface IRestMessageDS

Returns:

The qualified name of the xml element.

getBodySchema

public String getBodySchema()

Description copied from interface: IRestMessageDS

This method returns the name of the domain schema. Must be null when using schemasets.

Specified by:

getBodySchema in interface IRestMessageDS

Returns:

The name of the domain schema, or null in case of no body.

getBodyAttributeName

public String getBodyAttributeName()

Description copied from interface: IRestMessageDS

This method returns the attribute storing the xmlelement using as body, may be null.

Specified by:

getBodyAttributeName in interface IRestMessageDS

Returns:

The name of the attribute storing the xmlelement.

iterateHeaders

public void iterateHeaders(IRestHeaderVisitor visitor)
                    throws InitializationException

Description copied from interface: IRestMessageDS

This method iterates about the headers of the message.

Specified by:

iterateHeaders in interface IRestMessageDS

Parameters:

visitor - The visitor accepting the headers.

Throws:

InitializationException - This exception is thrown when the validation could not be initialized with the provided data source.

iterateBodyValidations

public void iterateBodyValidations(IFieldValidationVisitor visitor)
                            throws InitializationException

Description copied from interface: IRestMessageDS

This method iterates about the validations of the body attribute.

Specified by:

iterateBodyValidations in interface IRestMessageDS

Parameters:

visitor - The visitor accepting the validations.

Throws:

InitializationException - This exception is thrown when the validation could not be initialized with the provided data source.