Package de.aeb.xnsg.foundation.bf

Interface ISyncBF

@BusinessFacade
public interface ISyncBF

API for synchronizing data asynchronous from an engine to a client system

Method Summary

Modifier and Type	Method	Description
AcknowledgeEventsResponseDTO	acknowledgeEvents(AcknowledgeEventsRequestDTO request)	Acknowledge events got with getNotAcknowledgedEvents(SyncEventsRequestDTO).
SyncEventsResponseDTO	getNotAcknowledgedEvents(SyncEventsRequestDTO request)	Poll any not acknowledged events for the client system. This method does not require, that the client system fills SyncEventsRequestDTO.syncId. However, it requires, that a call to acknowledgeEvents(AcknowledgeEventsRequestDTO) is done for acknowledge of the events.
GetPartnerSystemSubscriptionsResponseDTO	getPartnerSystemSubscriptions(GetPartnerSystemSubscriptionsRequestDTO request)	Fetch a list of registered subscriptions (either all or filtered by the business object type). Only subscription belonging to the provided clientSystemId are returned (mandatory field)
SubscribePartnerSystemResponseDTO	subscribePartnerSystem(SubscribePartnerSystemRequestDTO request)	Subscribe a partner system to be able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both mandatory fields)
SyncEventsResponseDTO	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 for SyncEventsRequestDTO.syncId. See getNotAcknowledgedEvents(SyncEventsRequestDTO) for a version of the method, where the synchronisation state is kept within the Engine.
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 the clientSystemId and businessObjectType (both mandatory fields)

Method Details

synchronizeEvents

SyncEventsResponseDTO 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 for SyncEventsRequestDTO.syncId.
See getNotAcknowledgedEvents(SyncEventsRequestDTO) for a version of the method, where the synchronisation state is kept within the Engine. When synchronizeEvents(SyncEventsRequestDTO) is used, any such potentially previously kept information is discarded.

Parameters:

request -

getNotAcknowledgedEvents

SyncEventsResponseDTO getNotAcknowledgedEvents(SyncEventsRequestDTO request)

Poll any not acknowledged events for the client system.
This method does not require, that the client system fills SyncEventsRequestDTO.syncId.
However, it requires, that a call to acknowledgeEvents(AcknowledgeEventsRequestDTO) is done for acknowledge of the events.

Parameters:

request -

Since:

FP November 2017

acknowledgeEvents

AcknowledgeEventsResponseDTO acknowledgeEvents(AcknowledgeEventsRequestDTO request)

Acknowledge events got with getNotAcknowledgedEvents(SyncEventsRequestDTO).

Parameters:

request -

Since:

FP November 2017

subscribePartnerSystem

SubscribePartnerSystemResponseDTO subscribePartnerSystem(SubscribePartnerSystemRequestDTO request)

Subscribe a partner system to be able to receive events for the specified business object type.
The subscription is uniquely identified by the clientSystemId and businessObjectType (both mandatory fields)

Parameters:

request -

Since:

FP November 2021

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 the clientSystemId and businessObjectType (both mandatory fields)

Parameters:

request -

Since:

FP November 2021

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 provided clientSystemId are returned (mandatory field)

Parameters:

request -

Since:

FP November 2021