net.waglewagle.servlet.http

Class HttpResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

net.waglewagle.servlet.http.HttpResponse

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class HttpResponse
extends javax.servlet.http.HttpServletResponseWrapper

HttpServletResponse를 감싸서 많이 사용하는 형태의 응답을 전송하는데 편리할 메쏘드를 가지고 있는 클래스.

Since:

2014. 4. 30.

Author:

강신원

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESULT_DATA_KEY

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Constructor and Description
HttpResponse(javax.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method and Description
static HttpResponse	getHttpResponse(javax.servlet.http.HttpServletResponse response) 주어진 HttpServletResponse Interface를 감싸는 HttpResponse 객체를 돌려 준다.
void	send(java.io.InputStream in) InputStream으로부터 읽을 내용을 클라이언트에게 전송한다.
void	sendAsCsv(java.lang.String[] headerArr, java.util.List list) List에 있는 요소 하나를 한 레코드로 한 CSV 형태의 정보로 클라이언트에게 전송한다.
void	sendAsCsv(java.lang.String[] headerArr, java.util.List list, java.lang.String filename) List에 있는 요소 하나를 한 레코드로 한 CSV 형태의 정보로 클라이언트에게 전송한다.
void	sendAsCsv(java.lang.String encoding, java.lang.String[] headerArr, java.util.List list) List에 있는 요소 하나를 한 레코드로 한 CSV 형태의 정보로 클라이언트에게 전송한다.
void	sendAsCsv(java.lang.String encoding, java.lang.String[] headerArr, java.util.List list, java.lang.String filename) List에 있는 요소 하나를 한 레코드로 한 CSV 형태의 정보로 클라이언트에게 전송한다.
void	sendAsJson(java.lang.Object resObj) 결과 객체를 기본 ContentType 형식의 JSON 문자열로 보낸다.
void	sendAsJson(java.lang.Object resObj, java.lang.String encoding) 결과 객체를 주어진 Encoding의 JSON 문자열로 보낸다.
void	sendAsText(java.lang.Object resObj) 결과 객체를 TEXT 문자열로 보낸다.
void	sendAsText(java.lang.Object resObj, java.lang.String encoding) 결과 객체를 기본 ContentType 형식의 TEXT 문자열로 보낸다.
void	sendAsWrappedJson(java.lang.Object resObj, java.lang.String openStr, java.lang.String closeStr) 결과 객체를 주어진 문자열로 앞뒤로 감싸진 JSON 문자열로 보낸다.
void	sendAsWrappedJson(java.lang.Object resObj, java.lang.String encoding, java.lang.String openStr, java.lang.String closeStr) 결과 객체를 주어진 Encoding의, 주어진 문자열로 감싸진 JSON 문자열로 보낸다.
void	sendForAttach(java.io.File file) 주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 저장 창을 띄울 것을 기대하고 보낸다.
void	sendForAttach(java.io.File file, java.lang.String filename) 주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 저장 창을 띄울 것을 기대하고 보낸다.
void	sendForAttach(java.io.File file, java.lang.String filename, java.lang.String contentType) 주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 저장 창을 띄울 것을 기대하고 보낸다.
void	sendForInline(java.io.File file) 주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 화면에 표시할 것을 기대하고 보낸다.
void	sendForInline(java.io.File file, java.lang.String filename) 주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 화면에 표시할 것을 기대하고 보낸다.
void	sendForInline(java.io.File file, java.lang.String filename, java.lang.String contentType) 주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 화면에 표시할 것을 기대하고 보낸다.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

Field Detail

RESULT_DATA_KEY

public static final java.lang.String RESULT_DATA_KEY

See Also:

Constant Field Values

Constructor Detail

HttpResponse

public HttpResponse(javax.servlet.http.HttpServletResponse response)

Method Detail

getHttpResponse

public static HttpResponse getHttpResponse(javax.servlet.http.HttpServletResponse response)

주어진 HttpServletResponse Interface를 감싸는 HttpResponse 객체를 돌려 준다. 만약 넘어온 HttpServletResponse가 HttpResponse 라면 Casting해서 돌려 주고, 그렇지 않으면 새로운 객체를 생성하여 돌려 준다.

Parameters:

response - HttpServletResponse 객체.

Returns:

HttpServletResponse를 감싸는 HttpResponse 객체.

sendAsText

public void sendAsText(java.lang.Object resObj)
                throws java.io.IOException

결과 객체를 TEXT 문자열로 보낸다.

Parameters:

resObj -

Throws:

java.io.IOException

sendAsText

public void sendAsText(java.lang.Object resObj,
                       java.lang.String encoding)
                throws java.io.IOException

결과 객체를 기본 ContentType 형식의 TEXT 문자열로 보낸다.

Parameters:

resObj -

encoding -

Throws:

java.io.IOException

sendAsJson

public void sendAsJson(java.lang.Object resObj)
                throws java.io.IOException

결과 객체를 기본 ContentType 형식의 JSON 문자열로 보낸다.

Parameters:

resObj -

Throws:

java.io.IOException

sendAsJson

public void sendAsJson(java.lang.Object resObj,
                       java.lang.String encoding)
                throws java.io.IOException

결과 객체를 주어진 Encoding의 JSON 문자열로 보낸다.

Parameters:

resObj -

encoding -

Throws:

java.io.IOException

sendAsWrappedJson

public void sendAsWrappedJson(java.lang.Object resObj,
                              java.lang.String openStr,
                              java.lang.String closeStr)
                       throws java.io.IOException

결과 객체를 주어진 문자열로 앞뒤로 감싸진 JSON 문자열로 보낸다.

Parameters:

resObj -

openStr - JSON을 감싸는 문자열 중 앞 문자열.

closeStr - JSON을 감싸는 문자열 중 뒤 문자열.

Throws:

java.io.IOException

sendAsWrappedJson

public void sendAsWrappedJson(java.lang.Object resObj,
                              java.lang.String encoding,
                              java.lang.String openStr,
                              java.lang.String closeStr)
                       throws java.io.IOException

결과 객체를 주어진 Encoding의, 주어진 문자열로 감싸진 JSON 문자열로 보낸다.

Parameters:

resObj -

encoding -

openStr - JSON을 감싸는 문자열 중 앞 문자열.

closeStr - JSON을 감싸는 문자열 중 뒤 문자열.

Throws:

java.io.IOException

sendAsCsv

public void sendAsCsv(java.lang.String[] headerArr,
                      java.util.List list)
               throws java.io.IOException

List에 있는 요소 하나를 한 레코드로 한 CSV 형태의 정보로 클라이언트에게 전송한다. List의 요소는 Map이나 배열이어야 한다. 이때 정보는 기본 인코딩값(EUC-KR)으로 인코딩 되어 전송된다.

Parameters:

headerArr - CSV 헤더 배열. List의 요소를 보내기 전에 이 값을 일단 보내며, List의 요소가 Map일 경우 Map으로부터 값을 얻는 Key로 사용된다. 단, 형식이 "{id}[|{항목명}]"의 형태로 {항목명}이 있을 경우 ID 대신 클라이언트에게 보내는 헤더 값으로 이 {항목명}이 사용된다.

list - 클라이언트로 CSV 형태로 전송할 데이타를 가지고 있는 List 객체.

Throws:

java.io.IOException

sendAsCsv

public void sendAsCsv(java.lang.String[] headerArr,
                      java.util.List list,
                      java.lang.String filename)
               throws java.io.IOException

List에 있는 요소 하나를 한 레코드로 한 CSV 형태의 정보로 클라이언트에게 전송한다. List의 요소는 Map이나 배열이어야 한다. 이때 정보는 기본 인코딩값(EUC-KR)으로 인코딩 되어 전송된다.

Parameters:

headerArr - CSV 헤더 배열. List의 요소를 보내기 전에 이 값을 일단 보내며, List의 요소가 Map일 경우 Map으로부터 값을 얻는 Key로 사용된다. 단, 형식이 "{id}[|{항목명}]"의 형태로 {항목명}이 있을 경우 ID 대신 클라이언트에게 보내는 헤더 값으로 이 {항목명}이 사용된다.

list - 클라이언트로 CSV 형태로 전송할 데이타를 가지고 있는 List 객체.

filename - 브라우저 쪽 저장 창에 기본으로 보일 파일명.

Throws:

java.io.IOException

sendAsCsv

public void sendAsCsv(java.lang.String encoding,
                      java.lang.String[] headerArr,
                      java.util.List list)
               throws java.io.IOException

List에 있는 요소 하나를 한 레코드로 한 CSV 형태의 정보로 클라이언트에게 전송한다. List의 요소는 Map이나 배열이어야 한다. 이때 정보는 주어진 인코딩값으로 인코딩 되어 전송된다.

Parameters:

encoding - 전송할 데이타를 인코딩할 인코딩이름.

headerArr - CSV 헤더 배열. List의 요소를 보내기 전에 이 값을 일단 보내며, List의 요소가 Map일 경우 Map으로부터 값을 얻는 Key로 사용된다. 단, 형식이 "{id}[|{항목명}]"의 형태로 {항목명}이 있을 경우 ID 대신 클라이언트에게 보내는 헤더 값으로 이 {항목명}이 사용된다.

list - 클라이언트로 CSV 형태로 전송할 데이타를 가지고 있는 List 객체.

Throws:

java.io.IOException

sendAsCsv

public void sendAsCsv(java.lang.String encoding,
                      java.lang.String[] headerArr,
                      java.util.List list,
                      java.lang.String filename)
               throws java.io.IOException

List에 있는 요소 하나를 한 레코드로 한 CSV 형태의 정보로 클라이언트에게 전송한다. List의 요소는 Map이나 배열이어야 한다. 이때 정보는 주어진 인코딩값으로 인코딩 되어 전송되며, 클라이언트가 브라우저일 경우 저장 창이 뜨도록 파일명을 첨부하여 보낸다.

Parameters:

encoding - 전송할 데이타를 인코딩할 인코딩이름.

headerArr - CSV 헤더 배열. List의 요소를 보내기 전에 이 값을 일단 보내며, List의 요소가 Map일 경우 Map으로부터 값을 얻는 Key로 사용된다. 단, 형식이 "{id}[|{항목명}]"의 형태로 {항목명}이 있을 경우 ID 대신 클라이언트에게 보내는 헤더 값으로 이 {항목명}이 사용된다.

list - 클라이언트로 CSV 형태로 전송할 데이타를 가지고 있는 List 객체.

filename - 클라이언트가 브라우저일 경우 저장창에서 기본값으로 사용될 파일명.

Throws:

java.io.IOException

sendForAttach

public void sendForAttach(java.io.File file)
                   throws java.io.IOException

주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 저장 창을 띄울 것을 기대하고 보낸다.

Parameters:

file - 내용을 전송할 File 객체.

Throws:

java.io.IOException

sendForAttach

public void sendForAttach(java.io.File file,
                          java.lang.String filename)
                   throws java.io.IOException

주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 저장 창을 띄울 것을 기대하고 보낸다. 이 때, 같이 보내는 파일명(filename 파라미터)는 저장 창이 떴을 때 기본 파일명으로 사용된다.

Parameters:

file - 내용을 전송할 File 객체.

filename - 파일명.

Throws:

java.io.IOException

sendForAttach

public void sendForAttach(java.io.File file,
                          java.lang.String filename,
                          java.lang.String contentType)
                   throws java.io.IOException

주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 저장 창을 띄울 것을 기대하고 보낸다. 이 때, 같이 보내는 파일명(filename 파라미터)는 저장 창이 떴을 때 기본 파일명으로 사용된다.

Parameters:

file - 내용을 전송할 File 객체.

filename - 파일명.

contentType - Content-Type 헤더에 사용될 값.

Throws:

java.io.IOException

sendForInline

public void sendForInline(java.io.File file)
                   throws java.io.IOException

주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 화면에 표시할 것을 기대하고 보낸다. 단, 클라이언트(브라우저)가 화면에 표시할 수 없을 때는 저장 창을 띄울 수 있다.

Parameters:

file - 내용을 전송할 File 객체.

Throws:

java.io.IOException

sendForInline

public void sendForInline(java.io.File file,
                          java.lang.String filename)
                   throws java.io.IOException

주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 화면에 표시할 것을 기대하고 보낸다. 단, 클라이언트(브라우저)가 화면에 표시할 수 없을 때는 저장 창을 띄울 수 있다. 이 때, 같이 보내는 파일명(filename 파라미터)이 기본 파일명으로 사용된다.

Parameters:

file - 내용을 전송할 File 객체.

filename - 파일명.

Throws:

java.io.IOException

sendForInline

public void sendForInline(java.io.File file,
                          java.lang.String filename,
                          java.lang.String contentType)
                   throws java.io.IOException

주어진 File의 내용을 요청한 클라이언트(브라우저)에게 보내되, 클라이언트(브라우저)가 화면에 표시할 것을 기대하고 보낸다. 단, 클라이언트(브라우저)가 화면에 표시할 수 없을 때는 저장 창을 띄울 수 있다. 이 때, 같이 보내는 파일명(filename 파라미터)이 기본 파일명으로 사용된다.

Parameters:

file - 내용을 전송할 File 객체.

filename - 파일명.

contentType - Content-Type 헤더에 사용될 값.

Throws:

java.io.IOException

send

public void send(java.io.InputStream in)
          throws java.io.IOException

InputStream으로부터 읽을 내용을 클라이언트에게 전송한다.

Parameters:

in - 내용을 읽을 InputStream.

Throws:

java.io.IOException