Package eu.domibus.connector.client.rest
Interface DomibusConnectorClientSubmissionRestAPI
-
- All Known Implementing Classes:
DomibusConnectorClientSubmissionRestAPIImpl
@RequestMapping("/submissionrestservice") public interface DomibusConnectorClientSubmissionRestAPI
This REST interface allows a backend application that is connected to the domibusConnectorClient to submit messages to it that have not been processed by the domibusConnectorClient before.- Author:
- riederb
-
-
Field Summary
Fields Modifier and Type Field Description static String
SUBMISSIONRESTSERVICE_PATH
This static String is the relative path where this REST service can be reached.static String
SUBMIT_NEW_MESSAGE_FROM_BACKEND_TO_CONNECTOR_CLIENT
This static String is the relative path where this method of this REST service can be reached.static String
TRIGGER_CONFIRMATION_AT_CONNECTOR_CLIENT
This static String is the relative path where this method of this REST service can be reached.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Boolean
submitNewMessageFromBackendToConnectorClient(DomibusConnectorClientMessage message)
With this method a new message may be submitted to the domibusConnectorClient by a backend application via REST service.Boolean
triggerConfirmationAtConnectorClient(String refToMessageId, String confirmationType)
This method allows a backend application of the domibusConnectorClient to trigger a confirmation for a message.
-
-
-
Field Detail
-
SUBMISSIONRESTSERVICE_PATH
static final String SUBMISSIONRESTSERVICE_PATH
This static String is the relative path where this REST service can be reached.- See Also:
- Constant Field Values
-
TRIGGER_CONFIRMATION_AT_CONNECTOR_CLIENT
static final String TRIGGER_CONFIRMATION_AT_CONNECTOR_CLIENT
This static String is the relative path where this method of this REST service can be reached.- See Also:
- Constant Field Values
-
SUBMIT_NEW_MESSAGE_FROM_BACKEND_TO_CONNECTOR_CLIENT
static final String SUBMIT_NEW_MESSAGE_FROM_BACKEND_TO_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
-
submitNewMessageFromBackendToConnectorClient
@PostMapping(value="/submitNewMessageFromBackendToConnectorClient", consumes="application/json", produces="application/json") Boolean submitNewMessageFromBackendToConnectorClient(@RequestBody DomibusConnectorClientMessage message) throws MessageSubmissionException, StorageException, ParameterException
With this method a new message may be submitted to the domibusConnectorClient by a backend application via REST service. The message is then processed by the domibusConnectorClient and submitted to the domibusConnector.- Parameters:
message
- The domibusConnectorClient message to be processed and submitted to the domibusConnector. This message object must already be built completely with all message files attached, as the domibusConnectorClient presumes that the message submitted is already prepared.- Returns:
- success
- Throws:
MessageSubmissionException
StorageException
ParameterException
-
triggerConfirmationAtConnectorClient
@PostMapping(value="/triggerConfirmationAtConnectorClient", consumes="application/json", produces="application/json") Boolean triggerConfirmationAtConnectorClient(@RequestParam String refToMessageId, @RequestParam String confirmationType) throws MessageSubmissionException, ParameterException, MessageNotFoundException
This method allows a backend application of the domibusConnectorClient to trigger a confirmation for a message. The confirmation trigger will be forwarded to the domibusConnector which then generates the confirmation and submits it to the original sender of the message. The generated confirmation also is sent back to the domibusConnectorClient and stored there.- Parameters:
refToMessageId
-confirmationType
-- Returns:
- success
- Throws:
MessageSubmissionException
ParameterException
MessageNotFoundException
-
-