Package de.aeb.xnsg.foundation.bf
Interface ISyncBF
@BusinessFacade
public interface ISyncBF
Business facade for synchronizing data asynchronous from an engine to a client
system.
-
Method Summary
Modifier and TypeMethodDescriptionAcknowledge events got withgetNotAcknowledgedEvents(SyncEventsRequestDTO)
.
Since XNSG 4.0, Nov.Poll any not acknowledged events for the client system.
This method does not require, that the client system fillsSyncEventsRequestDTO.syncId
.
However, it requires, that a call toacknowledgeEvents(AcknowledgeEventsRequestDTO)
is done for acknowledge of the events.
Since XNSG 4.0, Nov.Fetch a list of registered subscriptions (either all or filtered by the business object type).
Only subscription belonging to the providedclientSystemId
are returned (mandatory field)
Since XNSG 4.0, Nov.Subscribe a partner system to be able to receive events for the specified business object type.
The subscription is uniquely identified by theclientSystemId
andbusinessObjectType
(both mandatory fields)
Since XNSG 4.0, Nov.synchronizeEvents
(SyncEventsRequestDTO request) Poll the next events for the client system.
This method requires the client system to persist the synchronisation state itself and passing a proper value forSyncEventsRequestDTO.syncId
SeegetNotAcknowledgedEvents(SyncEventsRequestDTO)
for a version of the method, were the syncronisation state is kept within the Engine.Unsubscribe a partner system from being able to receive events for the specified business object type.
The subscription is uniquely identified by theclientSystemId
andbusinessObjectType
(both mandatory fields)
Since XNSG 4.0, Nov.
-
Method Details
-
synchronizeEvents
Poll the next events for the client system.
This method requires the client system to persist the synchronisation state itself and passing a proper value forSyncEventsRequestDTO.syncId
SeegetNotAcknowledgedEvents(SyncEventsRequestDTO)
for a version of the method, were the syncronisation state is kept within the Engine.- Parameters:
request
-
-
getNotAcknowledgedEvents
Poll any not acknowledged events for the client system.
This method does not require, that the client system fillsSyncEventsRequestDTO.syncId
.
However, it requires, that a call toacknowledgeEvents(AcknowledgeEventsRequestDTO)
is done for acknowledge of the events.
Since XNSG 4.0, Nov. FP, 2017- Parameters:
request
-
-
acknowledgeEvents
Acknowledge events got withgetNotAcknowledgedEvents(SyncEventsRequestDTO)
.
Since XNSG 4.0, Nov. FP, 2017- Parameters:
request
-
-
subscribePartnerSystem
Subscribe a partner system to be able to receive events for the specified business object type.
The subscription is uniquely identified by theclientSystemId
andbusinessObjectType
(both mandatory fields)
Since XNSG 4.0, Nov. FP, 2021- Parameters:
request
-
-
unsubscribePartnerSystem
UnsubscribePartnerSystemResponseDTO unsubscribePartnerSystem(UnsubscribePartnerSystemRequestDTO request) Unsubscribe a partner system from being able to receive events for the specified business object type.
The subscription is uniquely identified by theclientSystemId
andbusinessObjectType
(both mandatory fields)
Since XNSG 4.0, Nov. FP, 2021- Parameters:
request
-
-
getPartnerSystemSubscriptions
GetPartnerSystemSubscriptionsResponseDTO getPartnerSystemSubscriptions(GetPartnerSystemSubscriptionsRequestDTO request) Fetch a list of registered subscriptions (either all or filtered by the business object type).
Only subscription belonging to the providedclientSystemId
are returned (mandatory field)
Since XNSG 4.0, Nov. FP, 2021- Parameters:
request
-
-