Introduction

Welcome to CBFS Sync, a suite of classes enabling seamless synchronization between local files and cloud storages or other remote repositories.

Add OneDrive-style, bidirectional synchronization to your applications with CBFS Sync. The event-driven design of CBFS Sync provides an intuitive way to handle operations performed on local files and folders. When remote changes are made, use the included methods to notify the local system.

The CBSync class builds on industry-standard technologies, including the Cloud Filter API on Windows, FUSE on Linux, and File Provider on macOS. CBSync reduces development time and improves the user experience by providing a single API. All icons and indicators visible to the user are presented by the operating system, ensuring a native experience.

The choice of the remote storage is entirely up to you. Whether your data are stored on a popular cloud storage service, a custom file server, or anywhere else, CBFS Sync provides a simple API to facilitate synchronization. CBFS Sync handles integration with the OS, while your code is responsible for handling events and transferring data between local and remote systems. Because your code interacts with the backend, you can also decide to make the synchronization one-way or bidirectional.

Included Classes

CBSync The CBSync class enables seamless synchronization between local files and cloud storages or other remote repositories.

Additional Information

You will always find the latest information about CBFS Sync at our web site: www.callback.com. We offer free, fully-functional 30-day trials for all of our products, and our technical support staff are happy to answer any questions you may have during your evaluation.

Please direct all technical questions to support@callback.com. To help support technicians assist you as quickly as possible, please provide a detailed and accurate description of your problem, the results you expected, and the results that you received while using our product. For questions about licensing and pricing, and all other general inquiries, please contact sales@callback.com.

Thank You!

Thank you for choosing CBFS Sync for your development needs. We realize that you have a choice among development tools, and that by choosing us you are counting on us to be a key component in your business. We work around the clock to provide you with ongoing enhancements, support, and innovative products; and we will always do our best to exceed your expectations!

Deployment

The user-mode library comes in two pieces, both of which must be deployed along with the application:

  1. A JAR file, named cbfssync.jar
  2. A platform-native dynamic library with JNI (Java Native Interface), named as follows:
    • Windows: jnicbfssync24.dll (available for 32-bit (x86) and 64-bit (x64) processors)
    • Linux: libjnicbfssync.24.0.so (available for 32-bit (x86) and 64-bit (x64) processors)
    • macOS: libjnicbfssync24.0.dylib (available for x64 and ARM64 processors)

When deploying the application, copy both the JAR and the native library to the target system and place them next to the application.

Alternatively, the native dynamic library may be placed into one of directories, the paths to which are contained in the

  • Windows: PATH environment variable, such as C:\Windows\System32 (or C:\Windows\SysWOW64 when deploying a 32-bit application on a 64-bit Windows system)
  • Linux: LD_LIBRARY_PATH environment variable
  • macOS: DYLD_LIBRARY_PATH environment variable

Note: A deploy.jar file also may be used instead of cbfssync.jar; it is smaller, and does not contain Intellisense data or Javadoc content.

Windows:

The native library may alternatively be installed to the Windows system directory. This approach allows deploying both the 32-bit and 64-bit versions of the native library simultaneously, because each gets placed into the system directory that corresponds to the appropriate processor architecture.

Constants

All constants are accessible through the cbfssync.Constants class.

File Attributes

CBFSSYNC_ATTR_NORMAL
Value: 0x00000001
The item is a normal file or folder with no other attributes. This attribute may be used to clear any other attributes that may be set on the file or folder.
CBFSSYNC_ATTR_READONLY
Value: 0x00000002
The item is read-only.

Note: This attribute is not used by CBFS Sync, but it can be set and retrieved.

CBFSSYNC_ATTR_HIDDEN
Value: 0x00000004
The item is hidden.

Note: This attribute is not used by CBFS Sync, but it can be set and retrieved.

CBFSSYNC_ATTR_SYSTEM
Value: 0x00000008
The item is a system file or folder.

Note: This attribute is not used by CBFS Sync, but it can be set and retrieved.

