Disk to Cloud: Abstract your File Operations with CBFS

In this session, we explored how the cbfs module empowers developers to abstract and manage file systems seamlessly across their lifecycle. From local development to S3 deployment and customized media providers requiring authentication, cbfs offers flexible solutions. We discussed how cbfs simplifies file handling with enhanced workflow efficiency compared to native methods, along with practical tips to accelerate complex file operations in your projects.

1. INTO THE BOX 2024
CBFS
Abstract, Extend, Integrate Any File System

2. Jon Clausen
Ortus Solutions
Senior Solutions Architect
Grand Rapids, Michigan

3. -
ColdBox Module
-
Abstract ANY filesystem within your ColdBox applications
-
Configure named disks that represent file systems
-
Each disk is tied to a Storage Provider
-
Storage Providers
-
Local, RAM, Temporary, S3
-
Various means to provide storage to your application
-
Access and use disks using a simple API
What is CBFS?

4. -
Abstraction
-
Same API, different destinations
-
Different locations for different tiers: development, staging, production
-
Flexibility
-
Ability to change providers with no change of code *
-
Ease of Use
-
Focus on abstraction instead of a specific protocol
-
Modularity
-
Leverages ColdBox’s HVMC
-
Any module can define disks or consume disks
Why CBFS?

5. Old School: List a Directory
CBFS:

6. Old School: Deliver an Image
CBFS:

7. Old School: File Writes
CBFS:

8. Architecture

9. -
Responsible for managing disks
-
Tracks instances and metadata
-
Register / unregister
-
Startup / shutdown
-
Interact with your disks
Disk Service

10. -
Use to register and interact with your disks
-
Disks with the same names can can use different providers depending on the deploy tier
-
Get names of disks
-
diskService.names()
-
Get count of disks
-
diskService.count()
-
Obtaining Disk Instances
-
diskService.get( diskName )
-
Default Disk
-
diskService.defaultDisk()
-
diskService.tempDisk()
Disk Service

11. -
Local
-
Java 11 + NIO
-
95% of our implementation is not using native CFML
-
Adobe CF / Lucee is using Java-8 and earlier IO packages
-
RAM
-
Stores files in memory
-
Temp
-
Stores files in CFML engine’s temporary file storage
-
S3
-
Uses AmazonS3@s3sdk
-
Connect to S3, Digital Ocean Spaces, Azure Blog Storage ( via S3 API implementation)
Included Providers

12. Global Configuration

13. Modular Configuration

14. -
Retrieving Files
-
disk.get( path )
-
disk.allContents()
-
Storing Files
-
disk.create( path, contents )
-
disk.append( path, contents)
-
Deleting Files
-
disk.delete( path )
-
Directories
-
disk.cleanDirectory( directory
Disk Instances

15. Injection DSL

16. -
Disk Interface ( IDisk.cfc )
-
Pointers
Custom File Systems

17. Case Study: ContentBox

18. Q & A

19. Thank You!