HS.FHIRServer.API.Data.EndpointEvent
class HS.FHIRServer.API.Data.EndpointEvent extends HS.FHIRServer.API.Data.AbstractEndpointEvent
@API.Object Event reporting that a FHIR Server endpoint was installed, updated, decommissioned or uninstalled.The event is passed to a registered callback handler whenever an endpoint is installed, updated, decommissioned or uninstalled, however the change is made. It identifies the action and the endpoint and carries the endpoint's 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 FHIR Server. Members shared with BFC 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 FHIR Server endpoint events only; register under the context of HS.BulkFHIR.API.Data.EndpointEvent as well to receive BFC endpoint events.
Which operation fires which action:
- ACTIONCREATED: HS.FHIRServer.Installer InstallInstance. Installing a service with no endpoint URL fires nothing.
- ACTIONUPDATED: HS.FHIRServer.Installer UpdateInstance, on every call, whether or not anything changed.
- ACTIONDELETED: HS.FHIRServer.Installer UninstallInstance and DecommissionInstance. Deleting an endpoint that was already decommissioned fires nothing; its Deleted event was fired at decommission.
EndpointData and PreviousEndpointData are the Endpoint object of the FHIR Server Management REST API, as returned by GET /endpoints/{serviceId} and defined by the Endpoint schema in HS.FHIRServer.Management.REST.v1.spec. A decommissioned endpoint is retained, so its Deleted event still has EndpointData (decommissioned, not enabled, with an empty url) while EndpointUrl keeps the URL it had; an uninstalled endpoint is gone, so its Deleted event has no EndpointData. That is how a handler tells the two apart.
Parameters
parameter CALLBACKCONTEXT = FHIRServerEndpointLifecycle;
Context to pass to HS.HC.Callback.Manager Register to receive FHIR Server 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()