CBFSSYNC_ATTR_PINNED
Value: 0x00100000
Indicates that the item is pinned and that the item's data are always available in the system. This value is not used on macOS.
CBFSSYNC_ATTR_UNPINNED
Value: 0x00200000
Indicates that the item is unpinned and that locally cached data for this item are removed when the last handle to the file is closed. This value is not used on macOS.

File Status Flags

CBFSSYNC_STATUS_DOWNLOADED
Value: 0x00000001
Indicates that the item is downloaded.

Indicators of file properties update

CBFSSYNC_ITEM_CTIME
Value: 0x0002
Creation time has been changed.
CBFSSYNC_ITEM_MTIME
Value: 0x0004
Modification (last write) time has been changed.
CBFSSYNC_ITEM_ATIME
Value: 0x0008
Last access time has been changed.
CBFSSYNC_ITEM_ATTRIBUTES
Value: 0x0020
File attributes or security flags have been updated.
CBFSSYNC_ITEM_CONTENT
Value: 0x0040
Files: content has been updated. Not used for folders.
CBFSSYNC_ITEM_RESTORED_FROM_TRASH
Value: 0x0080
A file or folder was restored from Trash (macOS only).

DeleteItem event flags

CBFSSYNC_DELETE_TO_BIN
Value: 0x00000001
An item was moved to Recycle Bin/Trash rather than deleted.

Result Codes

CBFSSYNC_PENDING
Value: 0x21000001
Operation will be completed later.
CBFSSYNC_ERR_SYNC_NOT_ACTIVE
Value: 0x21000002
Class is not active.
CBFSSYNC_ERR_SYNC_IS_ACTIVE
Value: 0x21000003
Class is active.
CBFSSYNC_ERR_INVALID_PARAMETER
Value: 0x21000004
Invalid parameter.
CBFSSYNC_ERR_INVALID_HANDLE
Value: 0x21000005
Invalid handle.
CBFSSYNC_ERR_OPERATION_DENIED
Value: 0x21000006
Operation denied.
CBFSSYNC_ERR_INITIALIZATION_FAILED
Value: 0x21000007
Class initialization failed.
CBFSSYNC_ERR_NOT_INSTALLED
Value: 0x21000008
The Install method must be called before performing this operation.
CBFSSYNC_ERR_NO_DATA
Value: 0x21000009
No local data are associated with the current task.
CBFSSYNC_ERR_DATA_READ_FAILED
Value: 0x2100000A
Reading of data failed due to the error reported by the operating system.
CBFSSYNC_ERR_TOO_MANY_ITEMS
Value: 0x21000010
Too many items returned during enumeration.
CBFSSYNC_ERR_ITEM_INFO_NOT_PROVIDED
Value: 0x21000011
Requested file or folder information was not provided.
CBFSSYNC_ERR_ITEM_NOT_FOUND
Value: 0x21000012
Requested file or folder was not found.
CBFSSYNC_ERR_FILE_ALREADY_EXISTS
Value: 0x21000013
File already exists.
CBFSSYNC_ERR_INVALID_ITEM_NAME
Value: 0x21000014
Invalid item name returned during enumeration.
CBFSSYNC_ERR_INVALID_ITEM_ID
Value: 0x21000015
Invalid item Id returned during enumeration.
CBFSSYNC_ERR_INVALID_ATTRIBUTES
Value: 0x21000016
Invalid item attributes returned during enumeration.
CBFSSYNC_ERR_INVALID_ITEM_PROPERTY
Value: 0x21000017
Invalid item property value returned during enumeration.
CBFSSYNC_ERR_READ_OPERATION_ERROR
Value: 0x21000030
Read operation failed.
CBFSSYNC_ERR_READ_OPERATION_CANCELED
Value: 0x21000031
Read operation canceled.
CBFSSYNC_ERR_OS_ERROR
Value: 0x21000041
Operating system API error.
CBFSSYNC_ERR_NO_ACCESS_TO_MAC_ROOT
Value: 0x21000050
The application has no access to the directory where macOS keeps the folder being synchronized (~/Library/CloudStorage).