GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing cloudinary.com — Java SDK – Java Upload + Image, Video Transformations | Documentation

Documentation Index

Fetch the complete documentation index at: https://cloudinary.com/documentation/llms.txt

Use this file to discover all available pages before exploring further.

Java SDK

Last updated: Nov-04-2026

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

SDK security upgrade, June 2025

We recently released an enhanced security version of this SDK that improves the validation and handling of input parameters. We recommend upgrading to the latest version of the SDK to benefit from these security improvements.

How would you like to learn?

Resource	Description
Java quick start	Get up and running in five minutes with a walk through of installation, configuration, upload, management and transformations.
Sample projects	Explore sample projects to see how to implement Cloudinary functionality such as upload and delivery with transformations.
Cloudinary Java SDK GitHub repo	Explore the source code and see the CHANGELOG for details on all new features and fixes from previous versions.
Video tutorials	Watch tutorials relevant to your use cases to learn how to use Cloudinary features.
	Try the free Introduction to Cloudinary for Java Developers online course, where you can learn how to upload, manage, transform and optimize your digital assets.

Other helpful resources...

On this page:

How would you like to learn?
Install
Configure
Use
Java-specific features
Sample projects

Install

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

Note

We recommend updating the version number shown below to use the latest version of the Java SDK.

Prerequisites

If you don't already have Maven installed:

Download and install Maven (the build tool). Refer to https://maven.apache.org/download.cgi for package downloads and detailed installation instructions.
Create a Maven project. See example here.

Choose the right Cloudinary package

The Maven repository includes several Cloudinary Java packages ("artifacts"). Choose the package(s) that fit your application type:

cloudinary-http5 - for general Java applications. It utilizes the Apache HTTP libraries. When working with SDK versions v2.x, only HTTP 5 is available.
cloudinary-taglib - provides a Java Tag Library for J2EE applications
cloudinary-android - provides support for Android applications

Add Cloudinary to your project

Add the appropriate Cloudinary dependency to the list of dependencies in your pom.xml.

For general Java applications, add cloudinary-http5:
If you're building a Java EE web application, also add the cloudinary-taglib package:

Configure

Set required configuration parameters

To use the Cloudinary Java library, you have to set at least your cloud_name. An api_key and api_secret are also needed for secure API calls to Cloudinary (e.g., image and video uploads).

You can set the configuration parameters globally using one of the options shown below, or programmatically in each call to a Cloudinary method. Parameters set in a call to a Cloudinary method override globally set parameters.

Notes

The JSP tag library requires a Cloudinary instance to be available in the Singleton to function correctly. Use Option 1 or Option 3 if you're working with JSP tags.
For backward compatibility reasons, the default value of the optional secure configuration parameter is false. However, for most modern applications, it's recommended to configure the secure parameter to true to ensure that your transformation URLs are always generated as HTTPS.

Option 1: Environment variable configuration (with Singleton)

To define the CLOUDINARY_URL environment variable:

Copy the API environment variable format from the API Keys page of the Cloudinary Console Settings.
Replace <your_api_key> and <your_api_secret> with your actual values. Your cloud name is already correctly included in the format.

For example:

Once the environment variable is configured, retrieve a Cloudinary singleton instance in your code. This is the recommended option if you're using JSP tag libraries, as they require an instance to be available in the Singleton.

Option 2: Direct instance creation

Create a Cloudinary instance directly with your configuration parameters.

This approach creates a regular instance without using the singleton pattern. Use this for simple applications where you don't need JSP tag library support.

Option 3: Manual singleton registration

If you need to manually register a Cloudinary instance as a singleton (for example, when using JSP tag libraries without environment variables):

Tip

You may also want to check out the API Keys and Credentials video tutorial.

Set additional configuration parameters

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

The following example shows appending secure_distribution and upload_prefix to the environment variable:

Use

Once you've installed and configured the Java SDK, import the package and then you can use it for:

Uploading files to your product environment: You can upload any files, not only images and videos, set your own naming conventions and overwrite policies, moderate and tag your assets on upload, and much more. See example
Transforming and optimizing images and videos: Keeping your original assets intact in your product environment, you can deliver different versions of your media - different sizes, formats, with effects and overlays, customized for your needs. See example
Managing assets: Using methods from the Admin and Upload APIs, you can organize your assets, for example, list, rename and delete them, add tags and metadata and use advanced search capabilities. See example

Capitalization and data type guidelines...

Import the package

When using in Java code, import the package:

When using in a JSP view, import the tag library:

Quick example: File upload

The following Java code uploads the dog.mp4 video using the public_id, my_dog. The video overwrites the existing my_dog video if it exists. When the video upload finishes, the specified notification URL receives details about the uploaded media asset.

Learn more about upload

Read the Upload guide to learn more about customizing uploads, using upload presets and more.
See more examples of image and video upload using the Cloudinary Java library.
Explore the Upload API reference to see all available methods and options.

Quick example: Transform and optimize

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

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). Scale the logo overlay 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)
Optimize the image to reduce the size of the image without impacting visual quality.

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

In a similar way, you can transform a video.

Learn more about transformations

Read the image and video transformation guides to learn about the different ways to transform your assets.
See more examples of image and video transformations using the Cloudinary Java library.
See all possible transformations in the Transformation URL API reference.

Quick example: Get details of a single asset

The following Java example uses the Admin API resource method to return details of the image with public ID cld-sample:

Sample response

Learn more about managing assets

Check out the Image and Video asset management guide for all the different capabilities.
Get an overview of asset management using the Java SDK.
Select the Java tab in the Admin API and Upload API references to see example code snippets.

Java-specific features

You can use Cloudinary's Java SDK for any Java application. However, this SDK also provides some extra Java-specific functionality:

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
Build URLs for image and video transformation
API wrappers: file upload, administration, transformations, and more

Sample projects

Take a look at the Java sample projects page to help you get started integrating Cloudinary into your Java application.

Error

Unfortunately there's been an error sending your feedback.

Rate this page:

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.