NIFCLOUD Storage SDK/CLI for Java

提供日： 2012年01月17日
更新日： 2022年04月13日

1. 概要
　NIFCLOUD Storage CLIは、オブジェクトストレージサービスが提供する
Web APIを利用するための、コマンドラインインタフェースです。このCLIを利用
することにより、すぐにオブジェクトストレージサービスをご利用いただけ
ます。
　NIFCLOUD Storage SDK for Javaは、オブジェクトストレージサービスが
提供するWeb APIを利用するための、Java APIを提供するものです。
　このSDKを利用することにより、オブジェクトストレージサービスを利用する
アプリケーションを、より柔軟に作成することができます。


2. パッケージ内容
　NIFCLOUD Storage CLI/SDK for Javaは、以下を含んでおります。

　　● コマンドライン - このライブラリ(SDK for Java)を利用したコマンドライン
　　　　　　　　　　　　です。

　　● Java Library - オブジェクトストレージサービスが提供するWeb APIを
　　　　　　　　　　　利用するJavaアプリケーションを作成することができます。
　　　　　　　　　　　このライブラリが提供するAPIは、低レベルの通信、認証の
　　　　　　　　　　　リクエストへの追加、リクエストの再試行、ならびにエラー
　　　　　　　　　　　ハンドリングを隠ぺい化しています。

　　● Javadoc - Java Libraryの説明ドキュメントです。

　　● サンプルコード - このライブラリを利用したアプリケーションの作成方法
　　　　　　　　　　　　についてのサンプルです。


3. ファイル構成
　LICENSE.txt　　　　　　　 ライセンス情報です。
　NOTICE.txt　　　　　　　　追加情報です。
　credentials.properties　　認証キー等の設定ファイルです。
　ncs_cli.sh　　　　　　　　Linux用コマンドラインスクリプトです。
　cli/　　　　　　　　　　　コマンドラインインタフェースのライブラリおよび
　　　　　　　　　　　　　　ソースコードです。
　doc/　　　　　　　　　　　SDKのJavadocです。
　lib/　　　　　　　　　　　SDKのライブラリおよびソースコードです。
　samples/　　　　　　　　　サンプルコードです。
　third-party/　　　　　　　サードパーティ製のライブラリです。


4. ライセンス
　NIFCLOUD Storage CLI/SDK for Javaは、Apache License Version 2.0にて提供
いたします。
　LICENSE.txtをご覧ください。


5. 詳細
　より詳しい情報は、https://pfs.nifcloud.com/api/object-storage-service/ をご覧ください。

6. 利用方法
　コマンドラインの利用方法について記載します。
　コマンドラインのより詳しい情報は、cli/README をご覧ください。

　Java SE Development Kit 8（JDK8）以降のJava環境上に本パッケージを展開して下さい。
　パッケージ内のncs_cli.shシェルを実行し、コマンド詳細を確認して下さい。

　./ncs_cli.sh --help

　コマンド詳細が出力されない場合、クラスパス等の環境を再度確認して下さい。

　●バケット作成
　./ncs_cli.sh mb ncss://<bucket-name>

　●バケット削除
　./ncs_cli.sh rb ncss://<bucket-name>

　●オブジェクト一覧
　./ncs_cli.sh ls ncss://<bucket-name>

　●オブジェクト作成
　./ncs_cli.sh put <local-filename> ncss://<bucket-name>[/<object-name>]

　●オブジェクト取得
　./ncs_cli.sh get ncss://<bucket-name>/<object-name> <local-filename>

　●オブジェクト削除
　./ncs_cli.sh del ncss://<bucket-name>/<object-name>

　●マルチパートアップロードデータ破棄
　./ncs_cli.sh --upload-id=<upload-id> abort ncss://<bucket-name>/<object-name>

7. 注意事項
　●　このNIFCLOUD Storage CLI/SDK for Javaはオブジェクトストレージサービス専用です。
　　　オブジェクトストレージ(旧)ではご利用いただけません。
　　　オブジェクトストレージ(旧)用NIFCLOUD Storage CLI/SDK for Javaは以下のページをご覧ください。
　　　https://pfs.nifcloud.com/api/obj_storage/index_sdk.htm

　●　オブジェクトストレージ(旧)用NIFCLOUD Storage CLI/SDK for Javaから一部のメソッドの仕様が変更されています。
    主な変更点は以下の通りです。
    - com.nifty.cloud.ncs.service.StorageClient#putObjectにてInputStreamを引数にとるメソッドには、
      contentSHA256引数が追加されオブジェクトのボディのSHA256ハッシュ値を指定する必要があります。
    - com.nifty.cloud.ncs.service.acl.PolicyにはPrivateしか指定できません。

    詳細はSDKのJavadocをご覧ください。