[Servlet] 서블릿 주요 클래스

서블릿 클래스의 상속 관계

사용하는 패키지는 다음과 같다.

javax.servlet.*

javax.servlet.http.*

Servlet 인터페이스

반환형	메서드	설명
void	init(ServletConfig)	클라이언트에 의해 서블릿이 처음 실행될 때 웹  컨테이너에 의해 자동으로 실행된다.
void	service(ServletRequest, ServletResponse)	클라이언트에 의해 서블릿이 실행될 때 마다 실행된다.
void	destroy()	웹 서버가 종료될 때 웹 컨테이너에 의해 자동으로 실행된다.
void	getServletInfo()	서블릿의 기본 정보를 반환한다.
void	getServletConfig()	서블릿 초기화 객체를 반환한다.

ServletConfig 인터페이스

반환형	메서드	설명
String	getInitParameter(String)	서블릿이 실행되면서 초기화 매개 변수로 전달 받은 값을 얻는다. web.xml 의 <init-param>태그 내의 매개 변수를 말한다.
Enumeration	getInitParameterNames()	서블릿이 실행되면서 초기화 매개 변수로 전달 받은 변수 이름을 얻는다. web.xml 에 정의한 매개 변수 명을 모두 얻을 수 있다.
String	getServletName()	서블릿의 이름을 반환한다.
ServletContext	getServletContext()	서블릿이 실행되는 웹 컨테이너의 환경 관련 객체를 반환한다.

GenericServlet 클래스

반환형	메서드	설명
void	init()	ServletConfig 인터페이스 없이 사용하는 초기화 메서드이다. init(ServletConfig) 보다 주로 init()를 사용한다.
void	log(String)	에러를 서블릿 로그 파일에 남기는 메서드이다.
void	log(String, Throwable)	에러와 주어진 예외를 서블릿 러그 파일에 남기는 메서드이다.

HttpServlet 클래스

반환형	메서드	설명
long	lastModified(HttpServletRequest)	최종적으로 요청이 수정된 시간을 밀리초 단위로 반환. 1970년 1월 1일 0시 0분 0초를 기준으로 한다.
void	service(HttpServletRequest, HttpServletResponse)	HTTP 프로토콜을 지원하는 요청과 응답을 매개 변수로 가지는 service() 메서드이다.
void	doHead(HttpServletRequest, HttpServletResponse)	HTTP의 HEAD 요청에 대응하는 메서드이다.
void	doGet(HttpServletRequest, HttpServletResponse)	HTTP의 GET 요청에 대응하는 메서드이다.
void	doPost(HttpServletRequest, HttpServletResponse)	HTTP의 POST 요청에 대응하는 메서드이다.
void	doPut(HttpServletRequest, HttpServletResponse)	HTTP의 PUT 요청에 대응하는 메서드이다.
void	doDelete(HttpServletRequest, HttpServletResponse)	HTTP의 DELETE 요청에 대응하는 메서드이다.
void	doOptions(HttpServletRequest, HttpServletResponse)	HTTP의 OPTIONS 요청에 대응하는 메서드이다.
void	doTrace(HttpServletRequest, HttpServletResponse)	HTTP의 TRACE 요청에 대응하는 메서드이다.

ServletRequest 클래스

