Resource Locking Custom Protocol Plugin Extension

This type of plugin allows you to work with a custom designed protocol for retrieving and storing files and it can lock a resource when opening it in Oxygen XML Author.

This type of plugin extends the custom protocol plugin type with resource locking support and provides the following API:

  • URLStreamHandlerWithLockPluginExtension interface - The plugin receives callbacks following the simple protocol for resource locking and unlocking imposed by Oxygen XML Author.

    There are two additional methods that must be implemented:

    • getLockHandler() - Returns a LockHandler implementation class with the implementation of the lock specific methods from the plugin.
    • isLockingSupported(String protocol) - Returns a boolean that is true if the plugin accepts to manage locking for a certain URL protocol scheme (such as ftp, http, https, or customName).