OXY-URL: File URLs in Oxygen XML Web Author

GitHub

The URLs have the following format:

gitgh://REPOSITORY_URI/BRANCH/PATH_TO_FILE

where:

• gitgh = The URL scheme. Note that the GitHub plugin must be configured for this URL scheme to work.
• REPOSITORY_URI = The URI of the GitHub repository (URI-encoded).
• BRANCH = The name of the branch where the file is located (URI-encoded).
• PATH_TO_FILE = The path to the file. Each entry in the path should be URI-encoded.

Example: gitgh://https%3A%2F%2Fgithub.com%2Fuser%2Frepo/master/DITA/topics/intro%20topic.dita

GitLab

The URLs have the following format:

gitgl://REPOSITORY_URI/BRANCH/PATH_TO_FILE

where:

• gitgl = The URL scheme. Note that the GitLab plugin must be configured for this URL scheme to work.
• REPOSITORY_URI = The URI of the GitLab repository (URI-encoded).
• BRANCH = The name of the branch where the file is located (URI-encoded).
• PATH_TO_FILE = The path to the file. Each entry in the path should be URI-encoded.

Example: gitgl://https%3A%2F%2Fgithub.com%2Fuser%2Frepo/master/DITA/topics/intro%20topic.dita

GitLab On-Premise

The URLs have the following format:

gitgle://REPOSITORY_URI/BRANCH/PATH_TO_FILE

where:

• gitgle = The URL scheme. Note that the GitLab On-Premise plugin must be configured for this URL scheme to work.
• REPOSITORY_URI = The URI of the GitLab On-Premise repository (URI-encoded).
• BRANCH = The name of the branch where the file is located (URI-encoded).
• PATH_TO_FILE = The path to the file. Each entry in the path should be URI-encoded.

Example: gitgle://https%3A%2F%2Fgitlab-example.com%2Fuser%2Frepo/master/DITA/topics/intro%20topic.dita

Bitbucket

The URLs have the following format:

gitbb://REPOSITORY_URI/BRANCH/PATH_TO_FILE

where:

• gitbb = The URL scheme. Note that the Bitbucket plugin must be configured for this URL scheme to work.
• REPOSITORY_URI = The URI of the Bitbucket repository (URI-encoded).
• BRANCH = The name of the branch where the file is located (URI-encoded).
• PATH_TO_FILE = The path to the file. Each entry in the path should be URI-encoded.

Example: gitbb://https%3A%2F%2Fbitbucket.com%2Fuser%2Frepo/master/DITA/topics/intro%20topic.dita

Git

The URLs have the following format:

git://REPOSITORY_URI/BRANCH/PATH_TO_FILE

where:

• git = The URL scheme.
• REPOSITORY_URI = The URI of the Git repository (URI-encoded).
• BRANCH = The name of the branch where the file is located (URI-encoded).
• PATH_TO_FILE = The path to the file. Each entry in the path should be URI-encoded.

Example: git://https%3A%2F%2Fgithub.com%2Fuser%2Frepo/master/DITA/topics/intro%20topic.dita

WebDAV

The URLs have the following format:

webdav-https://dav.box.com/dav/path/to/file.dita

where the WebDAV URL of the file is: https://dav.box.com/dav/path/to/file.dita.

SharePoint

The URL of the file is the SharePoint file URL, prefixed with spo-, as in the following example:

spo-https://mycompany.sharepoint.com/myfolder/Shared%20Documents/myfile.dita

REST

The URLs have the following format:

rest://<server-id>/path/to/file.dita

The format can be further specified by the implementer of the REST API.

• If the user is not authenticated to the CMS or if the credentials are rejected by the CMS, you should throw a ro.sync.ecss.extensions.api.webapp.plugin.UserActionRequiredException exception. This exception is automatically relayed to the client-side as a sync.api.WebappMessage JavaScript object.
• On the client side, follow these steps:
  1. Use the sync.api.Editor.EventTypes.CUSTOM_MESSAGE_RECEIVED event to intercept the messages sent from the server-side.
  2. Display a dialog box to collect the user credentials.
  3. Send the new credentials to a ro.sync.ecss.extensions.api.webapp.plugin.WebappServletPluginExtension that you registered. This servlet will make the credentials available to the ro.sync.ecss.extensions.api.webapp.plugin.URLStreamHandlerWithContext instance presented above.
  4. Retry the operation that triggered the authentication procedure.

<img src="../image/iris.jpg" />

../image/iris.jpg

URIResolver uriResolver = new URIResolver() {
    @Override
    public Source resolve(String href, String base) throws TransformerException {
      if (base != null && base.indexOf("webdav-") == 0) {
        if (href.indexOf("http://") == 0 || href.indexOf("https://") == 0) {
          try {
            URL hrefUrl = new URL(href);
            URL baseUrl = new URL(base);
            final URL hrefWithUserInfo = 
                URLUtil.attachUserInfo(hrefUrl, baseUrl.getUserInfo(), null);
            return new Source() {
              
              @Override
              public void setSystemId(String systemId) {
              }
              
              @Override
              public String getSystemId() {
                return "webdav-" + hrefWithUserInfo.toExternalForm();
              }
            };
          } catch (MalformedURLException e) {
          }
        }
      }
      return null;
    }
  };

public class SampleWorkspaceAccess implements WorkspaceAccessPluginExtension {
  public void applicationStarted(StandalonePluginWorkspace pluginWorkspaceAccess) {
    pluginWorkspaceAccess.getXMLUtilAccess().addPriorityURIResolver(uriResolver);
  }
  public boolean applicationClosing() {
    return true;
  }
}