HS.BulkFHIR.API.Data.EndpointEvent
class HS.BulkFHIR.API.Data.EndpointEvent extends HS.FHIRServer.API.Data.AbstractEndpointEvent
@API.Object Event reporting that a Bulk FHIR Coordinator (BFC) endpoint configuration was created, updated or deleted.The event is passed to a registered callback handler whenever a configuration is saved or deleted, however the change is made. It identifies the action and the endpoint and carries the configuration before and after the change, so a handler can, for example, keep an API gateway's routes in step with the endpoints without querying the BFC. Members shared with FHIR Server endpoint events, and the rules common to both, are documented on HS.FHIRServer.API.Data.AbstractEndpointEvent.
To receive these events, subclass HS.HC.Callback.Handler, override its OnCallback method, and register the class with HS.HC.Callback.Manager Register using this class's CALLBACKCONTEXT. That registration receives BFC endpoint events only; register under the context of HS.FHIRServer.API.Data.EndpointEvent as well to receive FHIR Server endpoint events. A handler failure is reported to the caller as for any endpoint event and is also recorded in the BFC log at warning level.
Events follow the configuration, not whether it is active. Which operation fires which action:
- ACTIONCREATED: saving a configuration for an endpoint URL that had none, by HS.BulkFHIR.Installer Configure (activated) or SaveConfigWithoutConfigure (saved inactive).
- ACTIONUPDATED: saving a configuration for an endpoint URL that already had one, by either method. Reconfiguring, activating and deactivating are all updates.
- ACTIONDELETED: HS.BulkFHIR.Installer Delete, active or inactive.
HS.BulkFHIR.Installer ConfigureConfigElseSaveInactive fires whatever the save it performs fires.
EndpointData and PreviousEndpointData are the configuration document that HS.BulkFHIR.Installer Configure accepts, defined by HS.BulkFHIR.API.Data.Config and the adapter configuration classes it references. A deleted configuration is gone, so its Deleted event has no EndpointData.
Parameters
parameter CALLBACKCONTEXT = BulkFHIREndpointLifecycle;
Context to pass to HS.HC.Callback.Manager Register to receive BFC endpoint events.
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- GetActionName()