// 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;
using TERASOLUNA.Fw.Client.Communication;
using TERASOLUNA.Fw.Common.BLogic;
using TERASOLUNA.Fw.Common.Logging;

namespace TERASOLUNA.Fw.Client.BLogic
{
    /// <summary>
    /// XMLデータの送信、ファイルの受信を行うビジネスロジッククラスです。
    /// </summary>
    /// <remarks>
    /// <see cref="BinaryFileDownloadCommunicator"/> を使用してサーバと通信を行います。
    /// </remarks>
    public class BinaryFileDownloadBLogic : CommunicateBLogicBase<DataSet>
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(BinaryFileDownloadBLogic));

        /// <summary>
        /// サーバから受信したダウンロードファイル名をイベントハンドラへ送信する際にキーとして利用する文字列です。
        /// </summary>
        /// <remarks><para>この定数の値は "ContentFileName" です。</para></remarks>
        public static readonly string CONTENT_FILENAME = "ContentFileName";

        /// <summary>
        /// ダウンロードしたファイルのパスを <see cref="BLogicResult.Items"/> に格納する時のキーです。
        /// </summary>
        /// <remarks><para>この定数の値は "DownloadFilePath" です。</para></remarks>
        public static readonly string DOWNLOAD_FILEPATH = "DownloadFilePath";

        /// <summary>
        /// 進行状況イベントハンドラへダウンロード通知を行う際にキーとして利用する文字列です。
        /// </summary>
        /// <remarks><para>この定数の値は "DownloadReady" です。</para></remarks>
        public static readonly string DOWNLOAD_READY = "DownloadReady";

        /// <summary>
        /// <see cref="BinaryFileDownloadBLogic"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// デフォルトコンストラクタです。
        /// </remarks>
        public BinaryFileDownloadBLogic()
        {
        }

        /// <summary>
        /// XMLデータの送信、ファイルの受信を行う <see cref="ICommunicator{DataSet}"/> を生成します。
        /// </summary>
        /// <remarks>
        /// 既定では <see cref="BinaryFileDownloadCommunicator"/> を生成します。
        /// </remarks>
        /// <returns>
        /// XMLデータの送信、ファイルの受信を行う <see cref="ICommunicator{DataSet}"/>。
        /// </returns>
        protected override ICommunicator<DataSet> CreateCommunicator()
        {
            return new BinaryFileDownloadCommunicator();
        }

        /// <summary>
        /// XMLデータの送信、ファイルの受信を実行します。
        /// </summary>
        /// <remarks>
        /// <para>
        /// <see cref="BinaryFileDownloadCommunicator"/> の <see cref="BinaryFileDownloadCommunicator.Download"/> を実行します。
        /// <see cref="BinaryFileDownloadCommunicator.Download"/> では入力データの <paramref name="communicateBLogicParam"/> 
        /// をXMLに変換してサーバへ送信し、受信したファイルをローカルに保存します。ファイルがローカルに保存された場合は、
        /// <see cref="DownloadResult"/> の <see cref="DownloadResult.DownloadFilePath"/> にファイルパスが設定されます。
        /// ファイルがローカルに保存されなかった場合は、<see cref="DownloadResult.DownloadFilePath"/> は null 参照です。
        /// </para>
        /// <para>
        /// 通信クラスとして、既定では <see cref="BinaryFileDownloadCommunicator"/> を利用します。
        /// </para>
        /// </remarks>
        /// <param name="communicateBLogicParam">
        /// サーバアプリケーションへ送信する <see cref="BLogicParam"/>。
        /// </param>
        /// <param name="requestHeaders">
        /// リクエストのヘッダを構成する名前と値のペアを格納している <see cref="IDictionary{String, String}"/>。
        /// </param>
        /// <returns>
        /// 通信結果を格納した <see cref="DownloadResult"/>。
        /// </returns>
        /// <exception cref="ArgumentException">
        /// 通信処理で必要なデータが不正です。
        /// </exception>
        /// <exception cref="ServerException">
        /// サーバアプリケーションで想定しない例外が発生しました。
        /// </exception>
        /// <exception cref="CommunicationException">
        /// データの送受信中にエラーが発生しました。
        /// </exception>
        protected override CommunicationResult Communicate(BLogicParam communicateBLogicParam, 
                                                           IDictionary<string, string> requestHeaders)
        {
            if (_log.IsDebugEnabled)
            {
                _log.Debug(string.Format(
                    Properties.Resources.D_BEGIN_COMMUNICATOR_FUNCTION, Communicator.GetType().FullName));
            }

            DownloadResult result =
                ((BinaryFileDownloadCommunicator)Communicator).Download(communicateBLogicParam.ParamData, requestHeaders);

            if (_log.IsDebugEnabled)
            {
                _log.Debug(string.Format(
                    Properties.Resources.D_END_COMMUNICATOR_FUNCTION, Communicator.GetType().FullName));
            }

            return result;
        }

        /// <summary>
        /// 通信処理の後処理を行います。
        /// </summary>
        /// <remarks>
        /// <paramref name="communicationResult"/> が <see cref="DownloadResult"/> 型で
        /// <see cref="DownloadResult.DownloadFilePath"/> にダウンロードしたファイルのパスが設定されている場合は、
        /// <see cref="BLogicResult.Items"/> に <see cref="DOWNLOAD_FILEPATH"/> をキーとして
        /// ファイルパスの文字列を設定する。
        /// </remarks>
        /// <param name="blogicResult">ビジネスロジック結果を格納する <see cref="BLogicResult"/> インスタンス。</param>
        /// <param name="communicationResult">通信処理の結果を保持する <see cref="CommunicationResult"/> インスタンス。</param>
        protected override void AfterCommunicate(CommunicationResult communicationResult, BLogicResult blogicResult)
        {
            base.AfterCommunicate(communicationResult, blogicResult);

            DownloadResult downloadResult = communicationResult as DownloadResult;
            if (string.IsNullOrEmpty(downloadResult.DownloadFilePath))
            {
                return;
            }

            blogicResult.Items[DOWNLOAD_FILEPATH] = downloadResult.DownloadFilePath;
        }
    }
}
