I will show you how to Upload PDF File To Server In Android Using Retrofit 2.
In this example, we will use retrofit multipart to upload PDF file to PHP-MySQL server.
A retrofit library will make the process of http call very smooth and less complex.
We will also get the URL of the uploaded PDF file and we will fire that URL to show that uploaded PDF.
If you want to use volley then read Volley upload PDF file in android.
Watch Video
Below video shows how this tutorial will work.
PHP files and codes
We need to code some PHP files to send the PDF file from android device to remote server.
So make a new php file and give it a name like config.php
<?php
$host="localhost";
$user="your username";
$password="your password";
$db = "your db name";
$con = mysqli_connect($host,$user,$password,$db);
// Check connection
if (mysqli_connect_errno())
{
echo "Failed to connect to MySQL: " . mysqli_connect_error();
}else{ //echo "Connect";
}
?>
After this, create another PHP file named uploadfile.php and add the below code
<?php
if($_SERVER['REQUEST_METHOD']=='POST'){
// echo $_SERVER["DOCUMENT_ROOT"]; // /home1/demonuts/public_html
//including the database connection file
include_once("config.php");
//$_FILES['image']['name'] give original name from parameter where 'image' == parametername eg. city.jpg
//$_FILES['image']['tmp_name'] temporary system generated name
$originalImgName= $_FILES['filename']['name'];
$tempName= $_FILES['filename']['tmp_name'];
$folder="uploadedFiles/";
$url = "https://www.demonuts.com/Demonuts/JsonTest/Tennis/uploadedFiles/".$originalImgName; //update path as per your directory structure
if(move_uploaded_file($tempName,$folder.$originalImgName)){
$query = "INSERT INTO upload_image_video (pathToFile) VALUES ('$url')";
if(mysqli_query($con,$query)){
$query= "SELECT * FROM upload_image_video WHERE pathToFile='$url'";
$result= mysqli_query($con, $query);
$emparray = array();
if(mysqli_num_rows($result) > 0){
while ($row = mysqli_fetch_assoc($result)) {
$emparray[] = $row;
}
echo json_encode(array( "status" => "true","message" => "Successfully file added!" , "data" => $emparray) );
}else{
echo json_encode(array( "status" => "false","message" => "Failed!") );
}
}else{
echo json_encode(array( "status" => "false","message" => "Failed!") );
}
//echo "moved to ".$url;
}else{
echo json_encode(array( "status" => "false","message" => "Failed!") );
}
}
?>
Above file is the main web service for us. We will make http calls to this file with PDF file as a parameter.
This file get the PDF file from android device and will upload it in to server.
Now make a new project in android studio and follow all the below steps.
Step 1. Basic Changes
In this step, we will make some basic but required changes.
In your AndroidManifest.xml file, add the below code lines
<uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
Internet permission will allow us to use the internet from android device.
While read and write permissions will allow us to read existing or write new files in external storage.
We will implement runtime permissions in MainActivity.java file.
Time to write the below lines in build.gradle(Module: app) file of your project.
implementation 'com.squareup.retrofit2:retrofit:2.5.0'
implementation 'com.squareup.retrofit2:converter-scalars:2.5.0'
implementation 'com.karumi:dexter:5.0.0'
First line will fetch the retrofit library classes. With these classes, we can make http calls seamlessly.
Second line (Scalar library) will help us to convert the JSON Response into the string format.
Finally, last line will integrate dexter library in our project. It will help us to ask for runtime permissions.
Step 2. A small Interface
We need one interface to use retrofit.
So make a new JAVA class and give it a name “PDFInterface.java”
PDFInterface.java should contain the following code lines
import okhttp3.MultipartBody;
import okhttp3.RequestBody;
import retrofit2.Call;
import retrofit2.http.Multipart;
import retrofit2.http.POST;
import retrofit2.http.Part;
public interface PDFInterface {
String IMAGEURL = "https://demonuts.com/Demonuts/JsonTest/Tennis/";
@Multipart
@POST("uploadfile.php")
Call<String> uploadImage(
@Part MultipartBody.Part file, @Part("filename") RequestBody name
);
}
First of all, it has one string variable called IMAGEURL. It contains the URL to the uploadfile.php file.
@Multipart annotation specifying that compiler should use multipart to send pdf file to server.
@POST means that an http call will be of type POST.
At last, uploadImage() has some parameter which is the data source for the PDF file.
Step 3. Main files code lines
In every new project of android studio, there should be two files. one is activity_main.xml and another is MainActivity.java
In your activity_main.xml file, write down the below code snippet
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical"
tools:context=".MainActivity">
<Button
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:id="@+id/btn"
android:layout_marginLeft="10dp"
android:layout_marginTop="10dp"
android:text="Select PDF"
/>
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginLeft="10dp"
android:layout_marginTop="10dp"
android:textColor="#000"
android:textSize="25sp"
android:text="Below is URL to PDF"/>
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:id="@+id/tv"
android:layout_marginLeft="10dp"
android:layout_marginTop="10dp"
android:textColor="#000"
android:textSize="25sp"
android:text="URL to PDF"/>
</LinearLayout>
This file has one button and two text views.
When the user will click the button, compiler will make the http call to the remote server.
One text view is static and it will not change it’s value.
Another text view will get the URL where our PDF file is uploaded. On the click event of this text view, we will open the PDF file from that URL.
Now in your MainActivity.java file, write down the below code structure.
import android.Manifest;
import android.content.ContentResolver;
import android.content.Context;
import android.content.Intent;
import android.database.Cursor;
import android.net.Uri;
import android.os.Environment;
import android.provider.MediaStore;
import android.provider.OpenableColumns;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.text.TextUtils;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
import android.widget.Toast;
import com.karumi.dexter.Dexter;
import com.karumi.dexter.MultiplePermissionsReport;
import com.karumi.dexter.PermissionToken;
import com.karumi.dexter.listener.DexterError;
import com.karumi.dexter.listener.PermissionRequest;
import com.karumi.dexter.listener.PermissionRequestErrorListener;
import com.karumi.dexter.listener.multi.MultiplePermissionsListener;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Calendar;
import java.util.List;
import okhttp3.MediaType;
import okhttp3.MultipartBody;
import okhttp3.RequestBody;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.scalars.ScalarsConverterFactory;
public class MainActivity extends AppCompatActivity {
private Button btn;
private TextView tv;
private String url = "https://www.google.com";
private static final int BUFFER_SIZE = 1024 * 2;
private static final String IMAGE_DIRECTORY = "/demonuts_upload_gallery";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
requestMultiplePermissions();
btn = findViewById(R.id.btn);
tv = findViewById(R.id.tv);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Intent intent = new Intent();
intent.setAction(Intent.ACTION_GET_CONTENT);
intent.setType("application/pdf");
startActivityForResult(intent,1);
}
});
tv.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Intent browserIntent = new Intent(Intent.ACTION_VIEW, Uri.parse(url));
startActivity(browserIntent);
}
});
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (resultCode == RESULT_OK) {
// Get the Uri of the selected file
Uri uri = data.getData();
String uriString = uri.toString();
File myFile = new File(uriString);
String path = getFilePathFromURI(MainActivity.this,uri);
Log.d("ioooo",path);
uploadPDF(path);
}
super.onActivityResult(requestCode, resultCode, data);
}
private void uploadPDF(String path){
String pdfname = String.valueOf(Calendar.getInstance().getTimeInMillis());
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(PDFInterface.IMAGEURL)
.addConverterFactory(ScalarsConverterFactory.create())
.build();
//Create a file object using file path
File file = new File(path);
// Parsing any Media type file
RequestBody requestBody = RequestBody.create(MediaType.parse("*/*"), file);
MultipartBody.Part fileToUpload = MultipartBody.Part.createFormData("filename", file.getName(), requestBody);
RequestBody filename = RequestBody.create(MediaType.parse("text/plain"), pdfname);
PDFInterface getResponse = retrofit.create(PDFInterface.class);
Call<String> call = getResponse.uploadImage(fileToUpload, filename);
Log.d("assss","asss");
call.enqueue(new Callback<String>() {
@Override
public void onResponse(Call<String> call, Response<String> response) {
Log.d("mullllll", response.body().toString());
try {
JSONObject jsonObject = new JSONObject(response.body().toString());
Toast.makeText(getApplicationContext(), jsonObject.getString("message"), Toast.LENGTH_SHORT).show();
jsonObject.toString().replace("\\\\","");
if (jsonObject.getString("status").equals("true")) {
JSONArray dataArray = jsonObject.getJSONArray("data");
for (int i = 0; i < dataArray.length(); i++) {
JSONObject dataobj = dataArray.getJSONObject(i);
url = dataobj.optString("pathToFile");
tv.setText(url);
}
}
} catch (JSONException e) {
e.printStackTrace();
}
}
@Override
public void onFailure(Call call, Throwable t) {
Log.d("gttt", call.toString());
}
});
}
public static String getFilePathFromURI(Context context, Uri contentUri) {
//copy file and send new file path
String fileName = getFileName(contentUri);
File wallpaperDirectory = new File(
Environment.getExternalStorageDirectory() + IMAGE_DIRECTORY);
// have the object build the directory structure, if needed.
if (!wallpaperDirectory.exists()) {
wallpaperDirectory.mkdirs();
}
if (!TextUtils.isEmpty(fileName)) {
File copyFile = new File(wallpaperDirectory + File.separator + fileName);
// create folder if not exists
copy(context, contentUri, copyFile);
return copyFile.getAbsolutePath();
}
return null;
}
public static String getFileName(Uri uri) {
if (uri == null) return null;
String fileName = null;
String path = uri.getPath();
int cut = path.lastIndexOf('/');
if (cut != -1) {
fileName = path.substring(cut + 1);
}
return fileName;
}
public static void copy(Context context, Uri srcUri, File dstFile) {
try {
InputStream inputStream = context.getContentResolver().openInputStream(srcUri);
if (inputStream == null) return;
OutputStream outputStream = new FileOutputStream(dstFile);
copystream(inputStream, outputStream);
inputStream.close();
outputStream.close();
} catch (IOException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
}
public static int copystream(InputStream input, OutputStream output) throws Exception, IOException {
byte[] buffer = new byte[BUFFER_SIZE];
BufferedInputStream in = new BufferedInputStream(input, BUFFER_SIZE);
BufferedOutputStream out = new BufferedOutputStream(output, BUFFER_SIZE);
int count = 0, n = 0;
try {
while ((n = in.read(buffer, 0, BUFFER_SIZE)) != -1) {
out.write(buffer, 0, n);
count += n;
}
out.flush();
} finally {
try {
out.close();
} catch (IOException e) {
Log.e(e.getMessage(), String.valueOf(e));
}
try {
in.close();
} catch (IOException e) {
Log.e(e.getMessage(), String.valueOf(e));
}
}
return count;
}
private void requestMultiplePermissions(){
Dexter.withActivity(this)
.withPermissions(
Manifest.permission.WRITE_EXTERNAL_STORAGE,
Manifest.permission.READ_EXTERNAL_STORAGE)
.withListener(new MultiplePermissionsListener() {
@Override
public void onPermissionsChecked(MultiplePermissionsReport report) {
// check if all permissions are granted
if (report.areAllPermissionsGranted()) {
Toast.makeText(getApplicationContext(), "All permissions are granted by user!", Toast.LENGTH_SHORT).show();
}
// check for permanent denial of any permission
if (report.isAnyPermissionPermanentlyDenied()) {
// show alert dialog navigating to Settings
}
}
@Override
public void onPermissionRationaleShouldBeShown(List<PermissionRequest> permissions, PermissionToken token) {
token.continuePermissionRequest();
}
}).
withErrorListener(new PermissionRequestErrorListener() {
@Override
public void onError(DexterError error) {
Toast.makeText(getApplicationContext(), "Some Error! ", Toast.LENGTH_SHORT).show();
}
})
.onSameThread()
.check();
}
}
Understanding of Main Lines
First of all, read the below lines
private Button btn;
private TextView tv;
private String url = "https://www.google.com";
private static final int BUFFER_SIZE = 1024 * 2;
private static final String IMAGE_DIRECTORY = "/demonuts_upload_gallery";
First and second lines will create the objects of Button and Text view classes respectively.
Third line is string variable with google url. We will insert the uploaded PDF url in this variable later.
Fourth one is the final integer variable and last one is the name of the folder.
Now in onCreate() method, compiler will call requestMultiplePermissions() method.
Code for requestMultiplePermissions() method is as below
private void requestMultiplePermissions(){
Dexter.withActivity(this)
.withPermissions(
Manifest.permission.WRITE_EXTERNAL_STORAGE,
Manifest.permission.READ_EXTERNAL_STORAGE)
.withListener(new MultiplePermissionsListener() {
@Override
public void onPermissionsChecked(MultiplePermissionsReport report) {
// check if all permissions are granted
if (report.areAllPermissionsGranted()) {
Toast.makeText(getApplicationContext(), "All permissions are granted by user!", Toast.LENGTH_SHORT).show();
}
// check for permanent denial of any permission
if (report.isAnyPermissionPermanentlyDenied()) {
// show alert dialog navigating to Settings
}
}
@Override
public void onPermissionRationaleShouldBeShown(List<PermissionRequest> permissions, PermissionToken token) {
token.continuePermissionRequest();
}
}).
withErrorListener(new PermissionRequestErrorListener() {
@Override
public void onError(DexterError error) {
Toast.makeText(getApplicationContext(), "Some Error! ", Toast.LENGTH_SHORT).show();
}
})
.onSameThread()
.check();
}
Above method will ask for the runtime permissions.
We are using dexter library in this method. You can use this function in any project. Just add the permissions in the starting of the function and you are done.
In onCreate() method, below is for text view click event
tv.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Intent browserIntent = new Intent(Intent.ACTION_VIEW, Uri.parse(url));
startActivity(browserIntent);
}
});
When the user clicks the text view, system will open the uploaded PDF file. You may have seen this in output video at the starting of the tutorial.
Now consider the below source snippet
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Intent intent = new Intent();
intent.setAction(Intent.ACTION_GET_CONTENT);
intent.setType("application/pdf");
startActivityForResult(intent,1);
}
});
When the user clicks the button, compiler will run above lines. It will simply open one intent which will led user to file manager from where, he can select the PDF file to upload.
When the user clicks on the PDF file, compiler will execute onActivityresult() method.
Source code for onActivityresult() method is as the below
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (resultCode == RESULT_OK) {
// Get the Uri of the selected file
Uri uri = data.getData();
String path = getFilePathFromURI(MainActivity.this,uri);
Log.d("ioooo",path);
uploadPDF(path);
}
super.onActivityResult(requestCode, resultCode, data);
}
Here, compiler will first get the URI from the data. Then it will use getFilePAthFromURI() method to get the path of the PDF file.
Once it gets the path, it will call the uploadPDF() method by adding path into the parameter of this method.
Following is the code block for uploadPDF() method
private void uploadPDF(String path){
String pdfname = String.valueOf(Calendar.getInstance().getTimeInMillis());
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(PDFInterface.IMAGEURL)
.addConverterFactory(ScalarsConverterFactory.create())
.build();
//Create a file object using file path
File file = new File(path);
// Parsing any Media type file
RequestBody requestBody = RequestBody.create(MediaType.parse("*/*"), file);
MultipartBody.Part fileToUpload = MultipartBody.Part.createFormData("filename", file.getName(), requestBody);
RequestBody filename = RequestBody.create(MediaType.parse("text/plain"), pdfname);
PDFInterface getResponse = retrofit.create(PDFInterface.class);
Call<String> call = getResponse.uploadImage(fileToUpload, filename);
Log.d("assss","asss");
call.enqueue(new Callback<String>() {
@Override
public void onResponse(Call<String> call, Response<String> response) {
Log.d("mullllll", response.body().toString());
try {
JSONObject jsonObject = new JSONObject(response.body().toString());
Toast.makeText(getApplicationContext(), jsonObject.getString("message"), Toast.LENGTH_SHORT).show();
jsonObject.toString().replace("\\\\","");
if (jsonObject.getString("status").equals("true")) {
JSONArray dataArray = jsonObject.getJSONArray("data");
for (int i = 0; i < dataArray.length(); i++) {
JSONObject dataobj = dataArray.getJSONObject(i);
url = dataobj.optString("pathToFile");
tv.setText(url);
}
}
} catch (JSONException e) {
e.printStackTrace();
}
}
@Override
public void onFailure(Call call, Throwable t) {
Log.d("gttt", call.toString());
}
});
}
First of all, compiler will get the current time in string format and will use it as the name of the pdf file.
Then it will create the object of Retrofit class and will make the http call.
When the compiler gets the JSON response from the server, it calls the onResponse() method.
Here, we will parse the JSON response and will get the URL where our PDF file is located on the server.
We will store this URL in string variable (url) and we are done.
Recommended Course
You can use the below course for learning an android development quickly.