Package com.aquima.interactions.communication.ds

Interface IRestMessageDS

All Known Subinterfaces:
IRestRequestMessageDS
All Known Implementing Classes:
ReportingRestMessageDS, ReportingRestRequestMessageDS, XmlRestMessageDS, XmlRestMessageDS, XmlRestRequestMessageDS, XmlRestRequestMessageDS
public interface IRestMessageDS
This interface defines a message of a rest operation.
Since:
9.0
Author:
Arjan Pragt

  • Field Details

    • CATEGORY

      static final Category CATEGORY

  • Method Details

    • getEntityName

      String getEntityName()
      This method returns the entity connected to the message.
      Returns:
      The name of the entity connected to the message, may be null

    • iterateHeaders

      void iterateHeaders(IRestHeaderVisitor visitor)
      This method iterates about the headers of the message.
      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.

    • getBodyElement

      IElementReferenceDS getBodyElement()
      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.
      Returns:
      The qualified name of the xml element.

    • getBodySchema

      String getBodySchema()
      This method returns the name of the domain schema. Must be null when using schemasets.
      Returns:
      The name of the domain schema, or null in case of no body.

    • getBodyAttributeName

      String getBodyAttributeName()
      This method returns the attribute storing the xmlelement using as body, may be null.
      Returns:
      The name of the attribute storing the xmlelement.

    • iterateBodyValidations

      void iterateBodyValidations(IFieldValidationVisitor visitor)
      This method iterates about the validations of the body attribute.
      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.