/***************************************************************************
 * Copyright (c) junmix 2009. All rights reserved.
 * Program Name    : GZIPResponseWrapper.java
 * Description     : GZIP用レスポンスラッパークラス
 * Version         : 1.00
 *
 * Change Record
 * ------------- ----- --------------- -------------------------------------
 *  Date          Ver.  Editor          Description
 * ------------- ----- --------------- -------------------------------------
 *  2009-xx-xx    1.00  junmix          新規作成
 *
 **************************************************************************/

package com.junmix.filter;

import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;

/**
 * <p>
 * [概 要] GZIP用レスポンスラッパークラス。
 * </p>
 * <p>
 * [詳 細] XXX。
 * </p>
 * <p>
 * [備 考]
 * </p>
 * <p>
 * [環 境] JDK 1.5.0_11
 * </p>
 * <p>
 * Copyright(c) junmix 2009
 * </p>
 * <p>
 * $Revision$
 * </p>
 * 
 * @author junmix
 * @since 1.00
 */
public class GZIPResponseWrapper extends HttpServletResponseWrapper implements GZIPFilterConst {
    /**
     * Servletがクライアントに返すレスポンス内容を含むHttpServletResponse。
     * 
     * @since 1.00
     */
    protected HttpServletResponse originalResponse = null;

    /**
     * 出力ストリーム。
     * 
     * @since 1.00
     */
    protected ServletOutputStream servletOutputStream = null;

    /**
     * 出力ストリームへのライター。
     * 
     * @since 1.00
     */
    protected PrintWriter writer = null;

    /**
     * <p>
     * [概 要] コンストラクタ。
     * </p>
     * <p>
     * [詳 細]
     * </p>
     * <p>
     * [備 考]
     * </p>
     * 
     * @param response
     *            Servletがクライアントに返すレスポンス内容を含むHttpServletResponse
     * @since 1.00
     */
    public GZIPResponseWrapper(HttpServletResponse response) {
        super(response);
        this.originalResponse = response;
    }

    /**
     * <p>
     * [概 要] ライター取得処理。
     * </p>
     * <p>
     * [詳 細] 出力ストリームへShift_JISで書き込むライターを返す。
     * </p>
     * <p>
     * [備 考]
     * </p>
     * 
     * @throws IOException
     *             入出力エラー発生時
     * @since 1.00
     */
    public PrintWriter getWriter() throws IOException {
        if (this.writer != null) {
            return this.writer;
        }
        if (this.servletOutputStream != null) {
            throw new IllegalStateException(EXCEPTION_MESSAGE_STREAM_ALREADY_OPENED);
        }
        this.servletOutputStream = this.createOutputStream();
        this.writer = new PrintWriter(new OutputStreamWriter(this.servletOutputStream, RESPONSE_CHARSET_NAME));
        return this.writer;
    }

    /**
     * <p>
     * [概 要] GZIP用ストリーム作成処理。
     * </p>
     * <p>
     * [詳 細] GZIP用の出力ストリームを返す。
     * </p>
     * <p>
     * [備 考]
     * </p>
     * 
     * @throws IOException
     *             入出力エラー発生時
     * @since 1.00
     */
    public ServletOutputStream createOutputStream() throws IOException {
        return new GZIPResponseStream(this.originalResponse);
    }

    /**
     * <p>
     * [概 要] 終了処理。
     * </p>
     * <p>
     * [詳 細] クローズ時に残りのバッファがある場合は、書き出してから終了する。
     * </p>
     * <p>
     * [備 考]
     * </p>
     * 
     * @since 1.00
     */
    public void finishResponse() {
        try {
            if (this.writer != null) {
                this.writer.close();
            } else {
                if (this.servletOutputStream != null) {
                    this.servletOutputStream.close();
                }
            }
        } catch (IOException ex) {
            ex.printStackTrace();
        }
    }

    /**
     * <p>
     * [概 要] ストリームのフラッシュ処理。
     * </p>
     * <p>
     * [詳 細] ストリームのフラッシュを行う。
     * </p>
     * <p>
     * [備 考]
     * </p>
     * 
     * @throws IOException
     *             入出力エラー発生時
     * @since 1.00
     */
    public void flushBuffer() throws IOException {
        this.servletOutputStream.flush();
    }

    /**
     * <p>
     * [概 要] 出力ストリーム取得処理。
     * </p>
     * <p>
     * [詳 細] GZip用の出力ストリームを返す。
     * </p>
     * <p>
     * [備 考]
     * </p>
     * 
     * @throws IOException
     *             入出力エラー発生時
     * @since 1.00
     */
    public ServletOutputStream getOutputStream() throws IOException {
        if (this.writer != null) {
            throw new IllegalStateException(EXCEPTION_MESSAGE_WRITER_ALREADY_OPENED);
        }
        if (this.servletOutputStream == null) {
            this.servletOutputStream = this.createOutputStream();
        }
        return this.servletOutputStream;
    }

    /**
     * <p>
     * [概 要] メッセージボディ部の出力長設定処理。
     * </p>
     * <p>
     * [詳 細] 何も行わない。
     * </p>
     * <p>
     * [備 考]
     * </p>
     * 
     * @param length
     *            メッセージボディ部の出力長
     * @since 1.00
     */
    public void setContentLength(int length) {
        // do nothing
    }
}