반환형	메서드	설명
Enumeration	getParameterNames()	현재 요청에 있는 매개 변수의 이름을 모두 얻어 열거형으로 반환한다.
Map	getParameterMap()	현재 요청에 있는 매개 변수의 값들을 얻어 Map 형태로 반환한다.
String	getParameter(String)	매개 변수의 값을 이름으로 얻는다.
String[]	getParameterValues(String)	매개 변수에 같은 이름으로 여러 값이 있을 때 값 모두를 얻어 배열로 반환한다.
Object	getAttribute(String)	현재 요청에 있는 속성과 값을 이름으로 얻는다.
void	setAttribute(String, Object)	현재 요청에 속성과 값을 추가한다.
void	removeAttribute(String)	현재 요청에서 속성과 값을 이름으로 제거한다.
Enumeration	getAttributeNames()	현재 요청에 있는 속성의 이름을 모두 얻어 열거형으로 반환한다.
ServletInput	getInputStream()	클라이언트와의 통신에서 1바이트 입력 스트림을 획득한다.
Reader	getReader()	클라이언트와의 통신에서 텍스트 입력 스트림을 획득한다.
String	getCharacterEncoding()	현재 요청에 설정된 문자 변환 방식을 반환한다.
void	setCharacterEncoding(String)	현재 요청에 원하는 문자 변환 방식을 설정한다.
RequestDispatcher	getRequestDispatcher(String)	RequestDispatcher 객체를 특정 경로와 연결하여 생성한다.
String	getLocaleAddr()	요청받는 서버의 IP 주소를 얻는다.
String	getLocaleHost()	요청받는 서버의 이름을 얻는다.
int	getLocalePort()	요청받는 서버가 클라이언트와 통신하기 위해 열어둔 포트번호를 얻는다.
String	getRemoteAddr()	요청하는 클라이언트의 IP 주소를 얻는다.
String	getRemoteHost()	요청하는 클라이언트의 이름을 얻는다.
int	getRemotePort()	요청하는 클라이언트가 서버와 통신하기 위해 열어둔 포트번호를 얻는다.
int	getContentLength()	현재 요청에 있는 내용부의 길이를 얻는다.
String	getContentType()	현재 요청에 있는 내용부의 MIME 형식을 얻는다.
Locale	getLocale()	클라이언트가 내용을 인식하기에 적절한 지역을 얻는다. 일반적으로 언어와 국가를 설정한다.
Enumeration	getLocales()	클라이언트가 내용을 인식하기에 적절한 지역 모두를 얻는다.
String	getProtocol()	현재 요청에 사용된 프로토콜을 얻는다.
String	getScheme()	현재 요청에 사용된 Scheme을 얻는다.
String	getServerName()	요정을 받는 서버의 이름을 얻는다.
int	getServerPort()	요청을 받는 서버의 포트를 얻는다.
boolean	isSecure()	현재 요청이 HTTPS 와 같은 보안 채널을 사용하는지 여부를 확인한다.

HttpServletRequest 클래스

반환형	메서드	설명
String	getHeader(String)	현재 요청에 있는 해더의 갑을 이름(Key)로 얻는다.
int	getIntHeader(String)	현재 요청에 있는 헤더의 값을 이름(Key)으로 얻어 정수형으로 반환한다.
long	getDateHeader(String)	현재 요청에 있는 헤더의 값을 이름(Key)으로 얻어 날짜로 반환한다.
Enumeration	getHeaders(String)	현재 요청에 있는 헤더의 값 여러 개를 같은 이름(Key)으로 얻어 열거형으로 반환한다.
Enumeration	getHeaderNames()	현재 요청에 있는 헤더의 이름을 모두 열거형으로 반환한다.
Cookie[]	getCookies()	요청을 하는 클라이언트에 있는 쿠키 모두를 배열로 반환한다.
HttpSession	getSesstion()	현재 요청에 있는 세션을 얻는다.
HttpSession	getSesstion(boolean)	현재 요청에 있는 세션을 얻는다. boolean 값에 따라 기존 세션을 반환하거나 새로 생성해서 반환한다.
String	getAuthType()	현재 요청에 사용된 사용자 인증 방식을 얻는다. 보안 관련 인증을 사용하지 않으면 Null을 반환한다.
String	getContextPath()	요청 URI에서 웹 프로그램의 이름을 얻는다. 프로젝트의 이름과 같다고 보면 된다.
String	getMethod()	현재 요청에 사용된 GET이나 POST 등과 같은 HTTP 요청 방식을 얻는다.
String	getPathInfo()	URL과 연관된 부가 정보를 획득하는 메서드이다. 부가 정보가 없으면 Null을 반환한다.
String	getPathTranslated()	getPathInfo() 와 동일한 값을 얻지만 가상머신의 실제 경로를 얻는다. 부가 정보가 없으면 Null을 반환한다.
String	getQueryString()	GET 방식으로 요청할 때 주소 표시줄에 표시되는 ? 이후의 질의(Query String)를 얻는다.
String	getRemoteUser()	인증을 받은 사용자가 요청을 한 경우 사용자의 이름을 획득한다. 만약 사용자 인증을 사용하지 않으면 Null을 반환한다.
String	getRequestedSessionId()	세션을 사용할 때 사용자를 구분하는 고유 ID를 얻는다. 세션이 없으면 Null을 반환한다.
String	getRequestURL()	URL 뒷부분에서 질의(Query String) 앞부분까지 얻는다.
StringBuffer	getRequestURL()	전체 URL 경로를 얻는다.
String	getServletPath()	서블릿의 실제 이름을 얻는다. web.xml 에 등록된 이름이 출력된다.
Principal	getUserPrincipal()	인증을 받은 사용자가 요청을 한 경우 사용자를 기준으로 Principal 객체를 획득한다. 사용자 인증을 사용하지 않으면 Null을 반환한다.
boolean	isRequestedSessionIdFromCookie()	쿠키에 의해 생성된 세션 ID인지 여부를 확인한다.
boolean	isRequestedSessionIdFromURL()	URL에 의해 생성된 세션 ID인지 여부를 확인한다.
boolean	isRequestedSessionIdValid()	현재 요청에 있는 세션 ID가 유효한지 여부를 확인한다.
boolean	isUserInRole(String)	특정 롤에 포함된 인증 사용자인지 여부를 확인한다.

