Home
Extending Oxygen With the SDK
Information about extending Oxygen XML Developer using the SDK
Extending Oxygen XML Developer with Plugins
Types of Plugin Extensions Available with the SDK
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 Developer.

Introduction
Welcome to the User Manual of Oxygen XML Developer 26.1
Getting Started
Information and resources to help you get started using Oxygen XML Developer as quickly as possible
Installation
The requirements and installation instructions for each platform
Configuration
Description of all of the options that allow you to configure Oxygen XML Developer
Perspectives
The Editor, XSLT Debugger, XQuery Debugger, and Database perspectives
Editing Modes
The Text, Grid, , and Schema Design editing modes
Working With Documents
General information about features available when working with documents
Editing Supported Document Types
Details about the various types of supported documents and their unique editing features
Built-in Frameworks (Document Types)
The editing frameworks that are supported in Oxygen XML Developer
Additional XML Editing Frameworks (Document Types)
The custom frameworks that are supported in Oxygen XML Developer
Publishing
Details about transformation scenarios and customizing various types of output
Working with XPath Expressions
Information about using XPath Expressions in Oxygen XML Developer
Working with Archives
Describes how to use the Archive Browser to work with various type of archives
Databases and SharePoint
Connecting to supported databases and integrating Oxygen XML Developer with SharePoint
Importing Data
Information about how to import data from external sources into XML documents
XSLT/XQuery Debugging
The debugging interface that detects problems with XSLT and XQuery transformations
Extending Oxygen With the SDK
Information about extending Oxygen XML Developer using the SDK
- Extending Oxygen XML Developer with Plugins
  - General Configuration of an Oxygen XML Developer Plugin
  - Installing an Oxygen XML Developer Plugin
  - Types of Plugin Extensions Available with the SDK
    - Workspace Access Plugin Extension
      This type of plugin allows you to contribute actions to the main menu and toolbars, create custom views, interact with the application workspace, make modifications to opened documents, and add listeners for various events.
    - Workspace Access Plugin Extension (JavaScript-Based)
      This is a JavaScript-based plugin extension that allows you to contribute actions to the main menu and toolbars, create custom views, interact with the application workspace, make modifications to opened documents, and add listeners for various events.
    - Trusted Hosts Plugin Extension
      This type of plugin can be used by developers to automatically allow or reject remote connections that Oxygen XML Developer would normally ask the user for confirmation.
    - Additional Framework Plugin Extension
      This type of plugin allows you to add a new framework straight from the plugin.
    - Additional XProc Engine Plugin Extension
      This type of plugin contributes a folder that contains an external XProc engine.
    - Components Validation Plugin Extension
      This type of plugin allows you to customize the menus, toolbars, and other components by enabling or filtering them from the user interface.
    - Contribute Additional Languages Plugin Extension
      This type of plugin allows you to contribute new translation languages to the Oxygen XML Developer UI.
    - Contribute External DITA-OT Distribution Plugin Extension
      This type of plugin allows you to contribute an external DITA-OT distribution to Oxygen XML Developer.
    - Custom Protocol Plugin Extension
      This type of plugin allows you to work with a custom designed protocol for retrieving and storing files.
    - Lock Handler Plugin Extension
      This type of plugin extension is used for locking resources from a specific protocol.
    - Open Redirect Plugin Extension
      This type of plugin is useful for opening multiple files with only one open action.
    - Option Page Plugin Extension
      This type of plugin extension allows you to add custom Preferences pages.
    - Option Page Group Plugin Extension
      This type of plugin extension allows you to add a group of custom Preferences pages from a plugin.
    - 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 Developer.
    - Targeted URL Stream Handler Plugin Extension
      This type of plugin can be used when it is necessary to impose custom URL stream handlers for specific URLs.
    - XML Refactoring Operations Plugin Extension
      This type of plugin allows you to specify one or more directories where the XML Refactoring operation resources are loaded.
    - XSLT Transformer Plugin Extension
      This type of plugin allows you to add an external XSLT transformer plugin.
    - Validator Plugin Extension
      This type of plugin allows you to add an external validation engine from a plugin.
    - Saxon XSLT Transformer Plugin Extension
      This type of plugin allows you to add an external Saxon XSLT transformer plugin.
    - XQuery Transformer Plugin Extension
      This type of plugin allows you to add an external XQuery transformer plugin.
    - Saxon XQuery Transformer Plugin Extension
      This type of plugin allows you to add the Saxon external XQuery transformer plugin.
    - Plugin Extensions Designed to Work only in the Text Editing Mode
  - How to Write a CMS Integration Plugin
  - How to Write A Custom Protocol Plugin
  - How to Share a Class Loader Between a Framework and Plugin
  - Packing and Deploying Plugins as Add-ons
  - Testing Plugins and Java Extensions
  - Disabling a Plugin
- Developer Quick Start Guide
- SDK Common Use Cases
Add-ons
Information about extending Oxygen XML Developer with add-ons
Tools
Specifics about the various tools that are included in Oxygen XML Developer
Troubleshooting
A compilation of common problems and their solutions
Scripting Oxygen
Details about the scripting possibilities that are available with Oxygen XML Developer
Glossary
Copyright
Legal information

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 Developer.

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 Developer.

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).