Torch Object Storage
Torch Object Storage
Document
- Documentation
Torch Object StorageSDK ReferenceAndroidQuick Start (Android SDK)
Copy page
Download PDFAndroid
Quick Start (Android SDK)
Copy pageDownload PDFQuick Start (Android SDK)
This document describes how to perform common operations using the TOS Android SDK, such as creating buckets and uploading, downloading, or deleting objects, etc.
Prerequisites
General Client-Side Examples
The Android SDK currently provides only synchronous request interfaces. To initiate requests properly within an Android application, asynchronous encapsulation is required. The following code demonstrates a general example of asynchronous SDK usage.
import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.model.object.PutObjectBasicInput;
import com.volcengine.tos.model.object.PutObjectInput;
import com.volcengine.tos.model.object.PutObjectOutput;
import java.io.ByteArrayInputStream;
public class DisplayMessageActivity extends AppCompatActivity {
private TOSV2 tos;
String endpoint = "your endpoint";
String region = "your region";
String accessKey = "your access key";
String secretKey = "your secret key";
String securityToken = "your security token";
String bucketName = "your bucket name";
String objectKey = "your object key";
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_display_message);
tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey, securityToken);
Thread tosThread = new Thread(new Runnable() {
public void run() {
try {
String data = "1234567890abcdefghijklmnopqrstuvwxyz~!@#$%^&*()_+<>?,./ :'1234567890abcdefghijklmnopqrstuvwxyz~!@#$%^&*()_+<>?,./ :'";
ByteArrayInputStream stream = new ByteArrayInputStream(data.getBytes());
PutObjectBasicInput basicInput = new PutObjectBasicInput().setBucket(bucketName).setKey(objectKey);
PutObjectInput putObjectInput = new PutObjectInput().setPutObjectBasicInput(basicInput).setContent(stream);
PutObjectOutput output = tos.putObject(putObjectInput);
Log.i("putObject", "object's etag is " + output.getEtag());
Log.i("putObject", "object's crc64 is " + output.getHashCrc64ecma());
} catch (TosServerException e) {
Log.e("TosServerException", e.toString());
} catch (TosClientException e) {
Log.e("TosClientException", e.toString());
} catch (Throwable t) {
t.printStackTrace();
}
}
});
tosThread.start();
}
}
Create Bucket
A bucket is the globally unique namespace in TOS, functioning as a data container for storing object data. The following code demonstrates how to create a new bucket.
import android.os.Bundle;
import android.util.Log;
import androidx.appcompat.app.AppCompatActivity;
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosException;
import com.volcengine.tos.model.bucket.CreateBucketV2Input;
import com.volcengine.tos.model.bucket.CreateBucketV2Output;
public class CreateBucketExample extends AppCompatActivity {
protected void onCreate(Bundle savedInstanceState) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = "your access key";
String secretKey = "your secret key";
String securityToken = "your security token";
String bucketName = "your bucket name";
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_display_message);
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey, securityToken);
Thread tosThread = new Thread(new Runnable() {
public void run() {
try{
CreateBucketV2Input input = new CreateBucketV2Input().setBucket(bucketName);
CreateBucketV2Output output = tos.createBucket(input);
Log.i("bucket created: ", output.getLocation());
} catch (TosException e) {
e.printStackTrace();
}
}
});
tosThread.start();
}
}
Upload Object
After successfully creating a bucket, you can upload objects to it. The following section demonstrates how to upload an object to the newly created bucket.
import android.os.Bundle;
import android.util.Log;
import androidx.appcompat.app.AppCompatActivity;
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosException;
import com.volcengine.tos.model.object.PutObjectBasicInput;
import com.volcengine.tos.model.object.PutObjectInput;
import com.volcengine.tos.model.object.PutObjectOutput;
import java.io.ByteArrayInputStream;
public class PutObjectBasicExample extends AppCompatActivity {
protected void onCreate(Bundle savedInstanceState) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = "your access key";
String secretKey = "your secret key";
String securityToken = "your security token";
String bucketName = "your bucket name";
String objectKey = "your object key";
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_display_message);
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey, securityToken);
Thread tosThread = new Thread(new Runnable() {
public void run() {
try{
String data = "1234567890abcdefghijklmnopqrstuvwxyz~!@#$%^&*()_+<>?,./ :'1234567890abcdefghijklmnopqrstuvwxyz~!@#$%^&*()_+<>?,./ :'";
ByteArrayInputStream stream = new ByteArrayInputStream(data.getBytes());
PutObjectBasicInput basicInput = new PutObjectBasicInput().setBucket(bucketName).setKey(objectKey);
PutObjectInput putObjectInput = new PutObjectInput().setPutObjectBasicInput(basicInput).setContent(stream);
PutObjectOutput output = tos.putObject(putObjectInput);
Log.i("putObject", "succeed, object's etag is " + output.getEtag());
Log.i("putObject", "succeed, object's crc64 is " + output.getHashCrc64ecma());
} catch (TosException e) {
Log.e("putObject", "failed");
e.printStackTrace();
}
}
});
tosThread.start();
}
}
tip
- If you wish to upload an object to a specific folder (a logical concept in object storage), you can add to the object name a prefix of/A prefix at the end of the object name supports multi-level folders. For example, the object name folder1/folder2/objectName means that objectName will be uploaded to folder2, which is inside folder1.
- When uploading an object to a folder, the folder exists only as a logical concept within object storage; consequently, no actual folder is created on the object storage server.
- When downloading an object, you must use the full path with the appropriate prefix. For example, the object name to be provided during download should also be folder1/folder2/objectName.
- For additional examples of uploading objects, refer to Standard Upload.
Download Object
The following demonstrates how to download an existing object from a bucket.
import android.os.Bundle;
import android.util.Log;
import androidx.appcompat.app.AppCompatActivity;
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosException;
import com.volcengine.tos.model.object.GetObjectV2Input;
import com.volcengine.tos.model.object.GetObjectV2Output;
import java.io.FileOutputStream;
import java.io.IOException;
public class GetObjectBasicExample extends AppCompatActivity {
protected void onCreate(Bundle savedInstanceState) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = "your access key";
String secretKey = "your secret key";
String securityToken = "your security token";
String bucketName = "your bucket name";
String objectKey = "your object key";
String filePath = "your file path";
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_display_message);
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey, securityToken);
Thread tosThread = new Thread(new Runnable() {
public void run() {
try{
GetObjectV2Input input = new GetObjectV2Input().setBucket(bucketName).setKey(objectKey);
try(FileOutputStream fileOutputStream = new FileOutputStream(filePath);
GetObjectV2Output output = tos.getObject(input)) {
byte[] buffer = new byte[1024];
int length;
while ((length = output.getContent().read(buffer)) != -1) {
fileOutputStream.write(buffer, 0, length);
}
Log.i("getObject", "succeed, object's metadata is " + output.getGetObjectBasicOutput());
} catch (IOException e) {
Log.e("IOException", "write data to file failed");
e.printStackTrace();
}
} catch (TosException e) {
if (e.getStatusCode() == 404) {
Log.e("TosException", "the object you want to download is not found");
e.printStackTrace();
} else {
Log.e("TosException", "getObject failed");
e.printStackTrace();
}
}
}
});
tosThread.start();
}
}
tip
Enumerated Objects
The following demonstrates how to list uploaded objects from a bucket.
import android.os.Bundle;
import android.util.Log;
import androidx.appcompat.app.AppCompatActivity;
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosException;
import com.volcengine.tos.model.object.ListObjectsV2Input;
import com.volcengine.tos.model.object.ListObjectsV2Output;
import com.volcengine.tos.model.object.ListedObjectV2;
public class ListObjectBasicExample extends AppCompatActivity {
protected void onCreate(Bundle savedInstanceState) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = "your access key";
String secretKey = "your secret key";
String securityToken = "your security token";
String bucketName = "your bucket name";
int maxKeys = 10;
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_display_message);
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey, securityToken);
Thread tosThread = new Thread(new Runnable() {
public void run() {
try{
ListObjectsV2Input input = new ListObjectsV2Input()
.setBucket(bucketName).setMaxKeys(maxKeys);
ListObjectsV2Output output = tos.listObjects(input);
Log.i("listObjects", "listObjects succeed, is truncated? " + output.isTruncated() + "next marker is " + output.getNextMarker());
if (output.getContents() != null) {
for (int i = 0; i < output.getContents().size(); i++) {
ListedObjectV2 object = output.getContents().get(i);
Log.i("listObjects", "No." + (i+1) + " listed object is " + object);
}
}
// list by next marker
input = new ListObjectsV2Input().setBucket(bucketName).setMaxKeys(maxKeys).setMarker(output.getNextMarker());
output = tos.listObjects(input);
Log.i("listObjects", "listObjects succeed, is truncated? " + output.isTruncated() + "next marker is " + output.getNextMarker());
if (output.getContents() != null) {
for (int i = 0; i < output.getContents().size(); i++) {
ListedObjectV2 object = output.getContents().get(i);
Log.i("listObjects", "No." + (i+1) + " listed object is " + object);
}
}
} catch (TosException e) {
Log.e("TosException", "listObjects failed");
e.printStackTrace();
}
}
});
tosThread.start();
}
}
tip
Delete Object
The following demonstrates how to delete an existing object from a bucket.
import android.os.Bundle;
import android.util.Log;
import androidx.appcompat.app.AppCompatActivity;
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosException;
import com.volcengine.tos.model.object.DeleteObjectInput;
import com.volcengine.tos.model.object.DeleteObjectOutput;
public class DeleteObjectBasicExample extends AppCompatActivity {
protected void onCreate(Bundle savedInstanceState) {
String endpoint = "your endpoint";
String region = "your region";
String accessKey = "your access key";
String secretKey = "your secret key";
String securityToken = "your security token";
String bucketName = "your bucket name";
String objectKey = "your object key";
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_display_message);
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey, securityToken);
Thread tosThread = new Thread(new Runnable() {
public void run() {
try{
DeleteObjectInput input = new DeleteObjectInput().setBucket(bucketName).setKey(objectKey);
DeleteObjectOutput output = tos.deleteObject(input);
Log.i("deleteObject", "succeed, " + output);
} catch (TosException e) {
Log.e("TosException", "deleteObject failed");
e.printStackTrace();
}
}
});
tosThread.start();
}
}
tip
Last updated: 2025.09.25 14:23:26
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