ServletResponse 클래스

반환형	메서드	설명
int	getBufferSize()	현재 응답에 사용하는 버퍼의 크기를 얻는다.
void	setBufferSize(int)	응답에 사용하는 버퍼의 크기를 설정한다.
void	flushBuffer()	버퍼에 남아있는 내용을 강제로 클라이언트에 보낸다.
void	readerBuffer()	헤더와 상태에 대한 값은 유지하고 응답에 관련된 내용만 초기화한다.
void	reset()	응답과 관련된 정보 모두를 초기화한다. 헤더와 상태도 포함한다.
String	getCharacterEncoding()	현재 응답에 대해 문자 세트를 획득한다.
void	setCharacterEncoding(String)	현재 응답에 대해 문자 세트를 설정한다.
String	getContentType()	현재 응답에 대해 MIME 형식을 얻는다.
void	setContentType(String)	현재 응답에 대해 MIME 형식을 설정한다.
void	setContentLength(int)	현재 응답에 대해 내용부의 길이를 설정한다.
Locale	getLocale()	현재 응답에 대해 Locale을 얻는다.
void	setLocale(Locale)	현재 응답에 대해 지역을 설정한다. 단, 응답이 커밋된 다음에는 수정할 수 없다.
OutputStream	getOutputStream()	클라이언트와의 통신에서 1Byte 출력 스트림을 얻는다.
PrintWriter	getWriter()	클라이언트와의 통신에서 텍스트 출력 스트림을 얻는다.
boolean	isCommitted()	응답의 커밋 여부를 확인한다.

HttpServletResponse 클래스

반환형	메서드	설명
void	addCookie(Cookie)	쿠키를 클라이언트로 전송한다.
void	addDateHeader(String, long)	응답에 헤더를 추가한다. 날짜 타입의 헤더 정보를 이름(Key)과 long 형의 time 정수값의 쌍으로 추가한다.
void	addHeader(String, String)	응답에 헤더를 추가한다. 이름(Key)과 값(Value) 쌍으로 추가한다.
void	addIntHeader(String, int)	응답에 헤더를 추가한다. 숫자 타입의 헤더 정보를 이름(Key)과 int 형의 정수값의 쌍으로 추가한다.
boolean	containsHeader(String)	특정 헤더가 있는지 여부를 확인한다.
void	setDateHeader(String, long)	응답에 헤더를 설정한다. 날짜 타입의 헤더 정보를 름(Key)과 long 형의 time 정수값의 쌍으로 변경한다.
void	setHeader(String ,String)	응답에 헤더를 설정한다. 이름(Key)과 값(Value) 쌍으로 변경한다.
void	setIntHeader(tring, int)	응답에 헤더를 설정한다. 숫자 타입의 헤더 정보를 이름(Key)과 int 형의 정수값의 쌍으로 변경한다.
void	sendError(int)	특정 상태를 의미하는 코드로 에러 응답을 해준다.
void	sendError(int, String)	특정 상태를 의미하는 코드와 메시지로 에러 응답을 해준다.
void	setStatus(int)	현재 응답에 대해 특정 상태를 의미하는 코드를 설정한다.
void	sendRedirect(String)	지정한 URL로 이동하게 한다. 응답과 관련된 정보는 모두 초기화된다.
String	encodeURL(String)	URL 경로에 세션 ID가 포함된 경우에 해당 URL을 인코딩하기 위해 사용한다.
String	encodeRedirectURL(String)	sendRedirect() 의 매개 변수로 사용되는 URL의 인코딩이 필요할 때 사용하는 메서드이다. 일반적으로 세션 ID가 포함된 경우에 사용한다.