Package com.aquima.interactions.communication.ds

Interface IRestRequestMessageDS

All Superinterfaces:

IRestMessageDS

All Known Implementing Classes:

ReportingRestRequestMessageDS, XmlRestRequestMessageDS, XmlRestRequestMessageDS

public interface IRestRequestMessageDS
extends IRestMessageDS

This interface defines a request message of an operation.

Since:

9.0

Author:

Arjan Pragt

Field Summary

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

CATEGORY

Method Summary

Modifier and Type	Method	Description
HttpMethodType	getHttpMethod()	This method returns the HTTP method of the request, may not be null.
void	iterateUrnArguments(IRestUrnArgumentVisitor visitor)	This method iterates about the urn arguments of the request.
void	iterateUrnFragments(IRestUrnFragmentVisitor visitor)	This method iterates about the urn fragments of the request.

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

getBodyAttributeName, getBodyElement, getBodySchema, getEntityName, iterateBodyValidations, iterateHeaders

Method Details

getHttpMethod

HttpMethodType getHttpMethod()

This method returns the HTTP method of the request, may not be null.

Returns:

The http method of the request.

iterateUrnFragments

void iterateUrnFragments(IRestUrnFragmentVisitor visitor)

This method iterates about the urn fragments of the request.

Parameters:

visitor - The visitor accepting the urn fragments.

Throws:

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

iterateUrnArguments

void iterateUrnArguments(IRestUrnArgumentVisitor visitor)

This method iterates about the urn arguments of the request.

Parameters:

visitor - The visitor accepting the urn arguments.

Throws:

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