Object Storage Service:Simple upload using OSS SDK for Java 1.0

Usage notes

• Examples in this topic use the public endpoint for the China (Hangzhou) region. To access OSS from other Alibaba Cloud services in the same region, use an internal endpoint. For supported regions and endpoints, see Regions and endpoints.

• Access credentials are read from environment variables. For configuration details, see Configure access credentials.

• To create an OSSClient instance using a custom domain or Security Token Service (STS), see Configuration examples for common scenarios.

Permissions

By default, an Alibaba Cloud account has full permissions. RAM users and RAM roles have no permissions by default. Grant the required permissions using RAM Policy or bucket policy.

Initialize the client

All examples in this topic share the same OSSClient initialization. Create the client once, then reuse it across upload calls.

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;

// Replace with your actual endpoint
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Replace with your actual region
String region = "cn-hangzhou";

// Read credentials from environment variables OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET
EnvironmentVariableCredentialsProvider credentialsProvider =
    CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);

OSS ossClient = OSSClientBuilder.create()
    .endpoint(endpoint)
    .credentialsProvider(credentialsProvider)
    .clientConfiguration(clientBuilderConfiguration)
    .region(region)
    .build();

Call ossClient.shutdown() when the client is no longer needed to release associated resources.

Streaming upload

Use streaming upload to upload data directly from an InputStream. The following table summarizes which input type maps to which data source:

import com.aliyun.oss.model.*;
import java.io.ByteArrayInputStream;

String bucketName = "examplebucket";
String objectName = "exampledir/exampleobject.txt";

try {
    String content = "Hello OSS, hello world";

    PutObjectRequest putObjectRequest = new PutObjectRequest(
        bucketName, objectName, new ByteArrayInputStream(content.getBytes()));

    // Optional: set storage class and ACL
    // ObjectMetadata metadata = new ObjectMetadata();
    // metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());
    // metadata.setObjectAcl(CannedAccessControlList.Private);
    // putObjectRequest.setMetadata(metadata);

    PutObjectResult result = ossClient.putObject(putObjectRequest);
} catch (OSSException oe) {
    System.out.println("Caught an OSSException, which means your request made it to OSS, "
            + "but was rejected with an error response for some reason.");
    System.out.println("Error Message: " + oe.getErrorMessage());
    System.out.println("Error Code: " + oe.getErrorCode());
    System.out.println("Request ID: " + oe.getRequestId());
    System.out.println("Host ID: " + oe.getHostId());
} catch (ClientException ce) {
    System.out.println("Caught an ClientException, which means the client encountered "
            + "a serious internal problem while trying to communicate with OSS, "
            + "such as not being able to access the network.");
    System.out.println("Error Message: " + ce.getMessage());
} finally {
    if (ossClient != null) {
        ossClient.shutdown();
    }
}

import com.aliyun.oss.model.*;
import java.io.ByteArrayInputStream;

String bucketName = "examplebucket";
String objectName = "exampledir/exampleobject.txt";

try {
    byte[] content = "Hello OSS, hello world".getBytes();

    PutObjectRequest putObjectRequest = new PutObjectRequest(
        bucketName, objectName, new ByteArrayInputStream(content));

    PutObjectResult result = ossClient.putObject(putObjectRequest);
} catch (OSSException oe) {
    System.out.println("Caught an OSSException, which means your request made it to OSS, "
            + "but was rejected with an error response for some reason.");
    System.out.println("Error Message: " + oe.getErrorMessage());
    System.out.println("Error Code: " + oe.getErrorCode());
    System.out.println("Request ID: " + oe.getRequestId());
    System.out.println("Host ID: " + oe.getHostId());
} catch (ClientException ce) {
    System.out.println("Caught an ClientException, which means the client encountered "
            + "a serious internal problem while trying to communicate with OSS, "
            + "such as not being able to access the network.");
    System.out.println("Error Message: " + ce.getMessage());
} finally {
    if (ossClient != null) {
        ossClient.shutdown();
    }
}

import com.aliyun.oss.model.*;
import java.io.InputStream;
import java.net.URL;

