Skip to content

Java API client that handles uploads and further operations with files by wrapping Uploadcare Upload and REST APIs.

License

Notifications You must be signed in to change notification settings

uploadcare/uploadcare-java

uploadcare-java

Build Status Maven Central Javadocs Uploadcare stack on StackShare

This is a Java library for Uploadcare.

Supported features:

  • Complete file and project APIs v0.6.
  • Paginated resources are fetched as List<T>.
  • CDN path builder.
  • File uploading from a local storage, byte arrays, URLs, and signed uploads.

The minimum requirements to build this project are:

  1. Gradle 8.2 (you can use ./gradlew or .\gradlew.bat which will download it for you).
  2. JDK 1.8 (target is 1.7, so don't use much higher version).
  3. Running ./gradlew build should run successfully.

Maven

The latest stable library version is available at Maven Central.

Include following dependency into your project's pom.xml:

<dependency>
    <groupId>com.uploadcare</groupId>
    <artifactId>uploadcare</artifactId>
    <version>3.5.2</version>
</dependency>

Gradle

Include following dependency into your project's build.gradle:

implementation 'com.uploadcare:uploadcare:3.5.1'

If you are using the kotlin style build.gradle.kts:

implementation("com.uploadcare:uploadcare:3.5.1")

Examples

Get your API keys to proceed with the examples below.

Read class documentation on javadoc.io.

Basic API Usage

Client client = new Client("publickey", "secretkey");
Project project = client.getProject();
Project.Collaborator owner = project.getOwner();

List<URI> published = new ArrayList<URI>();
Iterable<File> files = client.getFiles().asIterable();
for (File file : files) {
    if (file.isMadePublic()) {
        published.add(file.getOriginalFileUrl());
    }
}

Building CDN URLs

File file = client.getFile("85b5644f-e692-4855-9db0-8c5a83096e25");
CdnPathBuilder builder = file.cdnPath()
        .resizeWidth(200)
        .cropCenter(200, 200)
        .grayscale();
URI url = Urls.cdn(builder);

File uploads

Client client = Client.demoClient();
java.io.File file = new java.io.File("olympia.jpg");
Uploader uploader = new FileUploader(client, sourceFile);
try {
    File file = uploader.upload().save();
    System.out.println(file.getOriginalFileUrl());
} catch (UploadFailureException e) {
    System.out.println("Upload failed :(");
}