Filesystem-Lock

[filesystem-lock] This Resource Type allows the user to acquire and remove filesystem locks.

PROPERTIES
Name Filesystem-Lock
System ID FL
Connection String null
Heartbeat Connection String null
SUPPORTED NODE DEFINITIONS
Message UID Node Definition Name
01FL01 Acquire Lock
01FL06 Lock Content File By Asset Id
01FL05 Lock Content File By Path
01FL09 Lock Title By Provider Id And Asset Id
01FL03 Lock Title
01FL08 Release Content File By Asset Id
01FL07 Release Content File By Path
01FL02 Release Lock
01FL04 Release Title

* The message has been deprecated. Please use the replacement message(s) instead.

NODE DEFINITION DETAILS
Acquire Lock (01FL01)

Creates an empty file on the filesystem. Returns false if the file already exists.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
fileName NO File name of the lock to be created.
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
acquired Boolean value describing whether the lock was able to be acquired or not.
Lock Content File By Asset Id (01FL06)

Create an empty file by the Asset Id on the filesystem. Returns false if the file already exists.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO
assetId NO
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
acquired
Lock Content File By Path (01FL05)

Create an empty file by the Path on the filesystem. Returns false if the file already exists.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
filePath NO
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
acquired
Lock Title By Provider Id And Asset Id (01FL09)

Create an empty file by Provider Id and Asset Id on the filesystem. Returns false if the file already exists.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
providerId NO
packageAssetId NO
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
acquired
Lock Title (01FL03)

Create an empty file by Title Id on the filesystem. Returns false if the file already exists.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
acquired
Release Content File By Asset Id (01FL08)

Remove the empty lock file by Asset Id on the filesystem. Return false if the removal is unsuccessful.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO
assetId NO
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
released
Release Content File By Path (01FL07)

Remove the empty lock file by Path on the filesystem. Return false if the removal is unsuccessful.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
filePath NO
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
released
Release Lock (01FL02)

Removes the empty lock file on the filesystem. Returns false if the removal is unsuccessful.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
fileName NO File name of the lock to be removed.
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
released Boolean describing whether the lock was succesfully released.
Release Title (01FL04)

Remove the empty lock file by Title Id on the filesystem. Return false if the removal is unsuccessful.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO
owner NO
RESPONSE MESSAGE:
Parameter Name Description / Value
released
© 2002 - 2012 Ericsson Television Inc.
All Rights Reserved.