Java Example: Upload Video

In this topic, you will learn how to use an HTML page to upload a video to your media library using Java and the Media Write API. A servlet class handles the HTML form page, taking the video name, description, and file, and passes them into the create_video method.

Note that the solution presented below depends on 3rd party libraries. It is offered as an example only, and is not supported by Brightcove.

By downloading and examining the example code, you will learn how to programmatically upload video with Java and the Media Write API and customize the application as needed.

Before you begin

The sample consists of two files:

  • The file, which defines a servlet class that takes input from a form and passes it to the Write API create_video method.
  • The uploadVideoForm.html file, which presents a form that the user uses to specify a video's name, description, and path. The form's submit button passes the input to the UploadVideo servlet.

To follow the code in this topic, you should be familiar with Java servlets and form handling.

In this topic, you will learn about:

The UploadVideo servlet class

The servlet class accepts the form submission and reformats the data into a JSON-RPC call to the Write API. This example uses the ClientHTTPRequest helper class from the ClientHTTP library by Vlad Patryshev and requires the Apache Commons commons-io and commons-fileupload JAR files.

First, the servlet parses the incoming POST from the HTML form:

/* STEP 1. 
   Handle the incoming request from the client
// Request parsing using the FileUpload lib from Jakarta Commons
// Create a factory for disk-based file items  
DiskFileItemFactory factory = new DiskFileItemFactory();
// Create a new file upload handler
ServletFileUpload upload = new ServletFileUpload(factory);
// Parse the request into a list of DiskFileItems
List items = upload.parseRequest(request);
// The fields we will need for the API request
String videoName = "";
String videoDescription = "";
File videoFile = null;
String videoFilename = "";
long videoMaxSize = 0;
// Iterate through the list of DiskFileItems
Iterator iter = items.iterator();  
while (iter.hasNext()) {
	DiskFileItem item = (DiskFileItem);
	if (item.isFormField()) {
		if (item.getFieldName().equals("name")) {
			videoName = item.getString();
		} else if (item.getFieldName().equals("desc")) {
			videoDescription = item.getString();                        
	} else {
		videoFile = item.getStoreLocation();
		videoFilename = item.getName();
		videoMaxSize = item.getSize();

This servlet uses a helper library from Jakarta Commons in this example for parsing the request; you can write your own or use one of the many open source libraries created for this purpose. This library takes a multipart post (the kind sent from upload forms), and stores them in a list FileItems. By iterating through that list, you can separate the metadata fields from the file fields.

The next step encodes the metadata in JSON:

/* STEP 2. 
Assemble the JSON params
String json = "{\"method\":\"create_video\"" +
          ", \"params\":{" +
          "\"token\":" + "12345asdfasdfa67898" + ", " +
          "\"video\":" + 
                "{\"name\":\"" +  videoName + "\", " +
                "\"shortDescription\":\"" + videoDescription + "\"}, " +

The important points to notice are as follows:

  • The method of the call is a JSON parameter rather than on the query string, as in a GET call.
  • params contains an object of additional arguments for the call, like your token and video metadata object.
  • Within the video metadata object, specify the name and shortDescription properties (both required) and optionally any other properties you can set, like tags, relatedLink, economics, etc.

Lastly, the servlet takes the JSON string and the file data and uses POST to send the data to the Write API. Let's look at the structure of the call used to upload the video in the last bit of code in the servlet:

// Define the url to the api
String targetURL = "";
// Create the params object required by...
Object[] params;
if(videoFile == null) {
  params = new Object[] { "JSON-RPC", json };
} else {
  params = new Object[] {
        "JSON-RPC", json,
        videoFilename, videoFile
// ... the ClientHTTPRequest helper class from the ClientHTTP library by Vlad Patryshev

InputStream in = new, params );

This part of the servlet uses a helper library to simplify making the HTTP request because Java's networking stack is very low level. With this library, you just need to specify an object of parameters and the URL to POST them to.

The important points to notice are as follows:

  • The servlet makes a JSON-RPC type request
  • The json string contains the metadata for this video (This is explained in more detail later.)
  • videoFilename and videoFile are the files that are uploaded

Uploading using an HTML form

Now that you've defined the UploadVideo servlet class, you can put it to use in a simple HTML form. See the working example code.

In this sample, we define a POST action for the UploadVideo servlet. The form also presents two input fields where you can specify the name and description of the video you're uploading, and a third input field where you can browse for the video file in your file system:

<FORM ENCTYPE="multipart/form-data" method="POST" 
  Video name: <INPUT TYPE="text" NAME="name" value="video name"/><br/>
  Description: <INPUT TYPE="text" NAME="desc" value="description"/><br/>
  File:	<INPUT TYPE="file" NAME="file" />
  <INPUT TYPE="submit" VALUE="Upload"/>

The form's submit button passes the form input to the UploadVideo servlet, which, as you've seen, parses the input, sets up, and calls the create_video method.

For further help

If you are having problems getting your videos to upload, Brightcove Support is available to help. You can submit a case here. To make sure you get the fastest response possible, below is a list of what support will need to solve the problem.

  • The file size
  • The method of upload (Standard, Accelerated, FTP, Write API)
  • The file name and extension
  • Does the upload stall and not reach 100%?
  • Does the upload reach 100% and generate an error? If an error is generated, please provide a screen shot (preferred) or text of the error message

After your case is submitted, you will receive an email confirmation from Brightcove Support. To provide additional information on your case to Brightcove Support, reply to the confirmation email.