Package com.helger.web.scope

Interface IRequestWebScope

All Superinterfaces:

com.helger.datetime.domain.IHasCreationDateTime, com.helger.commons.id.IHasID<String>, com.helger.scope.IRequestScope, IRequestWebScopeWithoutResponse, com.helger.scope.IScope, IWebScope

All Known Implementing Classes:

RequestWebScope, RequestWebScopeMultipart

public interface IRequestWebScope
extends IRequestWebScopeWithoutResponse

Interface for a single web request scope object that also offers access to the HTTP servlet response.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
default OutputStream	getOutputStream()
jakarta.servlet.http.HttpServletResponse	getResponse()

Methods inherited from interface com.helger.datetime.domain.IHasCreationDateTime

getCreationDate, getCreationTime, hasCreationDateTime, isCreatedAt

Methods inherited from interface com.helger.scope.IRequestScope

getSessionID

Methods inherited from interface com.helger.web.scope.IRequestWebScopeWithoutResponse

areCookiesEnabled, encodeRedirectURL, encodeRedirectURL, encodeURL, encodeURL, getAuthType, getBrowserInfo, getCharacterEncoding, getCharset, getContentLength, getContentType, getContextAndServletPath, getContextPath, getCookies, getFullContextAndServletPath, getFullContextPath, getFullServerPath, getHttpMethod, getHttpVersion, getLocalAddr, getLocalName, getLocalPort, getMethod, getPathInfo, getPathTranslated, getPathWithinServlet, getPathWithinServletContext, getProtocol, getQueryString, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequest, getRequestParamMap, getRequestURIDecoded, getRequestURIEncoded, getRequestURLDecoded, getRequestURLEncoded, getScheme, getServerName, getServerPort, getServletPath, getSession, getSessionID, getURIDecoded, getURIEncoded, getURLDecoded, getURLEncoded, getUserAgent, getUserPrincipal, headers, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isSecure, isUserInRole, params

Methods inherited from interface com.helger.scope.IScope

attrs, destroyScope, getAllScopeRenewalAwareAttributes, getID, initScope, isDestroyed, isInDestruction, isValid, runAtomic, runAtomic

Methods inherited from interface com.helger.web.scope.IWebScope

getCreationDateTime

Method Detail

getResponse

@Nonnull
jakarta.servlet.http.HttpServletResponse getResponse()

Returns:

The underlying HTTP servlet response object

getOutputStream

@Nonnull
default OutputStream getOutputStream()
                              throws IOException

Returns:

The OutputStream to write to the HTTP servlet response

Throws:

IOException - In case of an error