Skip to main content

HS.BulkFHIR.Storage.File.Adapter

class HS.BulkFHIR.Storage.File.Adapter extends HS.BulkFHIR.API.StorageAdapter

Stores files and makes them accessible through a REST API

Method Inventory

Parameters

parameter archeType = storage-file;
Inherited description: This property describes the overarching type of the adapter & its subclasses, so that they may be understood as belonging to the same group exhibiting fundamentally similar behaviors or serving similar purpose. Used when generating the metadata (GUISettings) for all adapters & config classes so the UI may be able to identify the archeType of adapter it's dealing with, without knowing its full inheritance chain (e.g. all pureFHIR fetch adapter & their subclasses will have the same archeType, all BulkFHIR fetch adapter & subclasses will have same archeType, etc.) and the UI can enforce archeType specific behavior across otherwise indistinguishable adapters & their configs.
parameter configClass = HS.BulkFHIR.Storage.File.Config;

Methods

classmethod DeleteFile(pURL As %String)
@BFC_Internal Given pURL delete the file
classmethod Finish(pSession As HS.BulkFHIR.Session)
When export finishes update the file counts
classmethod Initialize(pBFCconfig As HS.BulkFHIR.API.Data.Config)
Inherited description: (Optional overrideable) Called when the BFC is first configured and again if that configuration is changed, this method may be used to do any implementation-specific setup.
classmethod SaveFile(ByRef pInStream As %Stream.Object, pSession As HS.BulkFHIR.Session, pType As %String)
Moves contents from pInStream to permanent storage returns the URL where the file can be accessed. The session for the export operation and the file's resource type are also provided, as it may be useful or relevant for the storage strategy. @Input pInStream stream object containing a file to be saved. @Input pSession session object for the export operation the file is linked to @Input pType type of file - either a resource type or "error" This method moves the ndjson from the Temp files into the permanent file during flush operations and at completion
classmethod UsesAuthAdapter() as %Boolean
Inherited description: Indicates whether the files created by this adapter will be access controlled *directly* by the auth adapter. If the files are not access controlled, or the auth adapter isn't controlling access from the client's perspective (ie. AWS S3), this should be false. @Returns a boolean representing whether the auth adapter will be used for access control

Inherited Members

Inherited Methods

FeedbackOpens in a new tab