Java SDK

Overview

Cloudinary's Java SDK provides simple, yet comprehensive image and video upload, transformation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing Java application.

Related topics
This guide relates to the latest released version of the Cloudinary Java library.

For details on all new features and fixes from previous versions, see the CHANGELOG.

Quick example: Transformations

Take a look at the following transformation code and the image it delivers:

Java:
Copy to clipboard
cloudinary.url().transformation(new Transformation()
  .width(150).height(150).gravity("face").crop("thumb").chain()
  .radius(20).chain()
  .effect("sepia").chain()
  .overlay(new Layer().publicId("cloudinary_icon_blue")).gravity("south_east").x(5).y(5).width(50).opacity(60).effect("brightness:200").chain()
  .angle(10)).secure(true).imageTag("front_face.png");
sample transformation

This relatively simple code performs all of the following on the original front_face.jpg image before delivering it:

  • Crop to a 150x150 thumbnail using face-detection gravity to automatically determine the location for the crop
  • Round the corners with a 20 pixel radius
  • Apply a sepia effect
  • Overlay the Cloudinary logo on the southeast corner of the image (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness and partial transparency (opacity = 60%)
  • Rotate the resulting image (including the overlay) by 10 degrees
  • Convert and deliver the image in PNG format (the originally uploaded image was a JPG)

And here's the URL that would be included in the image tag that's automatically generated from the above code:

Quick example: File upload

The following Java code uploads the dog.mp4 video to the specified account sub-folder using the public_id, my_dog. The video will overwrite the existing my_dog video if it exists. When the video upload is complete, the specified notification URL will receive details about the uploaded media asset.

Copy to clipboard
Map params = ObjectUtils.asMap(
    "public_id", "my_folder/my_sub_folder/my_dog", 
    "overwrite", true,
    "notification_url", "https://mysite/notify_endpoint",
    "resource_type", "video"         
);
Map uploadResult = cloudinary.uploader().upload(new File("doc.mp4"), params);

Java library features

Cloudinary provides an open source Java library for further simplifying the integration:

  • Build URLs for transformation & manipulation
  • API wrappers: file upload, administration, sprite generation and more
  • JSP tag library to ease and facilitate the inclusion, transformation, upload, and storage in a Java EE web application
  • Server-side file upload + direct unsigned file upload from the browser using the jQuery plugin

The library is built for Java 6 / JSP 2.0 and will work with higher versions. The following are resources which serve as a good starting point to better familiarize yourself with the library:

Choosing the right Maven package

The Maven repository includes several packages ("artifacts") to choose from:

  • cloudinary-http - for general Java applications. It utilizes the Apache HTTP libraries.

    • cloudinary-http44 - Cloudinary Apache HTTP 4.4 Library
    • cloudinary-http43 - Cloudinary Apache HTTP 4.3 Library
    • cloudinary-http42 - Cloudinary Apache HTTP 4.2 Library
  • cloudinary-taglib - provides a Java Tag Library for J2EE applications

  • cloudinary-android - provides support for android applications

Installation and setup

The easiest way to start using Cloudinary's Java library is to use Maven.

  1. Download and install Maven. Follow https://maven.apache.org/download.cgi for reference.
  2. Create a maven project. See example here.
  3. Add the Cloudinary dependency to the list of dependencies in the pom.xml:

    Copy to clipboard
    <dependencies>
        ...
        <dependency>
            <groupId>com.cloudinary</groupId>
            <artifactId>cloudinary-http44</artifactId>
            <version>[Cloudinary API version, e.g. 1.1.3]</version>
        </dependency>
    </dependencies>
  4. If you are building a Java EE web application you should consider using the tag library by adding:

    Copy to clipboard
    <dependencies>
        ...
        <dependency>
            <groupId>com.cloudinary</groupId>
            <artifactId>cloudinary-taglib</artifactId>
            <version>[Cloudinary API version, e.g. 1.1.3]</version>
        </dependency>
    </dependencies>

When using in Java code import the appropriate package:

Copy to clipboard
import com.cloudinary.*;

When using in a JSP view import the tag library:

Copy to clipboard
<%@taglib uri="http://cloudinary.com/jsp/taglib" prefix="cl" %>

Configuration

To use the Cloudinary Java library, you have to configure at least your cloud_name. Your api_key and api_secret are also needed for secure API calls to Cloudinary (e.g., image and video uploads). You can find your account-specific configuration credentials in the Dashboard page of the account console.

Setting the configuration parameters can be done either programmatically using the appropriate constructor of the Cloudinary class or globally using an environment variable.

You can optionally configure the required cloud_name, api_key, and api_secret by defining the CLOUDINARY_URL environment variable. The configuration URL is available in the Dashboard page of the account console. When using Cloudinary through a PaaS add-on (e.g., AppFog), this environment variable is automatically defined in your deployment environment. For example:

Copy to clipboard
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name

In addition to the required configuration parameters, you can define a number of optional configuration parameters if relevant.

Here's an example of setting configuration parameters in your Java application:

Copy to clipboard
import com.cloudinary.*;
...
Cloudinary cloudinary = new Cloudinary(ObjectUtils.asMap(
"cloud_name", "my_cloud_name",
"api_key", "my_api_key",
"api_secret", "my_api_secret"));

In a Java EE environment you can set an environment variable available to your Java EE container:

Copy to clipboard
CLOUDINARY_URL=cloudinary://{api_key}:{api_secret}@{cloud_name}

This will enable you to receive a Cloudinary instance:

Copy to clipboard
Cloudinary cloudinary = Singleton.getCloudinary();

Or you can directly register a Cloudinary instance in your initializer code:

Copy to clipboard
SingletonManager manager = new SingletonManager();
manager.setCloudinary(someCloudinaryInstance);
manager.init();

Note
The tags in the tag library require an instance to be available in the Singleton to function correctly.

Java capitalization and data type guidelines

When using the Java SDK, keep these guidelines in mind:

  • Parameter names: snake_case. For example: public_id
  • Classes: PascalCase. For example: CloudinaryImageTag
  • Methods: camelCase. For example: imageUploadTag
  • Pass parameter data as: Map

Sample projects

To find additional useful code samples and learn how to integrate Cloudinary with your Java applications, take a look at our Sample Projects. These projects are based on the Spring MVC v3.2.

Photo Album: A fully working web application that allows you to uploads photos, maintain a database with references to them, list them with their metadata, and display them using various cloud-based transformations. Image uploading is performed both from the server side and directly from the browser using a jQuery plugin.

Related topics

✔️ Feedback sent!