Object Storage Service:初期化 (Android SDK)

OSSClient の初期化

OSSClient は、以下のいずれかの方法で作成できます。

OSSClient の設定

ClientConfiguration は、OSSClient の設定クラスです。このクラスを使用して、プロキシ、接続タイムアウト、最大接続数などのパラメータを設定できます。

以下のコードは、ClientConfiguration を使用して OSSClient パラメータを設定する方法を示しています。

// yourEndpoint をバケットが存在するリージョンのエンドポイントに設定します。たとえば、バケットが中国 (杭州) リージョンにある場合、エンドポイントを https://oss-cn-hangzhou.aliyuncs.com に設定します。
String endpoint = "yourEndpoint";
// STS サービスから取得した一時的な AccessKey ID と AccessKey Secret。
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";
// STS サービスから取得したセキュリティトークン。
String securityToken = "yourSecurityToken";
// region をバケットが存在するリージョンに設定します。たとえば、バケットが中国 (杭州) リージョンにある場合、region を cn-hangzhou に設定します。
String region = "yourRegion";

ClientConfiguration configuration = new ClientConfiguration();
// 最大同時リクエスト数を設定します。デフォルト値: 5。
// configuration.setMaxConcurrentRequest(3);
// ソケットレイヤーでのデータ転送のタイムアウト期間を設定します。デフォルト値: 60000。
// configuration.setSocketTimeout(50000);
// 接続を確立するためのタイムアウト期間を設定します。デフォルト値: 60000。
// configuration.setConnectionTimeout(50000);
// ログファイルのサイズを設定します。デフォルト値: 5 MB。
// configuration.setMaxLogSize(3 * 1024 * 1024);
// リクエスト失敗後の最大再試行回数を設定します。デフォルト値: 2。
// configuration.setMaxErrorRetry(3);
// リスト内の要素は CNAME 解析をスキップします。
// List<String> cnameExcludeList = new ArrayList<>();
// cnameExcludeList.add("cname");
// configuration.setCustomCnameExcludeList(cnameExcludeList);
// プロキシサーバーのホストアドレス。
// configuration.setProxyHost("yourProxyHost");
// プロキシサーバーのポート。
// configuration.setProxyPort(8080);
// ユーザーエージェント内の HTTP の User-Agent ヘッダー。
// configuration.setUserAgentMark("yourUserAgent");
// 巡回冗長検査 (CRC) を有効にするかどうかを指定します。デフォルト値: false。
// configuration.setCheckCRC64(true);
// HTTP リダイレクトを有効にするかどうかを指定します。デフォルト値: false。
// configuration.setFollowRedirectsEnable(true);
// カスタム OkHttpClient を設定します。
// OkHttpClient.Builder builder = new OkHttpClient.Builder();
// configuration.setOkHttpClient(builder.build());

OSSCredentialProvider credentialProvider = new OSSStsTokenCredentialProvider(accessKeyId, accessKeySecret, securityToken);
configuration.setSignVersion(SignVersion.V4);
// OSSClient インスタンスを作成します。
OSSClient oss = new OSSClient(getApplicationContext(), endpoint, credentialProvider, configuration);
oss.setRegion(region);

ロギングの有効化

モバイル端末環境は複雑です。OSS SDK は、一部のリージョンまたは特定の期間に正しく動作しない場合があります。開発者による問題の特定を支援するため、ロギング機能を有効にすると、OSS SDK はログ情報をローカルに記録します。ロギングを有効にするには、OSSClient を使用する前に初期化する必要があります。次のようにメソッドを呼び出します。

// ロギングのスタイル。
// OSSLog.enableLog() を呼び出すと、コンソールでログを表示できます。
// ログファイルを端末の内蔵SDカードの \OSSLog\logs.csv パスに書き込むことができます。これはデフォルトで無効になっています。
// ログには、OSS 操作のリクエストデータ、レスポンスデータ、例外情報が記録されます。
// たとえば、requestId とレスポンスヘッダー。
// 以下はログレコードのサンプルです。
// Android バージョン。
// android_version: 5.1  
// Android端末のモデル。
// mobile_model: XT1085
// ネットワーク状態。  
// network_state: connected
// ネットワーク接続タイプ。
// network_type: WIFI 
// 特定の操作に関する情報。
// [2017-09-05 16:54:52] - Encounter local exception: //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
// このメソッドを呼び出してロギングを有効にします。
OSSLog.enableLog();              

同期インターフェイスと非同期インターフェイス