Last updated: Oct-31-2023
This page provides an in-depth introduction to the Java SDK.
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.
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). 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:
In a similar way, you can transform a video.
The following Java code uploads the
dog.mp4 video to the specified 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.
Cloudinary provides an open source Java library for further simplifying the integration:
- Build URLs for image and video transformation
- 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:
- Full source code under MIT license with a large set of tests.
- Web application samples written for Spring MVC Framework 3.2.
- A 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-http45 - Cloudinary Apache HTTP 4.5 Library
- 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
The easiest way to start using Cloudinary's Java library is to use Maven.
- Download and install Maven. Follow https://maven.apache.org/download.cgi for reference.
- Create a maven project. See example here.
Add the Cloudinary dependency to the list of dependencies in the pom.xml:
If you are building a Java EE web application you should consider using the tag library by adding:
When using in Java code import the appropriate package:
When using in a JSP view import the tag library:
To use the Cloudinary Java library, you have to configure at least your
api_secret are also needed for secure API calls to Cloudinary (e.g., image and video uploads). You can find your product environment configuration credentials in the Dashboard page of the Cloudinary Console.
In addition to the required configuration parameters, you can define a number of optional configuration parameters if relevant.
Setting the configuration parameters can be done globally using either an environment variable or the
ObjectUtils.asMap method, or programmatically in each call to a Cloudinary method. Parameters set in a call to a Cloudinary method override globally set parameters.
secureconfiguration parameter is
false. However, for most modern applications, it's recommended to configure the
trueto ensure that your transformation URLs are always generated as HTTPS.
You can configure the required
api_secret by defining the CLOUDINARY_URL environment variable. The CLOUDINARY_URL value is available in the Dashboard page of the Cloudinary Console. When using Cloudinary through a PaaS add-on (e.g., Heroku or AppFog), this environment variable is automatically defined in your deployment environment. For example:
Set additional parameters, for example upload_prefix and cname, to the environment variable:
This will enable you to receive a Cloudinary instance:
Here's an example of setting configuration parameters in your Java application:
Or you can directly register a Cloudinary instance in your initializer code:
When using the Java SDK, keep these guidelines in mind:
- Parameter names:
snake_case. For example: public_id
PascalCase. For example: CloudinaryImageTag
camelCase. For example: imageUploadTag
- Pass parameter data as:
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.
- Learn more about uploading images and videos using the Java library.
- See examples of powerful image and video transformations using Java code, and see our image transformations and video transformation docs.
- Check out Cloudinary's asset administration capabilities, for example, renaming and deleting assets, adding tags and metadata to assets, and searching for assets.
- Stay tuned for updates with the Programmable Media Release Notes and the Cloudinary Blog.