Java Requires Chilkat v11.5.0+
Java
Box: Download Binary Content into BinData
See more Box Examples
Run the reusable setup once per HttpCurl object, then select names and execute the operation. The setup is repeated here only to make this published example independently runnable. Download a small file into memory. For large files use the direct-to-disk example.
See the Box API guide for setup and the complete workflow.
Chilkat Java Downloads
import com.chilkatsoft.*;
public class ChilkatExample {
static {
try {
System.loadLibrary("chilkat");
} catch (UnsatisfiedLinkError e) {
System.err.println("Native code library failed to load.\n" + e);
System.exit(1);
}
}
public static void main(String argv[])
{
boolean success = false;
// Requires Chilkat 11.5.0 or later and a previously unlocked Chilkat bundle.
// See Global Unlock Sample.
// Guide: Box API Guide.
success = false;
// BEGIN ONE-TIME SETUP
// This block is repeated so each published example can run on its own.
// In an application, run the setup example once and pass the SAME curl object
// to operation code below. Do not recreate it for every operation.
// See Reusable Box HttpCurl Setup.
CkHttpCurl curl = new CkHttpCurl();
curl.SetVar("access_token","BOX_ACCESS_TOKEN");
curl.SetVar("parent_name","/");
curl.SetVar("folder_name","images");
curl.SetVar("file_name","penguins.jpg");
curl.SetVar("destination_name","archive");
// Box's fixed root ID is an implementation detail; callers supply names.
curl.SetVar("parent_id","0");
CkStringBuilder setupCommand = new CkStringBuilder();
int setupReplacements;
// Register findParent; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"));
success = curl.AddFunction("findParent",setupCommand.getAsString());
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
// Register findFolder; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/{{parent_id}}/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"));
success = curl.AddFunction("findFolder",setupCommand.getAsString());
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
// Register findFile; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/{{folder_id}}/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"));
success = curl.AddFunction("findFile",setupCommand.getAsString());
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
// Register findDestination; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"));
success = curl.AddFunction("findDestination",setupCommand.getAsString());
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
// Register getFileDetails; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"));
success = curl.AddFunction("getFileDetails",setupCommand.getAsString());
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
// Register getEnterprise; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\"");
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"));
success = curl.AddFunction("getEnterprise",setupCommand.getAsString());
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
// Initial name selections. AddOutput2 stores these WHERE values literally.
success = curl.AddOutput2("findParent","entries","name",curl.getVar("parent_name"),true,"id","parent_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
success = curl.AddOutput2("findFolder","entries","name",curl.getVar("folder_name"),true,"id","folder_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
success = curl.AddOutput2("findFile","entries","name",curl.getVar("file_name"),true,"id","file_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
success = curl.AddOutput2("findDestination","entries","name",curl.getVar("destination_name"),true,"id","destination_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
success = curl.AddOutput("getFileDetails","file_version.id","file_version_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
success = curl.AddOutput("getFileDetails","sha1","file_sha1");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
success = curl.AddOutput("getEnterprise","enterprise.id","enterprise_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
// END ONE-TIME SETUP
// The name lookups below assume each listing fits in one page (1000 items).
// Parent and destination names select root children; folder_name selects a child
// of parent_name. "/" selects the root parent. These are not arbitrary paths.
// BEGIN OPERATION -- keep the configured object when reusing it.
// Inputs are names. Retain cached IDs when the selected names have not changed.
String parentName = "/";
String folderName = "images";
String fileName = "penguins.jpg";
if ((curl.getVar("parent_name") != parentName) || ((parentName == "/") && (curl.VarDefined("parent_id") == false))) {
curl.SetVar("parent_name",parentName);
curl.ClearVar("parent_id");
curl.ClearVar("folder_id");
curl.ClearVar("file_id");
curl.ClearVar("file_version_id");
curl.ClearVar("file_sha1");
if (parentName == "/") {
curl.SetVar("parent_id","0");
}
else {
success = curl.AddOutput2("findParent","entries","name",curl.getVar("parent_name"),true,"id","parent_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
}
}
if (curl.getVar("folder_name") != folderName) {
curl.SetVar("folder_name",folderName);
curl.ClearVar("folder_id");
curl.ClearVar("file_id");
curl.ClearVar("file_version_id");
curl.ClearVar("file_sha1");
success = curl.AddOutput2("findFolder","entries","name",curl.getVar("folder_name"),true,"id","folder_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
}
if (curl.getVar("file_name") != fileName) {
curl.SetVar("file_name",fileName);
curl.ClearVar("file_id");
curl.ClearVar("file_version_id");
curl.ClearVar("file_sha1");
success = curl.AddOutput2("findFile","entries","name",curl.getVar("file_name"),true,"id","file_id");
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
}
curl.ClearTargetOutput("*");
CkStringBuilder authorizedCommand1 = new CkStringBuilder();
authorizedCommand1.SetString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L");
int headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.getVar("access_token"));
success = curl.DoYourThing(authorizedCommand1.getAsString());
if ((success != true) || (curl.get_StatusCode() != 200)) {
System.out.println("Box request failed. HTTP status: " + curl.get_StatusCode());
System.out.println("Failure reason: " + curl.get_FailReason());
System.out.println(curl.responseBodyStr());
return;
}
CkBinData data = new CkBinData();
success = curl.GetResponseBd(data);
if (success != true) {
System.out.println(curl.lastErrorText());
return;
}
System.out.println("Downloaded bytes: " + data.get_NumBytes());
}
}