Interface DomibusConnectorClientMessageRestAPI

  • All Known Implementing Classes:
    DomibusConnectorClientMessageRestAPIImpl

    @RequestMapping("/messagerestservice")
    public interface DomibusConnectorClientMessageRestAPI
    This REST interface allows a backend application that is connected to the domibusConnectorClient to request messages and confirmations that have been received by the domibusConnectorClient.
    Author:
    riederb
    • Field Detail

      • MESSAGERESTSERVICE_PATH

        static final String MESSAGERESTSERVICE_PATH
        This static String is the relative path where this REST service can be reached.
        See Also:
        Constant Field Values
      • REQUEST_REJECTED_OR_CONFIRMED_MESSAGES_FROM_CONNECTOR_CLIENT

        static final String REQUEST_REJECTED_OR_CONFIRMED_MESSAGES_FROM_CONNECTOR_CLIENT
        This static String is the relative path where this method of this REST service can be reached.
        See Also:
        Constant Field Values
      • REQUEST_NEW_MESSAGES_FROM_CONNECTOR_CLIENT

        static final String REQUEST_NEW_MESSAGES_FROM_CONNECTOR_CLIENT
        This static String is the relative path where this method of this REST service can be reached.
        See Also:
        Constant Field Values
    • Method Detail

      • requestNewMessagesFromConnectorClient

        @GetMapping("/requestNewMessagesFromConnectorClient")
        DomibusConnectorClientMessageList requestNewMessagesFromConnectorClient()
        This method returns all messages that have been successfully received and processed by the domibusConnectorClient. Therefore the message status of the messages requested by this method is RECEIVED. After collecting those messages, the message status changes to DELIVERED_BACKEND.
        Returns:
        all messages with status RECEIVED.
      • requestRejectedOrConfirmedMessagesFromConnectorClient

        @GetMapping("/requestRejectedOrConfirmedMessagesFromConnectorClient")
        DomibusConnectorClientMessageList requestRejectedOrConfirmedMessagesFromConnectorClient()
        This method returns all messages and their confirmations attached with the message status REJECTED or CONFIRMED. In those states, a confirmation have been received from the domibusConnector. After collecting the messages, the status of those messages changes to CONFIRMATION_DELIVERED_BACKEND.
        Returns:
        all messages with their confirmations with the status REJECTED or CONFIRMED.