Over a million developers have joined DZone.

Ingesting Box.com Documents Into HDFS via Java

DZone 's Guide to

Ingesting Box.com Documents Into HDFS via Java

Learn how to load data from Box.com using the Java API — a pretty straightforward process as long as you don't forget to copy down your developer token.

· Big Data Zone ·
Free Resource

It's pretty straightforward to access Box.com Files.

Create a Box.com Application

The URL will look like this:


Get your client API, client secret, and developer token, then use server authentication with OAuth 2.0 + JWT. Finally, add a public key from your developer machine and server.

This takes a few steps and you have to create a Private and Public key.

openssl genrsa -aes256 -out private_key.pem 2048
openssl rsa -pubout -in private_key.pem -out public_key.pem

Anatomy of a Box.com Directory


You need the # to access that directory; it is the Folder ID.

Box.com Java SDK:


Create a new Java Maven application:

mvn archetype:generate -DgroupId=com.yourenterprise -DartifactId=boxapp -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

Java code:

package com.dataflowdeveloper;

import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.io.IOUtils;

import com.box.sdk.BoxAPIConnection;
import com.box.sdk.BoxFile;
import com.box.sdk.BoxFolder;
import com.box.sdk.BoxItem;
import com.box.sdk.BoxUser;

public final class Main {

    // developer token expires in an hour
    private static final String DEVELOPER_TOKEN = "somelongtokenlasts1hour";
    private static final int MAX_DEPTH = 1;

    private Main() { }

    public static void main(String[] args) {

        BoxAPIConnection api = new BoxAPIConnection(DEVELOPER_TOKEN);
        BoxUser.Info userInfo = BoxUser.getCurrentUser(api).getInfo();
        System.out.format("Welcome, %s <%s>!\n\n", userInfo.getName(), userInfo.getLogin());

//   the example code lists everything from your root folder down, that could be
// alot, I have 75K files
//        BoxFolder rootFolder = BoxFolder.getRootFolder(api);
//        listFolder(rootFolder, 0);

        BoxFile file = null;

        // this is the id of the folder, you can get this two ways from either the URL or
// looking at the output of the root crawl
        BoxFolder folder = new BoxFolder(api, "15296958056");
        for (BoxItem.Info itemInfo : folder) {
            if (itemInfo instanceof BoxFile.Info) {
                BoxFile.Info fileInfo = (BoxFile.Info) itemInfo;

// lets look at all the attributes, many are null
                System.out.println("File:" + fileInfo.getCreatedAt() + "," +
                fileInfo.getDescription() + "," +
                fileInfo.getExtension() + ",name=" + 
                fileInfo.getName() + ",id=" + 
                fileInfo.getID() + "," +
                fileInfo.getCreatedBy() + "," + 
                fileInfo.getSize() + "," + 
                fileInfo.getVersion().getName() + "," + 
                fileInfo.getCreatedAt() + "," + 
                fileInfo.getModifiedAt() + "," + 
                fileInfo.getModifiedBy() + 

                // download all the pdfs
                if ( fileInfo.getName() != null && fileInfo.getID() != null && fileInfo.getName().endsWith(".pdf")) {
                file = new BoxFile(api, fileInfo.getID());
                FileOutputStream stream = null;
try {
stream = new FileOutputStream(fileInfo.getName());
} catch (FileNotFoundException e) {
                file.download(stream); // downloads to current directory specified in above fileoutputstream

                //Input stream for the file in local file system to be written to HDFS
                InputStream in = null;
try {
in = new BufferedInputStream(new FileInputStream(fileInfo.getName()));
} catch (FileNotFoundException e1) {

                        System.out.println("Save to HDFS " + fileInfo.getName());

                      //Destination file in HDFS
                        Configuration conf = new Configuration();
                        String dst = "hdfs://yourserver:8020/box/" + fileInfo.getName();

                        FileSystem fs = FileSystem.get(URI.create(dst), conf);
                        OutputStream out = fs.create(new Path(dst));

                      //Copy file from local to HDFS
                      IOUtils.copyBytes(in, out, 4096, true);

                      java.nio.file.Path path = FileSystems.getDefault().getPath(fileInfo.getName());                     

                }catch(Exception e){
                    System.out.println("File not found");

    private static void listFolder(BoxFolder folder, int depth) {
        for (BoxItem.Info itemInfo : folder) {
            String indent = "";
            for (int i = 0; i < depth; i++) {
                indent += "    ";

            // you need this ID for accessing a folder
            System.out.println(indent + itemInfo.getName() + ",ID=" + itemInfo.getID() );

            if (itemInfo instanceof BoxFolder.Info) {
                BoxFolder childFolder = (BoxFolder) itemInfo.getResource();
                if (depth < MAX_DEPTH) {
                    listFolder(childFolder, depth + 1);


By default, you can only use the developer token, which only lasts for one hour. As soon as you save, it will vanish from the screen, so copy it first.


big data ,tutorial ,ingesting data ,java sdk ,box.com

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}