Lock Handler Plugin Extension

This type of extension is used for locking resources from a specific protocol.

It provides the following API:

  • The interface LockHandlerFactoryPluginExtension.

    You need to implement the following two methods:

    • LockHandler getLockHandler()

      Gets the lock handler for the current handled protocol. Might be null if not supported.

    • boolean isLockingSupported(String protocol)

      Checks if a lock handler can be provided for a specific protocol.

    To use this type of extension in your plugin, create an extension of LockHandlerFactory type in your plugin.xml and specify the class implementing LockHandlerFactoryPluginExtension:

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plugin SYSTEM "../plugin.dtd">
    <plugin name="CustomLockHandler" ..............>
     <runtime>
      ........
     </runtime>
     
     <extension type="LockHandlerFactory"
             class="LockHandlerFactoryPluginExtensionImpl"/>
     ...............
      
    </plugin>
    

Was this helpful?