Package com.aquima.interactions.communication

Interface IRestRequestMessage

All Superinterfaces:
IRestMessage, Serializable
All Known Implementing Classes:
RestRequestMessage
public interface IRestRequestMessage extends IRestMessage
Interface describing a rest request message that can be parsed.
Since:
9.0
Author:
Jon van Leuven, Arjan Pragt

  • Method Details

    • getAcceptType

      String getAcceptType()
      This method returns the accepted mime type of the request if specified.
      Returns:
      The accepted mime type, or null.

    • getHttpMethod

      HttpMethodType getHttpMethod()
      This method returns the http method for this request message.
      Returns:
      The request method, never null.

    • getPath

      String getPath()
      This method returns the path for this request message.
      Returns:
      The path, may be null.

    • getArgumentNames

      String[] getArgumentNames()
      This method returns the argument names for this request message.
      Returns:
      The argument names, never null, but may be an empty array.

    • getArgumentValues

      String[] getArgumentValues(String name)
      This method returns the argument values for the requested name.
      Parameters:
      name - the name of the argument
      Returns:
      The argument values, may be null.

    • hasArgument

      boolean hasArgument(String name)
      This method returns if the request message contains an argument.
      Parameters:
      name - the name of the argument
      Returns:
      If the request message contains the argument.

    • isValidated

      boolean isValidated()
      This method returns whether the attributes should be validated after the rest request message is parsed
      Returns:
      if the attributes should be validated after the rest request message is parsed