/*
 * Copyright 2004-2006 the Seasar Foundation and the Others.
 *
 * 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.
 */
package org.seasar.framework.container;

import java.util.Map;

/**
 * S2コンテナ上で、 WEBコンテナなどのコンテキストを扱うためのインターフェースです。 {@link java.util.Map}インターフェースで、
 * コンテナに依存することなくコンテキストへのアクセスができます。
 * 
 * @author higa
 * @author goto(Javadoc)
 * @see InstanceDef
 */
public interface ExternalContext {

    /**
     * リクエストコンテキストを返します。
     * 
     * @return リクエストコンテキスト
     */
    Object getRequest();

    /**
     * リクエストコンテキストを設定します。
     * 
     * @param request
     *            リクエストコンテキスト
     */
    void setRequest(Object request);

    /**
     * レスポンスコンテキストを返します。
     * 
     * @return レスポンスコンテキスト
     */
    Object getResponse();

    /**
     * レスポンスコンテキストを設定します。
     * 
     * @param response
     *            レスポンスコンテキスト
     */
    void setResponse(Object response);

    /**
     * セッションコンテキストを返します。
     * 
     * @return セッションコンテキスト
     */
    Object getSession();

    /**
     * アプリケーションコンテキストを返します。
     * 
     * @return アプリケーションコンテキスト
     */
    Object getApplication();

    /**
     * アプリケーションコンテキストを設定します。
     * 
     * @param application
     *            アプリケーションコンテキスト
     */
    void setApplication(Object application);

    /**
     * アプリケーションコンテキストを{@link java.util.Map}インターフェースで提供します。
     * 
     * @return アプリケーションコンテキスト
     */
    Map getApplicationMap();

    /**
     * 初期化設定値を{@link java.util.Map}インターフェースで提供します。
     * 
     * @return 初期化設定値
     */
    Map getInitParameterMap();

    /**
     * セッションコンテキストを{@link java.util.Map}インターフェースで提供します。
     * 
     * @return セッションコンテキスト
     */
    Map getSessionMap();

    /**
     * リクエストクッキーを{@link java.util.Map}インターフェースで提供します。
     * 
     * @return リクエストクッキー
     */
    Map getRequestCookieMap();

    /**
     * キーに対する値を1つ持つリクエストヘッダーを{@link java.util.Map}インターフェースで提供します。
     * 
     * @return キーに対する値を1つ持つリクエストヘッダー
     */
    Map getRequestHeaderMap();

    /**
     * キーに対する値を複数持つリクエストヘッダーを{@link java.util.Map}インターフェースで提供します。
     * 
     * @return キーに対する値を複数持つリクエストヘッダー
     */
    Map getRequestHeaderValuesMap();

    /**
     * リクエストコンテキストを{@link java.util.Map}インターフェースで提供します。
     * 
     * @return リクエストコンテキスト
     */
    Map getRequestMap();

    /**
     * キーに対する値を1つ持つリクエストパラメータを{@link java.util.Map}インターフェースで提供します。
     * 
     * @return キーに対する値を1つ持つリクエストパラメータ
     */
    Map getRequestParameterMap();

    /**
     * キーに対する値を複数持つリクエストパラメータを{@link java.util.Map}インターフェースで提供します。
     * 
     * @return キーに対する値を複数持つリクエストパラメータ
     */
    Map getRequestParameterValuesMap();
}