// 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.Web;

namespace TERASOLUNA.Fw.Web.Controller
{
    /// <summary>
    /// 対象となるリクエストコントローラが解決できない場合に利用される
    /// リクエストコントローラクラスです。
    /// </summary>
    /// <remarks>
    /// 不正なリクエスト名で要求された、ビジネスロジック設定ファイルの設定が不正などの
    /// 理由により対象となるリクエストコントローラが解決できなかった場合に利用されます。
    /// </remarks>
    public class UnknownRequestController : BLogicRequestController
    {
        /// <summary>
        /// HTTP Web 要求を処理します。
        /// </summary>
        /// <param name="context">
        /// HTTP 要求を処理するために使用する、組み込みのサーバー オブジェクト ( Request 、 Response 、 Session 、 Server など)
        /// への参照を提供する <see cref="HttpContext"/> オブジェクト。
        /// </param>
        /// <remarks>
        /// <para><seealso cref="HttpContext.Items"/> の キー <seealso cref="RequestControllerConstants.KEY_CONTROLLER_FACTORY_ERR"/> 
        /// の設定値として格納されている例外情報を取得し、<seealso cref="BLogicRequestController.WriteSystemErrorResponse"/> 
        /// 利用して、システム例外のレスポンス情報を書き込みます。</para>
        /// <para><seealso cref="HttpContext.Items"/> に キー <seealso cref="RequestControllerConstants.KEY_CONTROLLER_FACTORY_ERR"/> が
        /// 格納されていない場合、または <see cref="Exception"/> 型以外が設定されている場合は処理を行いません。</para>
        /// </remarks>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:ValidateArgumentsOfPublicMethods")]
        public override void ProcessRequest(HttpContext context)
        {
            Exception ex = context.Items[RequestControllerConstants.KEY_CONTROLLER_FACTORY_ERR] as Exception;
            if (ex != null)
            {
                WriteSystemErrorResponse(context, ex);
            }
        }
    }
}
