5.1 Lock/Unlock File

5.1.1 Lock File

The lockFile function of BayunCore class locks a file with default encryption-policy dictated by server settings.

The function takes the following parameters :

• sessionId : Unique SessionId which is received in the authenticate function response.

• filePath : File path to be locked.

The file at the given file path is overwritten with the locked file. If file locking fails original file is not changed.

Python

lockedFilePath = bayunCore.lockFile("<sessionId>", <"filePath">)

5.1.2 Lock File with encryption-policy

The lockFile function with encryption-policy as an optional parameter locks file with the encryption key dictated by the policy. The function takes the following parameters :

• sessionId : Unique SessionId which is received in the authenticate function response.

• filePath : File path to be locked.

• encryptionPolicy : BayunEncryptionPolicy determines the key for locking.

• keyGenerationPolicy : BayunKeyGenerationPolicy determines the policy to generate the data encryption key.

• groupId : GroupId is required if encryptionPolicy is BayunEncryptionPolicyGroup.

If encryption-policy is other than BayunEncryptionPolicyGroup then groupId should be empty string.

Python

from BayunCore import BayunEncryptionPolicy
from BayunCore import BayunKeyGenerationPolicy

encryptionPolicy = BayunEncryptionPolicy.Company
keyGenerationPolicy = BayunKeyGenerationPolicy.Static
filePath = "<file path>"
lockedFilePath = bayunCore.lockFile("<sessionId>", filePath, encryptionPolicy, keyGenerationPolicy, "<groupId>")

5.1.3 Unlock File

The unlockFile function of BayunCore class unlocks a locked file. The function takes the following parameters :

• sessionId : Unique SessionId which is received in the authenticate function response.

• filePath : File path to be unlocked.

The file at the given file path is overwritten with the unlocked file.

Python

unlockedFilePath = bayunCore.unlockFile("<sessionId>","<filePath>")