Package eu.domibus.connector.client
Interface DomibusConnectorClientBackend
-
- All Known Subinterfaces:
DomibusConnectorClientAppBackend
- All Known Implementing Classes:
DomibusConnectorClientBackendImpl
public interface DomibusConnectorClientBackend
This interface must be implemented if the domibusConnectorClientScheduler is used and/or the client is set up in push/pull mode!- Author:
- Bernhard Rieder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DomibusConnectorMessagesType
checkClientForNewMessagesToSubmit()
This method asks the backend of the client if new messages are to submit to the connector.void
deliverNewAcknowledgeableConfirmationToClientBackend(DomibusConnectorMessageType message, String messageTransportId)
This method triggers the client's backend to store/put/forward confirmation received.void
deliverNewAcknowledgeableMessageToClientBackend(DomibusConnectorMessageType message, String messageTransportId)
This method triggers the client's backend to store/put/forward messages received.void
deliverNewConfirmationToClientBackend(DomibusConnectorMessageType message)
This method triggers the client's backend to store/put/forward confirmation received.void
deliverNewMessageToClientBackend(DomibusConnectorMessageType message)
This method triggers the client's backend to store/put/forward messages received.void
triggerConfirmationForMessage(DomibusConnectorMessageType originalMessage, DomibusConnectorConfirmationType confirmationType, String confirmationAction)
This method triggers the connector to generate and send a confirmation.
-
-
-
Method Detail
-
checkClientForNewMessagesToSubmit
DomibusConnectorMessagesType checkClientForNewMessagesToSubmit() throws DomibusConnectorClientBackendException
This method asks the backend of the client if new messages are to submit to the connector. Must be implemented if domibusConnectorClientScheduler is used, or if the client implementation is not self aware to recognize new messages at its backend.- Returns:
- messages object holding a Collection of messages.
- Throws:
DomibusConnectorClientBackendException
-
deliverNewMessageToClientBackend
void deliverNewMessageToClientBackend(DomibusConnectorMessageType message) throws DomibusConnectorClientBackendException
This method triggers the client's backend to store/put/forward messages received. Must be implemented if domibusConnectorClientScheduler is used, or if the client is set up in push/pull mode.- Parameters:
message
- - The message object received from the connector.- Throws:
DomibusConnectorClientBackendException
-
deliverNewAcknowledgeableMessageToClientBackend
void deliverNewAcknowledgeableMessageToClientBackend(DomibusConnectorMessageType message, String messageTransportId) throws DomibusConnectorClientBackendException
This method triggers the client's backend to store/put/forward messages received. Must be implemented if the message pulling with acknowledgement is used.- Parameters:
message
- - The message object received from the connector.messageTransportId
- - The transport ID the connector gives a message.- Throws:
DomibusConnectorClientBackendException
-
deliverNewConfirmationToClientBackend
void deliverNewConfirmationToClientBackend(DomibusConnectorMessageType message) throws DomibusConnectorClientBackendException
This method triggers the client's backend to store/put/forward confirmation received. Must be implemented if domibusConnectorClientScheduler is used, or if the client is set up in push/pull mode.- Parameters:
message
- - The message object containing the confirmation received from the connector.- Throws:
DomibusConnectorClientBackendException
-
deliverNewAcknowledgeableConfirmationToClientBackend
void deliverNewAcknowledgeableConfirmationToClientBackend(DomibusConnectorMessageType message, String messageTransportId) throws DomibusConnectorClientBackendException
This method triggers the client's backend to store/put/forward confirmation received. Must be implemented if the message pulling with acknowledgement is used.- Parameters:
message
- - The message object containing the confirmation received from the connector.messageTransportId
- - The transport ID the connector gives a message.- Throws:
DomibusConnectorClientBackendException
-
triggerConfirmationForMessage
void triggerConfirmationForMessage(DomibusConnectorMessageType originalMessage, DomibusConnectorConfirmationType confirmationType, String confirmationAction) throws DomibusConnectorClientBackendException
This method triggers the connector to generate and send a confirmation.- Parameters:
originalMessage
- - The original message the confirmation should be triggered for.confirmationType
- - The type of confirmation that should be triggered.confirmationAction
- - The use-case specific action that is used for transmission of the confirmation- Throws:
DomibusConnectorClientBackendException
-
-