ImageKit Java SDK

Java SDK for ImageKit.io that implements the new APIs and interface for performing different file operations.

ImageKit is complete media storage, optimization, and transformation solution that comes with an image and video CDN. It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.

Table of contents -

Installation
Initialization
Usage
Versioning
URL generation
File upload
File management
Utility functions
Handling errors
Support
Links

Installation

Requirements

Java 1.8 or later

Gradle users

Step 1. Add the JitPack repository to your build file

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

Step 2. Add the dependency on the project's build.gradle:

dependencies {
        implementation 'com.github.imagekit-developer:imagekit-java:2.0.0'
}

Maven users

Step 1. Add the JitPack repository to your build file

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Step 2. Add the dependency in the POM file:

<dependency>
    <groupId>com.github.imagekit-developer</groupId>
    <artifactId>imagekit-java</artifactId>
    <version>2.0.0</version>
</dependency>

Initialization

Step 1. Create a config.properties file inside src/main/resources of your project. And put essential values of keys [UrlEndpoint, PrivateKey, PublicKey], no need to use quote(' or ") in values.

You can get the value of URL-endpoint from your ImageKit dashboard. API keys can be obtained from the developer section in your ImageKit dashboard.

# Put essential values of keys [UrlEndpoint, PrivateKey, PublicKey]
UrlEndpoint=your_public_api_key
PrivateKey=your_private_api_key
PublicKey=https://ik.imagekit.io/imagekit_id/

Step 2. Then you need to initialize ImageKit with that configuration.

import io.imagekit.sdk.ImageKit;
import io.imagekit.sdk.config.Configuration;
import io.imagekit.sdk.utils.Utils;
class App {
    public static void main(String[] args){
        ImageKit imageKit=ImageKit.getInstance();
        Configuration config=Utils.getSystemConfig(App.class);
        imageKit.setConfig(config);
    }
}

import io.imagekit.sdk.ImageKit;
import io.imagekit.sdk.config.Configuration;
import io.imagekit.sdk.utils.Utils;
class App {
    public static void main(String[] args) {
        ImageKit imageKit = ImageKit.getInstance();
        Configuration config = new Configuration("your_public_key", "your_private_key", "your_url_endpoint");
        imageKit.setConfig(config);
    }
}

Usage

You can use this Java SDK for 3 different kinds of methods:

URL generation
file upload
file management

The usage of the SDK has been explained below.

Change log

This document presents a list of changes that break the existing functionality of previous versions. We try our best to minimize these disruptions, but sometimes they are unavoidable and will be in major versions.

Breaking History:

Changes from 1.0.3 -> 2.0.0 are listed below

Result raw object and getMap() properties:

What changed

raw and getMap() has been deprecated.

Who is affected?

This affects any development that uses the raw or getMap() from the response object of APIs and Result object.

How should I update my code?

If you still need to use raw and getMap(), do this result.getResponseMetaData().getRaw().

Result object message and isSuccessful boolean properties:

What changed

message and isSuccessful have been replaced with custom exceptions according to response code.

Who is affected?

This affects any development that uses the message or isSuccessful from response object of APIs that is Result object.

How should I update my code?

If you still need to use message it will be there in the custom exceptions that could be raised when calling the various API methods. isSuccessful can be understood to be true if the API method doesn't throw any exception.

URL generation

1. Using image path and URL-endpoint

This method allows you to create an URL to access a file using the relative file path and the ImageKit URL endpoint (urlEndpoint). The file can be an image, video, or any other static file supported by ImageKit.

Map<String, String> queryParam=new HashMap<>();
queryParam.put("v","123");

List<Map<String, String>> transformation=new ArrayList<Map<String, String>>();
Map<String, String> scale=new HashMap<>();
scale.put("height","600");
scale.put("width","400");
scale.put("raw", "ar-4-3,q-40");
transformation.add(scale);

Map<String, Object> options=new HashMap();
options.put("urlEndpoint","https://ik.imagekit.io/your_imagekit_id/");
options.put("path","/default-image.jpg");
options.put("transformation", transformation);

String url = ImageKit.getInstance().getUrl(options);

The result in a URL like

https://ik.imagekit.io/your_imagekit_id/tr:w-400,h-600/default-image.jpg?v=123

2. Using full image URL This method allows you to add transformation parameters to an absolute URL. For example, if you have configured a custom CNAME and have absolute asset URLs in your database or CMS, you will often need this.

List<Map<String, String>> transformation=new ArrayList<Map<String, String>>();
Map<String, String> scale=new HashMap<>();
scale.put("height","600");
scale.put("width","400");
scale.put("raw", "ar-4-3,q-40");
transformation.add(scale);

Map<String, Object> options=new HashMap();
options.put("src","https://ik.imagekit.io/your_imagekit_id/default-image.jpg");
options.put("transformation", transformation);

String url = ImageKit.getInstance().getUrl(options);

The results in a URL like

https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=w-400,h-600

The .getUrl() method accepts the following parameters

Option	Description
urlEndpoint	Optional. `(Type: String)` The base URL to be appended before the path of the image. If not specified, the URL Endpoint specified during SDK initialization is used. For example, https://ik.imagekit.io/your_imagekit_id/
path	Conditional. `(Type: String)` This is the path at which the image exists. For example, `/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation.
src	Conditional. `(Type: String)` This is the complete URL of an image already mapped to ImageKit. For example, `https://ik.imagekit.io/your_imagekit_id/endpoint/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation.
transformation	Optional. `(Type: List<Map<String,String>>)` An array of objects specifying the transformation to be applied in the URL. The transformation name and the value should be specified as a key-value pair in the object. Different steps of a chained transformation can be specified as different objects of the array. The complete list of supported transformations in the SDK and some examples of using them are given later. If you use a transformation name that is not specified in the SDK, it gets applied as it is in the URL.
transformationPosition	Optional. `(Type: String)` Default value is `path` that places the transformation string as a path parameter in the URL. It can also be specified as `query`, which adds the transformation string as the query parameter `tr` in the URL. If you use the `src` parameter to create the URL, then the transformation string is always added as a query parameter.
queryParameters	Optional. `(Type: Map<String, String>)` These are the other query parameters that you want to add to the final URL. These can be any query parameters and not necessarily related to ImageKit. Especially useful if you want to add some versioning parameters to your URLs.
signed	Optional. `(Type: Boolean)` Default is `false`. If set to `true`, the SDK generates a signed image URL adding the image signature to the image URL. This can only be used if you create the URL with the `url_endpoint` and `path` parameters and not with the `src` parameter.
expireSeconds	Optional. `(Type: Integer)` Meant to be used along with the `signed` parameter to specify the time in seconds from now when the URL should expire. If specified, the URL contains the expiry timestamp in the URL, and the image signature is modified accordingly.

Examples of generating URLs

1. Chained Transformations as a query parameter

List<Map<String, String>> transformation=new ArrayList<Map<String, String>>();
Map<String, String> scale=new HashMap<>();
scale.put("height","300");
scale.put("width","400");
transformation.add(scale);
Map<String, String> rotate=new HashMap<>();
rotate.put("rotation","90");
transformation.add(rotate);

Map<String, Object> options=new HashMap();
options.put("path","/default-image.jpg");
options.put("transformationPosition","query");
options.put("transformation", transformation);

String url = ImageKit.getInstance().getUrl(options);

Sample Result URL -

https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-300&w-400:rt-90

2. Sharpening and contrast transform and a progressive JPG image

There are some transforms like Sharpening that can be added to the URL with or without any other value. To use such transforms without specifying a value, specify the value as "-" in the transformation object. Otherwise, specify the value that you want to be added to this transformation.

List<Map<String, String>> transformation=new ArrayList<Map<String, String>>();
Map<String, String> scale=new HashMap<>();
scale.put("format","jpg");
scale.put("progressive","true");
scale.put("effect_sharpen","-");
scale.put("effect_contrast","1");
transformation.add(scale);

Map<String, Object> options=new HashMap();
options.put("path","/default-image.jpg");
options.put("transformation", transformation);
String url = ImageKit.getInstance().getUrl(options);

Note that because the src parameter was used, the transformation string gets added as a query parameter.

https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=f-jpg&pr-true&e-sharpen&e-contrast-1

3. Signed URL that expires in 300 seconds with the default URL endpoint and other query parameters

List<Map<String, String>> transformation=new ArrayList<Map<String, String>>();
Map<String, String> scale=new HashMap<>();
scale.put("height","600");
scale.put("width","400");

transformation.add(format);

Map<String, Object> options=new HashMap();
options.put("path","/default-image.jpg");
options.put("signed",true);
options.put("expireSeconds",300);
String url = ImageKit.getInstance().getUrl(options);

Sample Result URL

https://ik.imagekit.io/your_imagekit_id/tr:h-600,w-400/default-image.jpg?ik-t=1567358667&ik-s=f2c7cdacbe7707b71a83d49cf1c6110e3d701054

4. Adding overlays

ImageKit.io enables you to apply overlays to images and videos using the raw parameter with the concept of layers. The raw parameter facilitates incorporating transformations directly in the URL. A layer is a distinct type of transformation that allows you to define an asset to serve as an overlay, along with its positioning and additional transformations.

Text as overlays

You can add any text string over a base video or image using a text layer (l-text).

For example:

List<Map<String, String>> transformation=new ArrayList<Map<String, String>>();
Map<String, String> scale=new HashMap<>();
scale.put("height","300");
scale.put("width","400");
scale.put("raw", "l-text,i-Imagekit,fs-50,l-end");
transformation.add(scale);

Map<String, Object> options=new HashMap();
options.put("src","https://ik.imagekit.io/your_imagekit_id/default-image.jpg");
options.put("transformation", transformation);

String url = ImageKit.getInstance().getUrl(options);

Sample Result URL

https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-300,w-400,l-text,i-Imagekit,fs-50,l-end

Image as overlays

You can add an image over a base video or image using an image layer (l-image).

For example:

List<Map<String, String>> transformation=new ArrayList<Map<String, String>>();
Map<String, String> scale=new HashMap<>();
scale.put("height","300");
scale.put("width","400");
scale.put("raw", "l-image,i-default-image.jpg,w-100,b-10_CDDC39,l-end");
transformation.add(scale);

Map<String, Object> options=new HashMap();
options.put("src","https://ik.imagekit.io/your_imagekit_id/default-image.jpg");
options.put("transformation", transformation);

String url = ImageKit.getInstance().getUrl(options);

Sample Result URL

https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-300,w-400,l-image,i-default-image.jpg,w-100,b-10_CDDC39,l-end

Solid color blocks as overlays

You can add solid color blocks over a base video or image using an image layer (l-image).

For example:

List<Map<String, String>> transformation=new ArrayList<Map<String, String>>();
Map<String, String> scale=new HashMap<>();
scale.put("height","300");
scale.put("width","400");
scale.put("raw", "l-image,i-ik_canvas,bg-FF0000,w-300,h-100,l-end");
transformation.add(scale);

Map<String, Object> options=new HashMap();
options.put("src","https://ik.imagekit.io/your_imagekit_id/img/sample-video.mp4");
options.put("transformation", transformation);

String url = ImageKit.getInstance().getUrl(options);

Sample Result URL

https://ik.imagekit.io/your_imagekit_id/img/sample-video.mp4?tr=h-300,w-400,l-image,i-ik_canvas,bg-FF0000,w-300,h-100,l-end

List of transformations

See the complete list of image and video transformations supported in ImageKit. The SDK gives a name to each transformation parameter e.g. height for h and width for w parameter. It makes your code more readable. If the property does not match any of the following supported options, it is added as it is.

If you want to generate transformations in your application and add them to the URL as it is, use the raw parameter.

Supported Transformation Name	Translates to parameter
height	h
width	w
aspectRatio	ar
quality	q
crop	c
cropMode	cm
x	x
y	y
focus	fo
format	f
radius	r
background	bg
border	b
rotation	rt
blur	bl
named	n
progressive	pr
lossless	lo
trim	t
metadata	md
colorProfile	cp
defaultImage	di
dpr	dpr
effectSharpen	e-sharpen
effectUSM	e-usm
effectContrast	e-contrast
effectGray	e-grayscale
original	orig
raw	`replaced by the parameter value`

File Upload

The SDK provides a simple interface using the .upload() method to upload files to the ImageKit Media library. It accepts an object of the FileCreateRequest class that contains all the parameters supported by the ImageKit Upload API.

The constructor FileCreateRequest class requires file as (URL/Base64/Byte Array) and file_name. The method returns object of Result in case of successful, or it will throw custom exception in case of failure.

Sample usage

String filePath = "your-local-file-path";
String base64 = Utils.fileToBase64(new File(filePath));
FileCreateRequest fileCreateRequest = new FileCreateRequest(base64, "file_name.jpg");
String customCoordinates = "10,10,20,20";
fileCreateRequest.setCustomCoordinates(customCoordinates);  // optional
List<String> tags = new ArrayList<>();
tags.add("Sample-tag");
tags.add("T-shirt");
fileCreateRequest.setTags(tags); // optional
fileCreateRequest.setFileName("override_file_name.jpg");  // optional
fileCreateRequest.setFolder("sample-folder/nested-folder");  // optional
fileCreateRequest.setPrivateFile(false);  // optional
fileCreateRequest.setUseUniqueFileName(true);  // optional
List<String> responseFields=new ArrayList<>();
responseFields.add("tags");
responseFields.add("customCoordinates");
fileCreateRequest.setResponseFields(responseFields); // optional
JsonObject innerObject1 = new JsonObject();
innerObject1.addProperty("name", "remove-bg");
innerObject1.add("options", optionsInnerObject);
JsonObject innerObject2 = new JsonObject();
innerObject2.addProperty("name", "google-auto-tagging");
innerObject2.addProperty("minConfidence", 10);
innerObject2.addProperty("maxTags", 5);
JsonArray jsonArray = new JsonArray();
jsonArray.add(innerObject1);
jsonArray.add(innerObject2);
fileCreateRequest.setExtensions(jsonArray); // optional
fileCreateRequest.setWebhookUrl("Your webhook url"); // optional
fileCreateRequest.setOverwriteFile(true); // optional
fileCreateRequest.setOverwriteAITags(true); // optional
fileCreateRequest.setOverwriteTags(true); // optional
fileCreateRequest.setOverwriteCustomMetadata(true); // optional
JsonObject jsonObjectCustomMetadata = new JsonObject();
jsonObjectCustomMetadata.addProperty("test1", 10);
fileCreateRequest.setCustomMetadata(jsonObjectCustomMetadata); // optional
Result result = ImageKit.getInstance().upload(fileCreateRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

If the upload is successful, result will be there as an object of Result class that contains the same all the parameters received from ImageKit's servers.

If the upload fails, custom exception is thrown and getMessage() can be called to get the error message received from ImageKit's servers.

File Management

The SDK provides a simple interface for all the media APIs mentioned here to manage your files. This also returns error and result, the error will be None if API succeeds.

1. List & Search Files

Accepts an object of class GetFileListRequest specifying the parameters to be used to list and search files. All parameters specified in the documentation here can be passed via their setter functions to get the results.

Applying Filters

Filter out the files by specifying the parameters.

String[] tags = new String[3];
tags[0] = "Software";
tags[1] = "Developer";
tags[2] = "Engineer";
GetFileListRequest getFileListRequest = new GetFileListRequest();
getFileListRequest.setType("file");
getFileListRequest.setSort("ASC_CREATED");
getFileListRequest.setPath("/");
getFileListRequest.setFileType("all");
getFileListRequest.setLimit("4");
getFileListRequest.setSkip("1");
getFileListRequest.setTags(tags);
ResultList resultList = ImageKit.getInstance().getFileList(getFileListRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultList);
System.out.println("Raw Response:");
System.out.println(resultList.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultList.getResponseMetaData().getMap());

Advance Search

In addition, you can fine-tune your query by specifying various filters by generating a query string in a Lucene-like syntax and setting this generated string to the GetFileListRequest object using setSearchQuery function.

GetFileListRequest getFileListRequest = new GetFileListRequest();
getFileListRequest.setSearchQuery("createdAt >= '2d' OR size < '2mb' OR format='png'");
ResultList resultList = ImageKit.getInstance().getFileList(getFileListRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultList);
System.out.println("Raw Response:");
System.out.println(resultList.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultList.getResponseMetaData().getMap());

Detailed documentation can be found here for advance search queries.

2. Get File Details

Accepts the file ID and fetches the details as per the API documentation here

String fileId="your-file-id";
Result result=ImageKit.getInstance().getFileDetail(fileId);
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

3. Get File Versions

Accepts the file ID and fetches the details as per the API documentation here.

String fileId = "62a04834c10d49825c6de9e8";
ResultFileVersions resultFileVersions = ImageKit.getInstance().getFileVersions(fileId);
System.out.println("======FINAL RESULT=======");
System.out.println(resultFileVersions);
System.out.println("Raw Response:");
System.out.println(resultFileVersions.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultFileVersions.getResponseMetaData().getMap());

4. Get File Version details

Accepts the file ID and version ID and fetches the details as per the API documentation here.

String fileId = "62a04834c10d49825c6de9e8";
String versionId = "62a04834c10d49825c6de9e8";
ResultFileVersionDetails resultFileVersionDetails = ImageKit.getInstance().getFileVersionDetails(fileId, versionId);
System.out.println("======FINAL RESULT=======");
System.out.println(resultFileVersionDetails);
System.out.println("Raw Response:");
System.out.println(resultFileVersionDetails.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultFileVersionDetails.getResponseMetaData().getMap());

5. Update File Details

Accepts an object of class FileUpdateRequest specifying the parameters to be used to update file details. All parameters specified in the [documentation here] (https://docs.imagekit.io/api-reference/media-api/update-file-details) can be passed via their setter functions to get the results.

List<String> tags = new ArrayList<>();
tags.add("Software");
tags.add("Developer");
tags.add("Engineer");

List<String> aiTags = new ArrayList<>();
aiTags.add("Plant");
FileUpdateRequest fileUpdateRequest = new FileUpdateRequest("fileId");
fileUpdateRequest.setTags(tags);
fileUpdateRequest.setRemoveAITags(aiTags);
fileUpdateRequest.setWebhookUrl("https://webhook.site/c78d617f-33bc-40d9-9e61-608999721e2e");

JsonObject optionsInnerObject = new JsonObject();
optionsInnerObject.addProperty("add_shadow", true);
optionsInnerObject.addProperty("bg_color", "yellow");
JsonObject innerObject1 = new JsonObject();
innerObject1.addProperty("name", "remove-bg");
innerObject1.add("options", optionsInnerObject);
JsonObject innerObject2 = new JsonObject();
innerObject2.addProperty("name", "google-auto-tagging");
innerObject2.addProperty("minConfidence", 15);
innerObject2.addProperty("maxTags", 20);
JsonArray jsonArray = new JsonArray();
jsonArray.add(innerObject1);
jsonArray.add(innerObject2);

fileUpdateRequest.setExtensions(jsonArray);
fileUpdateRequest.setCustomCoordinates("10,10,40,40");
JsonObject jsonObjectCustomMetadata = new JsonObject();
jsonObjectCustomMetadata.addProperty("test10", 11);
fileUpdateRequest.setCustomMetadata(jsonObjectCustomMetadata);
Result result=ImageKit.getInstance().updateFileDetail(fileUpdateRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

6. Add tags

Accepts an object of class TagsRequest specifying the parameters to be used to add tags. All parameters specified in the documentation here can be passed via their setter functions to get the results.

List<String> fileIds = new ArrayList<>();
fileIds.add("FileId");
List<String> tags = new ArrayList<>();
tags.add("tag-to-add-1");
tags.add("tag-to-add-2");
ResultTags resultTags=ImageKit.getInstance().addTags(new TagsRequest(fileIds, tags));
System.out.println("======FINAL RESULT=======");
System.out.println(resultTags);
System.out.println("Raw Response:");
System.out.println(resultTags.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultTags.getResponseMetaData().getMap());

7. Remove tags

Accepts an object of class TagsRequest specifying the parameters to be used to remove tags. All parameters specified in the documentation here can be passed via their setter functions to get the results.

List<String> fileIds = new ArrayList<>();
fileIds.add("FileId");
List<String> tags = new ArrayList<>();
tags.add("tag-to-remove-1");
tags.add("tag-to-remove-2");
ResultTags resultTags=ImageKit.getInstance().removeTags(new TagsRequest(fileIds, tags));
System.out.println("======FINAL RESULT=======");
System.out.println(resultTags);
System.out.println("Raw Response:");
System.out.println(resultTags.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultTags.getResponseMetaData().getMap());

8. Remove AI tags

Accepts an object of class AITagsRequest specifying the parameters to be used to remove AI tags. All parameters specified in the documentation here can be passed via their setter functions to get the results.

List<String> fileIds = new ArrayList<>();
fileIds.add("629f3de17eb0fe4053615450");
List<String> aiTags = new ArrayList<>();
aiTags.add("Rectangle");
AITagsRequest aiTagsRequest =new AITagsRequest();
aiTagsRequest.setFileIds(fileIds);
aiTagsRequest.setAITags(aiTags);
ResultTags resultTags = ImageKit.getInstance().removeAITags(aiTagsRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultTags);
System.out.println("Raw Response:");
System.out.println(resultTags.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultTags.getResponseMetaData().getMap());

9. Delete File

Accepts the file ID and delete a file as per the API documentation here.

String fileId="your-file-id";
Result result=ImageKit.getInstance().deleteFile(fileId);
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

10. Delete FileVersion

Accepts an object of class DeleteFileVersionRequest specifying the parameters to be used to delete file version. All parameters specified in the documentation here can be passed via their setter functions to get the results.

DeleteFileVersionRequest deleteFileVersionRequest = new DeleteFileVersionRequest();
deleteFileVersionRequest.setFileId("629d95278482ba129fd17c97");
deleteFileVersionRequest.setVersionId("629d953ebd24e8ceca911a66");
ResultNoContent resultNoContent = ImageKit.getInstance().deleteFileVersion(deleteFileVersionRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultNoContent);
System.out.println("Raw Response:");
System.out.println(resultNoContent.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultNoContent.getResponseMetaData().getMap());

11. Delete files (bulk)

Accepts the file IDs to delete files as per the API documentation here.

List<String> fileIds = new ArrayList<>();
fileIds.add("your-file-id");
fileIds.add("your-file-id");
fileIds.add("your-file-id");

ResultFileDelete result=ImageKit.getInstance().bulkDeleteFiles(fileIds);
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

12. Copy file

Accepts an object of class CopyFileRequest specifying the parameters to be used to copy file. All parameters specified in the documentation here can be passed via their setter functions to get the results.

CopyFileRequest copyFileRequest = new CopyFileRequest();
copyFileRequest.setSourceFilePath("/w2_image.png");
copyFileRequest.setDestinationPath("/Gallery/");
copyFileRequest.setIncludeFileVersions(true);
ResultNoContent resultNoContent = ImageKit.getInstance().copyFile(copyFileRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultNoContent);
System.out.println("Raw Response:");
System.out.println(resultNoContent.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultNoContent.getResponseMetaData().getMap());

13. Move file

Accepts an object of class MoveFileRequest specifying the parameters to be used to move file. All parameters specified in the documentation here can be passed via their setter functions to get the results.

MoveFileRequest moveFileRequest = new MoveFileRequest();
moveFileRequest.setSourceFilePath("/Gallery/w2_image.png");
moveFileRequest.setDestinationPath("/");
ResultNoContent resultNoContent = ImageKit.getInstance().moveFile(moveFileRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultNoContent);
System.out.println("Raw Response:");
System.out.println(resultNoContent.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultNoContent.getResponseMetaData().getMap());

14. Rename file

Accepts an object of class RenameFileRequest specifying the parameters to be used to rename file. All parameters specified in the documentation here can be passed via their setter functions to get the results.

RenameFileRequest renameFileRequest = new RenameFileRequest();
renameFileRequest.setFilePath("/w2_image.png");
renameFileRequest.setNewFileName("w2_image_s.png");
renameFileRequest.setPurgeCache(true);
ResultRenameFile resultRenameFile = ImageKit.getInstance().renameFile(renameFileRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultRenameFile);
System.out.println("Raw Response:");
System.out.println(resultRenameFile.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultRenameFile.getResponseMetaData().getMap());

15. Restore file Version

Accepts the fileId and versionId to restore file version as per the API documentation here.

Result result = ImageKit.getInstance().restoreFileVersion("fileId", "versionId");
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

16. Create Folder

Accepts an object of class CreateFolderRequest specifying the parameters to be used to create folder. All parameters specified in the documentation here can be passed via their setter functions to get the results.

CreateFolderRequest createFolderRequest = new CreateFolderRequest();
createFolderRequest.setFolderName("test1");
createFolderRequest.setParentFolderPath("/");
ResultEmptyBlock resultEmptyBlock = ImageKit.getInstance().createFolder(createFolderRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultEmptyBlock);
System.out.println("Raw Response:");
System.out.println(resultEmptyBlock.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultEmptyBlock.getResponseMetaData().getMap());

17. Delete Folder

Accepts an object of class DeleteFolderRequest specifying the parameters to be used to delete folder. All parameters specified in the documentation here can be passed via their setter functions to get the results.

DeleteFolderRequest deleteFolderRequest = new DeleteFolderRequest();
deleteFolderRequest.setFolderPath("/test1");
ResultNoContent resultNoContent = ImageKit.getInstance().deleteFolder(deleteFolderRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultNoContent);
System.out.println("Raw Response:");
System.out.println(resultNoContent.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultNoContent.getResponseMetaData().getMap());

18. Copy Folder

Accepts an object of class CopyFolderRequest specifying the parameters to be used to copy folder. All parameters specified in the documentation here can be passed via their setter functions to get the results.

CopyFolderRequest copyFolderRequest = new CopyFolderRequest();
copyFolderRequest.setSourceFolderPath("/Gallery/test");
copyFolderRequest.setDestinationPath("/");
ResultOfFolderActions resultOfFolderActions = ImageKit.getInstance().copyFolder(copyFolderRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultOfFolderActions);
System.out.println("Raw Response:");
System.out.println(resultOfFolderActions.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultOfFolderActions.getResponseMetaData().getMap());

19. Move Folder

Accepts an object of class MoveFolderRequest specifying the parameters to be used to move folder. All parameters specified in the documentation here can be passed via their setter functions to get the results.

MoveFolderRequest moveFolderRequest = new MoveFolderRequest();
moveFolderRequest.setSourceFolderPath("/Gallery/test");
moveFolderRequest.setDestinationPath("/");
ResultOfFolderActions resultOfFolderActions = ImageKit.getInstance().moveFolder(moveFolderRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultOfFolderActions);
System.out.println("Raw Response:");
System.out.println(resultOfFolderActions.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultOfFolderActions.getResponseMetaData().getMap());

20. Get Bulk Job Status

Accepts the jobId to get bulk job status as per the API documentation here.

String jobId = "629f44ac7eb0fe8173622d4b";
ResultBulkJobStatus resultBulkJobStatus = ImageKit.getInstance().getBulkJobStatus(jobId);
System.out.println("======FINAL RESULT=======");
System.out.println(resultBulkJobStatus);
System.out.println("Raw Response:");
System.out.println(resultBulkJobStatus.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultBulkJobStatus.getResponseMetaData().getMap());

21. Purge Cache

Accepts a full URL of the file for which the cache has to be cleared as per the API documentation here.

ResultCache result=ImageKit.getInstance().purgeCache("https://ik.imagekit.io/imagekit-id/default-image.jpg");
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

22. Purge Cache Status

Accepts a request ID and fetch purge cache status as per the API documentation here

String requestId="cache-requestId";
ResultCacheStatus result=ImageKit.getInstance().getPurgeCacheStatus(requestId);
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

23. Get File Metadata

Accepts the file ID and fetches the metadata as per the API documentation here

String fileId="your-file-id";
ResultMetaData result=ImageKit.getInstance().getFileMetadata(fileId);
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

Another way to get metadata from a remote file URL as per the API documentation here. This file should be accessible over the ImageKit.io URL-endpoint.

String url="Remote File URL";
ResultMetaData result=ImageKit.getInstance().getRemoteFileMetadata(url);
System.out.println("======FINAL RESULT=======");
System.out.println(result);
System.out.println("Raw Response:");
System.out.println(result.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(result.getResponseMetaData().getMap());

24. Create CustomMetaDataFields

Accepts an object of class CustomMetaDataFieldCreateRequest specifying the parameters to be used to create cusomMetaDataFields. All parameters specified in the documentation here can be passed as-is with the correct values to get the results.

Check for the Allowed Values In The Schema.

Examples:

CustomMetaDataFieldSchemaObject schemaObject = new CustomMetaDataFieldSchemaObject();
schemaObject.setType("Number");
schemaObject.setMinValue(10);
schemaObject.setMaxValue(200);
CustomMetaDataFieldCreateRequest customMetaDataFieldCreateRequest = new CustomMetaDataFieldCreateRequest();
customMetaDataFieldCreateRequest.setName("Name");
customMetaDataFieldCreateRequest.setLabel("Label");
customMetaDataFieldCreateRequest.setSchema(schemaObject);
ResultCustomMetaDataField resultCustomMetaDataField=ImageKit.getInstance().createCustomMetaDataFields(customMetaDataFieldCreateRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultCustomMetaDataField);
System.out.println("Raw Response:");
System.out.println(resultCustomMetaDataField.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultCustomMetaDataField.getResponseMetaData().getMap());

MultiSelect type Exmample:

List<Object> objectList = new ArrayList<>();
objectList.add("small");
objectList.add(30);
objectList.add(40);
objectList.add(true);

List<Object> defaultValueObject = new ArrayList<>();
defaultValueObject.add("small");
defaultValueObject.add(30);
defaultValueObject.add(true);
CustomMetaDataFieldSchemaObject customMetaDataFieldSchemaObject = new CustomMetaDataFieldSchemaObject();
customMetaDataFieldSchemaObject.setType("MultiSelect");
customMetaDataFieldSchemaObject.setValueRequired(true);                 // optional
customMetaDataFieldSchemaObject.setDefaultValue(defaultValueObject);    // required if isValueRequired set to true
customMetaDataFieldSchemaObject.setSelectOptions(objectList);
CustomMetaDataFieldCreateRequest customMetaDataFieldCreateRequest = new CustomMetaDataFieldCreateRequest();
customMetaDataFieldCreateRequest.setName("Name-MultiSelect");
customMetaDataFieldCreateRequest.setLabel("Label-MultiSelect");
customMetaDataFieldCreateRequest.setSchema(customMetaDataFieldSchemaObject);

ResultCustomMetaDataField resultCustomMetaDataField = ImageKit.getInstance()
      .createCustomMetaDataFields(customMetaDataFieldCreateRequest);

Date type Exmample:

CustomMetaDataFieldSchemaObject customMetaDataFieldSchemaObject = new CustomMetaDataFieldSchemaObject();
customMetaDataFieldSchemaObject.setType("Date");
customMetaDataFieldSchemaObject.setValueRequired(true);                          // optional
customMetaDataFieldSchemaObject.setDefaultValue("2022-11-30T10:11:10+00:00");    // required if isValueRequired set to true
customMetaDataFieldSchemaObject.setMinValue("2022-11-30T10:11:10+00:00");
customMetaDataFieldSchemaObject.setMaxValue("2022-12-30T10:11:10+00:00");

CustomMetaDataFieldCreateRequest customMetaDataFieldCreateRequest = new CustomMetaDataFieldCreateRequest();
customMetaDataFieldCreateRequest.setName("Name");
customMetaDataFieldCreateRequest.setLabel("Label");
customMetaDataFieldCreateRequest.setSchema(customMetaDataFieldSchemaObject);

ResultCustomMetaDataField resultCustomMetaDataField = ImageKit.getInstance()
       .createCustomMetaDataFields(customMetaDataFieldCreateRequest);

25. Get CustomMetaDataFields

Accepts the includeDeleted boolean and fetches the metadata as per the API documentation here

ResultCustomMetaDataFieldList resultCustomMetaDataFieldList=ImageKit.getInstance().getCustomMetaDataFields(false);
System.out.println("======FINAL RESULT=======");
System.out.println(resultCustomMetaDataFieldList);
System.out.println("Raw Response:");
System.out.println(resultCustomMetaDataFieldList.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultCustomMetaDataFieldList.getResponseMetaData().getList());
System.out.println(resultCustomMetaDataFieldList.getResultCustomMetaDataFields());

26. Edit CustomMetaDataFields

Accepts an ID of customMetaDataField and object of class CustomMetaDataFieldUpdateRequest specifying the parameters to be used to edit cusomMetaDataFields as per the API documentation here.

CustomMetaDataFieldSchemaObject schemaObject = new CustomMetaDataFieldSchemaObject();
schemaObject.setMinValue(10);
schemaObject.setMaxValue(200);

CustomMetaDataFieldUpdateRequest customMetaDataFieldUpdateRequest = new CustomMetaDataFieldUpdateRequest();
customMetaDataFieldUpdateRequest.setId("id");
customMetaDataFieldUpdateRequest.setLabel("label");
customMetaDataFieldUpdateRequest.setSchema(schemaObject);
ResultCustomMetaDataField resultCustomMetaDataField=ImageKit.getInstance().updateCustomMetaDataFields(customMetaDataFieldUpdateRequest);
System.out.println("======FINAL RESULT=======");
System.out.println(resultCustomMetaDataField);
System.out.println("Raw Response:");
System.out.println(resultCustomMetaDataField.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultCustomMetaDataField.getResponseMetaData().getMap());

27. Delete CustomMetaDataFields

Accepts the id to delete the customMetaDataFields as per the API documentation here.

ResultNoContent resultNoContent=ImageKit.getInstance().deleteCustomMetaDataField("id");
System.out.println("======FINAL RESULT=======");
System.out.println(resultNoContent);
System.out.println("Raw Response:");
System.out.println(resultNoContent.getResponseMetaData().getRaw());
System.out.println("Map Response:");
System.out.println(resultNoContent.getResponseMetaData().getMap());

Utility functions

We have included the following commonly used utility functions in this package.

Authentication parameter generation

In case you are looking to implement client-side file upload, you are going to need a token, expiry timestamp, and a valid signature for that upload. The SDK provides a simple method that you can use in your code to generate these authentication parameters for you.

Note: The Private API Key should never be exposed in any client-side code. You must always generate these authentications parameters on the server-side

authentication

Map<String,String> authenticationParams = ImageKit.getInstance().getAuthenticationParameters(token, expire);

Returns Map object of this json

{
    "token": "unique_token",
    "expire": "valid_expiry_timestamp",
    "signature": "generated_signature"
}

Both the token and expire parameters are optional. If not specified, the SDK uses the uuid to generate a random token and also generates a valid expiry timestamp internally. The value of the token and expire used to generate the signature are always returned in the response, no matter if they are provided as an input to this method or not.

Distance calculation between two pHash values

Perceptual hashing allows you to construct a hash value that uniquely identifies an input image based on the contents of an image. imagekit.io metadata API returns the pHash value of an image in the response. You can use this value to find a duplicate (or similar) images by calculating the distance between the two images.

This SDK exposes phash_distance function to calculate the distance between two pHash value. It accepts two pHash hexadecimal strings and returns a numeric value indicative of the level of difference between the two images.

int calculateDistance(){
    // fetch metadata of two uploaded image files
    ...
    // extract pHash strings from both: say 'first_hash' and 'second_hash'
    ...
    // calculate the distance between them:

    int distance = ImageKit.getInstance().pHashDistance(first_hash, second_hash);
    return distance;
}

Distance calculation examples

ImageKit.getInstance().pHashDistance("f06830ca9f1e3e90", "f06830ca9f1e3e90");
// output: 0 (ame image)

ImageKit.getInstance().pHashDistance("2d5ad3936d2e015b", "2d6ed293db36a4fb");
// output: 17 (similar images)

ImageKit.getInstance().pHashDistance("a4a65595ac94518b", "7838873e791f8400");
// output: 37 (dissimilar images)

HTTP response metadata of Internal API

HTTP response metadata of the internal API call can be accessed using the getResponseMetaData function on the Result (or ResultList, ResultCache etc.) object. Example:

Result result = ImageKit.getInstance().upload(fileCreateRequest);
result.getResponseMetaData().getRaw();
result.getResponseMetaData().getHeaders();
result.getResponseMetaData().getHttpStatusCode();

Sample Code Instruction

1. First clone this repository to your system using git.

git clone https://github.com/imagekit-developer/imagekit-java.git

2. Open project in your favorite Java IDE that can supports Gradle dependency management or you can use Terminal/Command Prompt.

3. Goto src/main/resources directory.

4. Rename file config.sample.properties to config.properties.

5. Edit config.properties and write values of given keys.

UrlEndpoint=your_url_endpoint
PrivateKey=your_private_key
PublicKey=your_public_key

5. You will find App.java in src/main/java/io/imagekit/sampleapp/ directory. Edit program as you need, then run App.java. If you are using CLI Tool (Terminal/Command Prompt) Then Open Project in CLI and execute using gradle

cd imagekit-java
./gradlew run

Run test case:
```
./gradlew imagekit-sdk:test
```

Build ImageKit SDK:

./gradlew imagekit-sdk:clean
./gradlew imagekit-sdk:build
# You will find jar in "imagekit-sdk/build/libs/" directory.

Handling errors

Catch and respond to invalid data, internal problems, and more.

Imagekit Java SDK raise exceptions for many reasons, such as not found, invalid parameters, authentication errors, and internal server error. We recommend writing code that gracefully handles all possible API exceptions.

Example:

try {
  // Use ImageKit's SDK to make requests...
} catch (BadRequestException e) {
  // Missing or Invalid parameters were supplied to Imagekit.io's API
  System.out.println("Status is: " + e.getResponseMetaData().getHttpStatusCode());
  System.out.println("Message is: " + e.getMessage());
  System.out.println("Headers are: " + e.getResponseMetaData().getHeaders());
  System.out.println("Raw body is: " + e.getResponseMetaData().getRaw());
  System.out.println("Mapped body is: " + e.getResponseMetaData().getMap());
} catch (UnauthorizedException e) {
  // No valid API key was provided.
} catch (ForbiddenException e) {
  // Can be for the following reasons: 
  // ImageKit could not authenticate your account with the keys provided.
  // An expired key (public or private) was used with the request.
  // The account is disabled.
  // If you are using the upload API, the total storage limit (or upload limit) is exceeded.
} catch (TooManyRequestsException e) {
  // Too many requests made to the API too quickly
} catch (InternalServerException e) {
  // Something went wrong with ImageKit.io API.
} catch (PartialSuccessException e) {
  // Error cases on partial success.
} catch (NotFoundException e) {
  // If any of the field or parameter is not found in data 
} catch (UnknownException e) {
  // Something else happened, which can be unrelated to imagekit, reason will be indicated in the message field
}

Supporttim

For any feedback or to report any issues or general implementation support, please reach out to [support@imagekit.io]()

License

Released under the MIT license.

imagekit-developer / imagekit-java

readme

ImageKit Java SDK

Installation

Requirements

Gradle users

Maven users

Initialization

Usage

Change log

Breaking History:

URL generation

Examples of generating URLs

File Upload

File Management

Applying Filters

Advance Search

Examples:

Utility functions

Sample Code Instruction

Handling errors

Example:

Supporttim

Links

License