Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/transloadit/java-sdk

Java client for Transloadit upload service
https://github.com/transloadit/java-sdk

encoding java sdk transloadit uploading

Last synced: about 2 months ago
JSON representation

Java client for Transloadit upload service

Awesome Lists containing this project

README 

        
[![Tests](https://github.com/transloadit/java-sdk/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/transloadit/java-sdk/actions/workflows/tests.yml)



## java-sdk



A **Java** Integration for [Transloadit](https://transloadit.com)'s file uploading and encoding service



## Intro



[Transloadit](https://transloadit.com) is a service that helps you handle file uploads, resize, crop and watermark your images, make GIFs, transcode your videos, extract thumbnails, generate audio waveforms, and so much more. In short, [Transloadit](https://transloadit.com) is the Swiss Army Knife for your files.



This is a **Java** SDK to make it easy to talk to the [Transloadit](https://transloadit.com) REST API.



## Install



The JARs can be downloaded manually from [Maven Central Search](https://search.maven.org/artifact/com.transloadit.sdk/transloadit),

or can be installed from the Maven repository.



Existing users should take note of the [JCenter shutdown](https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/) and update their build files to receive the most recent versions.



**Gradle:**



```groovy

implementation 'com.transloadit.sdk:transloadit:1.0.0'

```



**Maven:**



```xml



  com.transloadit.sdk

  transloadit

  1.0.0



```



## Usage



All interactions with the SDK begin with the `com.transloadit.sdk.Transloadit` class.



### Create an Assembly



To create an assembly, you use the `newAssembly` method.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.AssemblyResponse;



import java.io.File;

import java.util.HashMap;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        Assembly assembly = transloadit.newAssembly();



        Map stepOptions = new HashMap<>();

        stepOptions.put("width", 75);

        stepOptions.put("height", 75);

        assembly.addStep("resize", "/image/resize", stepOptions);



        assembly.addFile(new File("PATH/TO/FILE.jpg"));

        // you can skip this part if you don't want to wait till the

        // assembly is complete

        assembly.setShouldWaitForCompletion(true);

        try {

            AssemblyResponse response = assembly.save();



            System.out.println(response.getId());

            System.out.println(response.getUrl());

            System.out.println(response.json());



        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



### Get an Assembly



The method, `getAssembly`,  retrieves the JSON status of an assembly identified by the given `assembly_Id`.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.AssemblyResponse;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        try {

            AssemblyResponse response = transloadit.getAssembly("ASSEMBLY_ID");



            System.out.println(response.getUrl());

            System.out.println(response.json());



        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



You may also get an assembly by url with the `getAssemblyByUrl` method.



```java

    AssemblyResponse response = transloadit.getAssemblyByUrl("ASSEMBLY_URL");

```



### Cancel an Assembly



To cancel an executing assembly, you use the `cancelAssembly` method, passing the Assembly ID as a parameter.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.AssemblyResponse;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        try {

            AssemblyResponse response = transloadit.cancelAssembly("ASSEMBLY_ID");



            System.out.println(response.isCancelled()); // prints true

        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



### List Assemblies



The method, `listAssemblies`, retrieves an array of assemblies according to the given `options`. Valid `options` can be `page`,

`pagesize`, `type`, `fromdate` and `todate`. Please consult the [Transloadit API docs](https://transloadit.com/docs/api/assemblies-get/)

for details.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.ListResponse;



import java.util.HashMap;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        try {

            Map options = new HashMap<>();

            options.put("pagesize", 10);

            ListResponse response = transloadit.listAssemblies(options);



            System.out.println(response.size());  // number of assemblies on the list.

            System.out.println(response.getItems());  // returns an iterable json array



        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



### Create a Template



To create a new template, you use the `newTemplate` method, passing the template name as a parameter.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.Response;



import java.util.HashMap;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        Template template = transloadit.newTemplate("MY_TEMPLATE_NAME");



        Map resizeOptions = new HashMap<>();

        resizeOptions.put("width", 75);

        resizeOptions.put("height", 75);



        Map optimizeOptions = new HashMap<>();

        optimizeOptions.put("use", ":original");



        template.addStep("resize", "/image/resize", resizeOptions);

        template.addStep("resize", "/image/optimize", optimizeOptions);



        try {

            Response response = template.save();



            System.out.println(response.json());

            System.out.println(response.json().getString("id")); // gets the Template ID.

        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



### Update a Template



To update a template, you use the `updateTemplate` method, passing the Template ID and options to update as a parameters.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.Steps;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.Response;



import java.util.HashMap;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        Steps steps = new Steps();



        Map stepOptions = new HashMap<>();

        stepOptions.put("width", 150);

        stepOptions.put("height", 150);

        steps.addStep("resize", "/image/resize", stepOptions);



        Map templateOptions = new HashMap<>();

        templateOptions.put("steps", steps.toMap());

        templateOptions.put("name", "MY_NEW_TEMPLATE_NAME");



        try {

            Response response = transloadit.updateTemplate("TEMPLATE_ID", templateOptions);



        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



### Delete a Template



To delete a template, you use the `deleteTemplate` method, passing the Template ID as a parameter.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.Response;



import java.util.HashMap;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        try {

            Response response = transloadit.deleteTemplate("TEMPLATE_ID");



        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



### List Templates



To get a list of all templates under your account, you use the `listTemplates` method.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.ListResponse;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        try {

            ListResponse response = transloadit.listTemplates();



            System.out.println(response.size());  // number of assemblies on the list.

            System.out.println(response.getItems());  // returns an iterable json array



        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



### Get a template



To get a particular template, you use the `getTemplate` method, passing the Template ID as a parameter.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.Response;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        try {

            AssemblyResponse response = transloadit.getTemplate("TEMPLATE_ID");

            System.out.println(response.json());

        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



### Get bill



To get your account billing details for a particular month, you use the `getBill` method, passing the month and year as parameters.



```java

import com.transloadit.sdk.Transloadit;

import com.transloadit.sdk.exceptions.LocalOperationException;

import com.transloadit.sdk.exceptions.RequestException;

import com.transloadit.sdk.response.Response;



public class Main {

    public static void main(String[] args) {

        Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");



        try {

            ListResponse response = transloadit.getBill(3, 2017);



            System.out.println(response.json());

        } catch (RequestException | LocalOperationException e) {

            // handle exception here

        }

    }

}

```



## Example



For fully working examples take a look at [/examples](https://github.com/transloadit/java-sdk/tree/main/examples).



## Documentation



See [Javadoc](https://javadoc.io/doc/com.transloadit.sdk/transloadit) for full API documentation.



## License



[The MIT License](LICENSE).



## Verfication 

Releases can be verified with our GPG Release Signing Key:



`User ID: Transloadit Release Signing Key `



`Fingerprint: 2F4F F0E1 8659 76C6 5B73 782B ECBD 0B65 8705 AE5A`



Or download it from [keys.openpgp.org](https://keys.openpgp.org/vks/v1/by-fingerprint/2F4FF0E1865976C65B73782BECBD0B658705AE5A)