Object Storage Service:初期化

OSSClientインスタンスの初期化

次のいずれかの方法を使用して、OSSClientインスタンスを作成できます。

OSSClient インスタンスの設定

ClientConfiguration は OSSClient の設定クラスです。 ClientConfigurationを使用して、プロキシサーバーのパラメーター、接続タイムアウト期間、最大接続数などのパラメーターを指定できます。 下表に、各パラメーターを説明します。

次のサンプルコードは、ClientConfigurationを使用してOSSClientインスタンスのパラメーターを指定する方法の例を示しています。

// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. 
String endpoint = "yourEndpoint";
// Specify the temporary AccessKey pair obtained from STS. 
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// Specify the security token obtained from STS. 
String securityToken = "yourSecurityToken";
// Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to cn-hangzhou.
String region = "yourRegion";

ClientConfiguration configuration = new ClientConfiguration();
// Specify the maximum number of concurrent requests. Default value: 5. 
// configuration.setMaxConcurrentRequest(3);
// Specify the timeout period for data transmission at the Socket layer. Default value: 60. Unit: seconds. 
// configuration.setSocketTimeout(50000);
// Specify the timeout period for establishing a connection. Default value: 60. Unit: seconds. 
// configuration.setConnectionTimeout(50000);
// Specify the maximum size of a log. Default value: 5. Unit: MB. 
// configuration.setMaxLogSize(3 * 1024 * 1024);
// Specify the maximum number of retries when a request error occurs. Default value: 2. 
// configuration.setMaxErrorRetry(3);
// Specify that CNAME resolution is skipped for the elements in the list. 
// List<String> cnameExcludeList = new ArrayList<>();
// cnameExcludeList.add("cname");
// configuration.setCustomCnameExcludeList(cnameExcludeList);
// Specify the host of the proxy server. 
// configuration.setProxyHost("yourProxyHost");
// Specify the port of the proxy server. 
// configuration.setProxyPort(8080);
// Specify the HTTP User-Agent header. 
// configuration.setUserAgentMark("yourUserAgent");
// Specify whether to enable CRC-64. Default value: false. 
// configuration.setCheckCRC64(true);
// Specify whether to enable HTTP redirection. Default value: false. 
// configuration.setFollowRedirectsEnable(true);
// Set okHttpClient. 
// OkHttpClient.Builder builder = new OkHttpClient.Builder();
// configuration.setOkHttpClient(builder.build());

OSSCredentialProvider credentialProvider = new OSSStsTokenCredentialProvider(accessKeyId, accessKeySecret, securityToken);
configuration.setSignVersion(SignVersion.V4);
// Create an OSSClient instance. 
OSSClient oss = new OSSClient(getApplicationContext(),endpoint, credentialProvider);
oss.setRegion(region);

ロギングを有効にする

モバイルデバイスは、様々な環境で使用される。 OSS SDK for Androidは、特定のリージョンまたは特定の期間に使用できない場合があります。 発生する可能性のある問題をトラブルシューティングするには、ログを有効にして、OSS SDK for Androidでローカルにログを記録できるようにします。 ロギングを有効にするには、まずOSSClientインスタンスを初期化する必要があります。 次のサンプルコードでは、ロギングを有効にする方法の例を示します。

// Specify the log style. 
// Call OSSLog.enableLog() to enable logging. After logging is enabled, you can view logs in the OSS console. 
// Write logs to the built-in SD card of the mobile phone in the following path: \OSSLog\logs.csv. By default, logs are not written to the path. 
// Logs record the request data, response data, and exception information of OSS operations. 
// Examples: the request ID and response headers. 
// The following lines provide examples of log fields: 
// The Android version. 
// android_version: 5.1  
// The Android mobile phone model. 
// mobile_model: XT1085
// The network status.   
// network_state: connected
// The type of the network connection. 
// network_type: Wi-Fi 
// The details of the operation. 
// [2017-09-05 16:54:52] - Encounter local execpiton: //java.lang.IllegalArgumentException: The bucket name is invalid. 
// A bucket name must: 
// 1) be comprised of lower-case characters, numbers or dash(-); 
// 2) start with lower case or numbers; 
// 3) be between 3-63 characters long. 
//------>end of log
// Call the following method to enable logging. 
OSSLog.enableLog();              

同期および非同期API呼び出し