Package eu.domibus.connector.client.link
Interface DomibusConnectorClientLink
-
public interface DomibusConnectorClientLink
This Interface class is an abstraction layer between the domibusConnectorClientWSLink module and the domibusConnectorClientLibrary. It delegates methods through the WSLink to the domibusConnectorAPI backend.- Author:
- riederb
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
acknowledgeMessage(DomibusConnectorMessageResponseType result)
If a received message is completely processed by the client the message can be acknowledged to the domibusConnector.DomibusConnectorMessageType
getMessageById(String messageTransportId)
Requests the message for the given message transport ID.List<String>
listPendingMessages()
Returns transport IDs generated by the domibusConnector for messages on the domibusConnector which are pending for this client.DomibusConnectorMessagesType
requestMessagesFromConnector()
Delegate method to request new messages via domibusConnectorAPI from the backend of the domibusConnector to the domibusConnectorClientLibrary.DomibsConnectorAcknowledgementType
submitMessageToConnector(DomibusConnectorMessageType message)
Delegate method to submit a message from the domibusConnectorClientLibrary to the backend of the domibusConnector.
-
-
-
Method Detail
-
requestMessagesFromConnector
DomibusConnectorMessagesType requestMessagesFromConnector() throws DomibusConnectorBackendWebServiceClientException
Delegate method to request new messages via domibusConnectorAPI from the backend of the domibusConnector to the domibusConnectorClientLibrary.- Returns:
- the
DomibusConnectorMessagesType
holding all messages which are pending for this client. - Throws:
DomibusConnectorBackendWebServiceClientException
-
submitMessageToConnector
DomibsConnectorAcknowledgementType submitMessageToConnector(DomibusConnectorMessageType message) throws DomibusConnectorBackendWebServiceClientException
Delegate method to submit a message from the domibusConnectorClientLibrary to the backend of the domibusConnector.- Parameters:
message
-- Returns:
- the result of the submission
- Throws:
DomibusConnectorBackendWebServiceClientException
-
listPendingMessages
List<String> listPendingMessages() throws DomibusConnectorBackendWebServiceClientException
Returns transport IDs generated by the domibusConnector for messages on the domibusConnector which are pending for this client.- Returns:
- a list of transport IDs required to get and acknowledge messages.
- Throws:
DomibusConnectorBackendWebServiceClientException
-
getMessageById
DomibusConnectorMessageType getMessageById(String messageTransportId) throws DomibusConnectorBackendWebServiceClientException
Requests the message for the given message transport ID. Transport ID is received when calling listPendingMessages.- Parameters:
messageTransportId
-- Returns:
- the message
- Throws:
DomibusConnectorBackendWebServiceClientException
-
acknowledgeMessage
void acknowledgeMessage(DomibusConnectorMessageResponseType result) throws DomibusConnectorBackendWebServiceClientException
If a received message is completely processed by the client the message can be acknowledged to the domibusConnector. In case of positive result, the domibusConnector finishes the message. In case of negative result, the domibusConnector moves the message to its internal DLQ.- Parameters:
result
- of typeDomibusConnectorMessageResponseType
MUST contain message transport ID as responseForMessageId!- Throws:
DomibusConnectorBackendWebServiceClientException
-
-