File Download Proxy Webservice

Introduction

The File Download Proxy Webservice Plugin is a web service plugin that allows Joget applications to proxy file downloads from external URLs. This utility enables secure, controlled downloads with the ability to dynamically set the HTTP Content-Type and Content-Disposition headers to define custom filenames.

Plugin Information

Plugins Available in the Bundle:

• File Download Proxy Webservice

Supported Database: MySQL, PostgreSQL, Oracle, MS SQL Server
License: Apache License, Version 2.0

This plugin bundle is compatible with Joget DX 8.

Get Started

Prerequisites

• Joget DX 8 Enterprise or Community Edition.
• Developer or administrator access with permissions to manage plugins.

Where to get the plugin

You can obtain the plugin JAR file by downloading the latest release from the File Download Proxy Webservice GitHub Releases page.

How to install

1. Download the latest release .jar file from the repository releases page.
2. Log in to your Joget Console.
3. Navigate to the Admin Bar and select Settings > Manage Plugins.
4. Click the Upload Plugins button, select the downloaded JAR file, and click Upload.

How to use it

To use the proxy web service, you will construct a specialized service call URL using the plugin's class path and target query parameters.

1. Prepare a Test File URL

You will need an accessible, public file URL to verify the proxy functionality. You can use this sample PDF for testing :

https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf

2. Construct the Proxy URL

Build your target proxy request URL by appending the target parameters to the Joget plugin service endpoint. Replace localhost:8080 with your host domain as appropriate :

http://localhost:8080/jw/web/json/plugin/org.joget.marketplace.FileDownloadProxyWebService/service?url=https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf&fileName=rename.pdf&contentType=application/pdf&timeout=60000

3. Configure URL Parameters

The proxy service parses the following query parameters appended to the URL:

• url: Mandatory. The original, external file URL to fetch and proxy.
• file: Optional. The custom filename (along with its extension) that the file should save as on the user's system (e.g., rename.pdf).
• NamecontentType: Optional. Specifies the exact MIME content type header for the download stream (e.g., application/pdf).
• timeout: Optional. Defines the connection/read timeout duration in milliseconds for the proxy request.

4. Test the Proxy URL

Open the constructed proxy URL in your browser:

http://localhost:8080/jw/web/json/plugin/org.joget.marketplace.FileDownloadProxyWebService/service?url=https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf&fileName=rename.pdf&contentType=application/pdf&timeout=60000

Expected Outcome

After opening the constructed proxy URL in your web browser, the file downloads immediately and is saved to your local system with the renamed name rename.pdf. The file type should be correctly detected as application/pdf, confirming that the proxy service successfully fetched and piped the file with your custom headers.

Download Plugin

Download the plugin from the official GitHub Releases Page.