// 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="DataSetXmlCommunicator{TResult}"/> を使用してサーバと通信を行います。
    /// </remarks>
    /// <typeparam name="TResult">
    /// 受信XMLデータを <paramref name="TResult"/> 型の型付データセットに読み込みます。
    /// </typeparam>
    public class DataSetXmlCommunicateBLogic<TResult> : CommunicateBLogicBase<DataSet> 
        where TResult : DataSet, new()
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(DataSetXmlCommunicateBLogic<TResult>));

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

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

        /// <summary>
        /// XMLデータの送受信を実行します。
        /// </summary>
        /// <remarks>
        /// <para>
        /// <see cref="ICommunicator{DataSet}"/> の <see cref="ICommunicator{DataSet}.Communicate"/> を実行します。
        /// <see cref="ICommunicator{DataSet}.Communicate"/> では
        /// 入力データの <paramref name="paramData"/> をXMLに変換してサーバへ送信し、
        /// 受信データを <paramref name="TResult"/> 型の型付データセットに読み込みます。
        /// </para>
        /// <para>
        /// 通信クラスとして、既定では <see cref="DataSetXmlCommunicator{TResult}"/> を利用します。
        /// </para>
        /// </remarks>
        /// <param name="communicateBlogicParam">
        /// ビジネスロジックに入力されたパラメータ <see cref="BLogicParam"/>。
        /// </param>
        /// <param name="requestHeaders">
        /// リクエストのヘッダを構成する名前と値のペアを格納している <see cref="IDictionary{String, String}"/>。
        /// </param>
        /// <returns>
        /// 通信結果を格納した <see cref="CommunicationResult"/>。
        /// </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));
            }

            // 送信
            CommunicationResult communicationResult = 
                Communicator.Communicate(communicateBlogicParam.ParamData, requestHeaders);

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

            return communicationResult;
        }

    }

}
