// Copyright (c) 2008, NTT DATA Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.Collections.Generic;
using System.Data;

namespace TERASOLUNA.Fw.Client.Communication
{
    /// <summary>
    /// XMLデータの送信、ファイルの受信を行う <see cref="CommunicatorBase{DataSet}"/> 派生クラスです。
    /// </summary>
    /// <remarks>
    /// <para>
    /// 入力データの <see cref="DataSet"/> をXMLに変換してサーバへ送信し、
    /// 受信したファイルをローカルに保存します。
    /// </para>
    /// <para>
    /// このクラスを利用してダウンロード処理を行う場合、
    /// <see cref="CommunicatorBase{DataSet}.Communicate"/> ではなく
    /// <see cref="BinaryFileDownloadCommunicator.Download"/> を使用します。
    /// </para>
    /// </remarks>
    public class BinaryFileDownloadCommunicator : CommunicatorBase<DataSet>
    {
        /// <summary>
        /// <see cref="BinaryFileDownloadCommunicator"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// デフォルトコンストラクタです。
        /// <para>
        /// <see cref="CommunicatorBase{DataSet}.Sender"/> に <see cref="DataSetXmlSender"/> を設定します。
        /// </para>
        /// <para>
        /// <see cref="CommunicatorBase{DataSet}.Receiver"/> に <see cref="BinaryFileReceiver"/> を設定します。
        /// </para>
        /// </remarks>
        public BinaryFileDownloadCommunicator()
        {
            Sender = new DataSetXmlSender();
            Receiver = new BinaryFileReceiver();
        }

        /// <summary>
        /// ダウンロード処理を行います。
        /// </summary>
        /// <remarks>
        /// ダウンロードしたファイルがローカルに保存された場合は、
        /// <see cref="DownloadResult"/> の <see cref="DownloadResult.DownloadFilePath"/> にファイルパスが設定されます。
        /// ファイルがローカルに保存されなかった場合は、<see cref="DownloadResult.DownloadFilePath"/> は null 参照です。
        /// </remarks>
        /// <param name="paramData">サーバアプリケーションへ送信する <see cref="DataSet"/>。</param>
        /// <param name="requestHeaders">送信時に HTTP ヘッダとして利用するヘッダ文字列のコレクション。</param>
        /// <returns>通信結果を格納した <see cref="DownloadResult"/>。</returns>
        /// <exception cref="ArgumentNullException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <paramref name="paramData"/> が <c>null</c> 参照です。
        /// </item>
        /// <item>
        /// <paramref name="requestHeaders"/> が <c>null</c> 参照です。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="ArgumentException">
        /// 通信処理で必要なデータが不正です。
        /// </exception>
        /// <exception cref="ServerException">
        /// サーバアプリケーションで想定しない例外が発生しました。
        /// </exception>
        /// <exception cref="System.Net.WebException">
        /// 通信エラーが発生しました。または、リクエストがキャンセルされました。
        /// </exception>
        /// <exception cref="CommunicationException">
        /// データの送受信中にエラーが発生しました。
        /// </exception>
        public virtual DownloadResult Download(DataSet paramData, IDictionary<string, string> requestHeaders)
        {
            CommunicationResult cResult = Communicate(paramData, requestHeaders);

            DownloadResult dResult = cResult as DownloadResult;
            if (dResult == null)
            {
                dResult = new DownloadResult(null);
                dResult.AddResponseHeaders(cResult.ResponseHeaders);
                dResult.ResultData = cResult.ResultData;
            }

            return dResult;
        }
    }
}