String bucketName = "examplebucket";
String objectName = "exampledir/exampleobject.txt";
String url = "https://www.aliyun.com/";

try {
    InputStream inputStream = new URL(url).openStream();

    PutObjectRequest putObjectRequest = new PutObjectRequest(
        bucketName, objectName, inputStream);

    PutObjectResult result = ossClient.putObject(putObjectRequest);
} catch (OSSException oe) {
    System.out.println("Caught an OSSException, which means your request made it to OSS, "
            + "but was rejected with an error response for some reason.");
    System.out.println("Error Message: " + oe.getErrorMessage());
    System.out.println("Error Code: " + oe.getErrorCode());
    System.out.println("Request ID: " + oe.getRequestId());
    System.out.println("Host ID: " + oe.getHostId());
} catch (ClientException ce) {
    System.out.println("Caught an ClientException, which means the client encountered "
            + "a serious internal problem while trying to communicate with OSS, "
            + "such as not being able to access the network.");
    System.out.println("Error Message: " + ce.getMessage());
} finally {
    if (ossClient != null) {
        ossClient.shutdown();
    }
}

import com.aliyun.oss.model.*;
import java.io.FileInputStream;
import java.io.InputStream;

String bucketName = "examplebucket";
String objectName = "exampledir/exampleobject.txt";
// Replace with the full path to your local file
String filePath = "D:\\localpath\\examplefile.txt";

try {
    InputStream inputStream = new FileInputStream(filePath);

    PutObjectRequest putObjectRequest = new PutObjectRequest(
        bucketName, objectName, inputStream);

    PutObjectResult result = ossClient.putObject(putObjectRequest);
} catch (OSSException oe) {
    System.out.println("Caught an OSSException, which means your request made it to OSS, "
            + "but was rejected with an error response for some reason.");
    System.out.println("Error Message: " + oe.getErrorMessage());
    System.out.println("Error Code: " + oe.getErrorCode());
    System.out.println("Request ID: " + oe.getRequestId());
    System.out.println("Host ID: " + oe.getHostId());
} catch (ClientException ce) {
    System.out.println("Caught an ClientException, which means the client encountered "
            + "a serious internal problem while trying to communicate with OSS, "
            + "such as not being able to access the network.");
    System.out.println("Error Message: " + ce.getMessage());
} finally {
    if (ossClient != null) {
        ossClient.shutdown();
    }
}

Upload a local file

Pass a File object directly to PutObjectRequest to upload a local file without opening an explicit stream:

import com.aliyun.oss.model.*;
import java.io.File;

String bucketName = "examplebucket";
String objectName = "exampledir/exampleobject.txt";
// Replace with the full path to your local file
String filePath = "D:\\localpath\\examplefile.txt";

try {
    PutObjectRequest putObjectRequest = new PutObjectRequest(
        bucketName, objectName, new File(filePath));

    // Optional: set storage class and ACL
    // ObjectMetadata metadata = new ObjectMetadata();
    // metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());
    // metadata.setObjectAcl(CannedAccessControlList.Private);
    // putObjectRequest.setMetadata(metadata);

    PutObjectResult result = ossClient.putObject(putObjectRequest);
} catch (OSSException oe) {
    System.out.println("Caught an OSSException, which means your request made it to OSS, "
            + "but was rejected with an error response for some reason.");
    System.out.println("Error Message: " + oe.getErrorMessage());
    System.out.println("Error Code: " + oe.getErrorCode());
    System.out.println("Request ID: " + oe.getRequestId());
    System.out.println("Host ID: " + oe.getHostId());
} catch (ClientException ce) {
    System.out.println("Caught an ClientException, which means the client encountered "
            + "a serious internal problem while trying to communicate with OSS, "
            + "such as not being able to access the network.");
    System.out.println("Error Message: " + ce.getMessage());
} finally {
    if (ossClient != null) {
        ossClient.shutdown();
    }
}

FAQ

• Share objects with signed URLs

• How do I restrict file types and size when uploading objects to OSS?

• How do I upload directories to and download directories from OSS?

References

• For the complete sample code, see GitHub.

• For the API reference, see PutObject.