WebContext (SIRIUS web 19.0-rc8 API)

java.lang.Object
- sirius.web.http.WebContext

All Implemented Interfaces:

sirius.kernel.async.SubContext
```
public class WebContext
extends Object
implements sirius.kernel.async.SubContext
```
Provides access to a request received by the WebServer.
This can be used to obtain all infos received for a HTTP request and also to create an appropriate response.
This context can either be passed along as variable or be accessed using CallContext.get(Class)

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`addP3PHeader`
`protected long`	`committed`
`protected sirius.kernel.commons.Callback<sirius.kernel.async.CallContext>`	`completionCallback`
`protected Attribute`	`content`
`protected ContentHandler`	`contentHandler`
`protected static String`	`contentSecurityPolicy`
`protected Map<String,Cookie>`	`cookiesOut`
`protected static boolean`	`corsAllowAll`
`protected static boolean`	`forceHSTS`
`protected boolean`	`hidePost`
`protected static int`	`hstsMaxAge`
`static String`	`HTTP_DATE_FORMAT` Date format used by HTTP date headers
`protected String`	`microtimingKey`
`protected InterfaceHttpPostRequestDecoder`	`postDecoder`
`protected HttpRequest`	`request`
`protected boolean`	`responseCommitted`
`protected boolean`	`responseCompleted`
`protected Boolean`	`ssl`
`protected long`	`started`
`protected UserAgent`	`userAgent`

Constructor Summary

Constructors
Constructor and Description

WebContext()

Constructors
Constructor and Description
`WebContext()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addFileToCleanup(File file)` Adds a file to the cleanup list.
`void`	`cacheUserMessages()` Caches user messages to show them with the next request.
`void`	`clearCachedUserMessages()` Clears all previously cached user messages
`void`	`clearSession()` Clears (invalidated) the client session by removing all values.
`static UserMessageCache`	`createDistributedReadOnceCache(String name)` Creates a distributed `UserMessageCache` if a `DistributedUserMessageCacheFactory` is implemented and can be injected.
`void`	`deleteCookie(String name)` Removes the given cookie from the cookies sent back to the client.
`void`	`detach()`
`static InetAddress`	`determineRemoteIP(ChannelHandlerContext ctx, HttpRequest request)` Tries to determine the effective remote IP for the given context and request.
`WebContext`	`enableTiming(String key)` Enables microtiming for this request.
`boolean`	`ensureSafePOST()` Determines if the current request is a POST request with checking for a valid CSRF-token.
`sirius.kernel.async.SubContext`	`fork()`
`long`	`generateLocalId()` Generates an ID (numeric value) which is unique withing this HTTP request.
`sirius.kernel.commons.Value`	`get(String key)` Returns a value or parameter supplied by the request.
`String`	`getBaseURL()` Returns the base url (the protocol + host) for which this request was made.
`InputStream`	`getContent()` Provides the body of the request as stream.
`File`	`getContentAsCopy()` Returns the content of the HTTP request as file on disk.
`File`	`getContentAsFile()` Returns the content of the HTTP request as file on disk.
`Charset`	`getContentCharset()` Returns the charset of the body of the request
`long`	`getContentSize()` Returns the size in bytes of the body of the request.
`Cookie`	`getCookie(String name)` Returns a cookie with the given name, sent by the client
`Collection<Cookie>`	`getCookies()` Returns all cookies submitted by the client
`String`	`getCookieValue(String name)` Returns the data of the given client cookie wrapped as `Value`
`ChannelHandlerContext`	`getCtx()` Provides access to the underlying ChannelHandlerContext
`long`	`getDateHeader(CharSequence header)` Returns the value of a date header as UNIX timestamp in milliseconds.
`String`	`getDynamicAssetToken()` Returns a token which can be added to dynamic asset-URLS (/asset/dynamic/TOKEN/...) to force a reload of the specified resource.
`FileUpload`	`getFileData(String key)` Returns the file upload supplied for the given key.
`sirius.kernel.commons.Value`	`getFirstFilled(String... keys)` Returns the first non empty value for the given keys.
`String`	`getHeader(CharSequence header)` Returns the request header with the given name
`sirius.kernel.commons.Value`	`getHeaderValue(CharSequence header)` Returns the request header wrapped as `Value`
`HttpData`	`getHttpData(String key)` Returns the posted part with the given key.
`com.alibaba.fastjson.JSONObject`	`getJSONContent()` Returns the body of the HTTP request as JSON data.
`String`	`getLang()` Returns the accepted language of the client as two-letter language code.
`protected Collection<Cookie>`	`getOutCookies()` Returns all cookies to be sent to the client.
`String`	`getParameter(String key)` Returns the query string or POST parameter with the given name.
`Collection<String>`	`getParameterNames()` Returns a collection of all parameters names.
`List<String>`	`getParameters(String key)` Returns all query string or POST parameters with the given name.
`InterfaceHttpPostRequestDecoder`	`getPostDecoder()` Returns the post decoder used to decode the posted data.
`String`	`getQueryString()` Returns the original query string sent by the client.
`String`	`getRawRequestedURI()` Returns the raw undecoded requested URI of the underlying HTTP request, without the query string
`InetAddress`	`getRemoteIP()` Returns the remote address which sent the request
`HttpRequest`	`getRequest()` Provides access to the underlying netty HttpRequest
`String`	`getRequestedURI()` Returns the decoded requested URI of the underlying HTTP request, without the query string
`String`	`getRequestedURL()` Returns the complete URL as requested by the browser.
`Charset`	`getRequestEncoding()` Tries to determine the charset used for the INCOMING request.
`List<String>`	`getSessionKeys()` Returns a list of all known session keys for the current session
`sirius.kernel.commons.Value`	`getSessionValue(String key)` Loads a value from the client session
`UserAgent`	`getUserAgent()` Returns `UserAgent` for easy access to the user agent used for this request.
`sirius.kernel.xml.StructuredInput`	`getXMLContent()` Returns the body of the HTTP request as XML data.
`boolean`	`hasContent()` Determines if a content is available for this request.
`boolean`	`hasParameter(String key)` Determines if the parameter with the given name is contained in the request.
`void`	`hidePost()` Hide the fact that this request is a POST request.
`boolean`	`isContentProbablyXML()` Determines if the content body might contain XML (rather than JSON).
`static boolean`	`isCurrentRequestSSL()` Determines if the current request is secured by SSL.
`boolean`	`isLongCall()` Determines if this request was marked as long call.
`boolean`	`isPOST()` Deprecated. use `isUnsafePOST()` and `isSafePOST()` instead
`boolean`	`isResponseCommitted()` Determines if a response was already committed.
`boolean`	`isSafePOST()` Determines if the current request is a POST request with checking for a valid CSRF-token.
`boolean`	`isSSL()` Determines if this is an HTTPS (SSL protected) call.
`boolean`	`isTrusted()` Determines if the request is from a trusted IP.
`boolean`	`isUnsafePOST()` Determines if the current request is a POST request without checking for a valid CSRF-token.
`boolean`	`isValid()` Determines if this context is attached to a request or not.
`void`	`markAsLongCall()` Marks the request as long call.
`void`	`onComplete(sirius.kernel.commons.Callback<sirius.kernel.async.CallContext> onComplete)` Used to provide a handle which is invoked once the call is completely handled.
`sirius.kernel.commons.Value`	`require(String... keys)` Returns the value provided for the given key(s) or reports an error if no non empty value was found.
`Response`	`respondWith()` Creates a response for this request.
`void`	`restoreCachedMessages()` Invoked by `UserContext.getMessages()` to fetch and apply all previously cached message.
`void`	`setAttribute(String key, Object value)` Sets an attribute for the current request.
`void`	`setClientCookie(String name, String value, long maxAgeSeconds)` Sets a cookie value to be sent back to the client.
`void`	`setContentCharset(Charset charset)` Sets the charset of the body of the request.
`void`	`setContentHandler(ContentHandler handler)` Can be set from within `WebDispatcher.preparePreDispatch(WebContext)` to manually handle incoming content.
`void`	`setCookie(Cookie cookie)` Sets the given cookie to be sent back to the client
`void`	`setCookie(String name, String value, long maxAgeSeconds)` Sets a http only cookie value to be sent back to the client.
`protected void`	`setCtx(ChannelHandlerContext ctx)` Sets the ChannelHandlerContext for this context.
`void`	`setCustomSessionCookieTTL(Duration customSessionCookieTTL)` Sets an explicit session cookie TTL (time to live).
`void`	`setHTTPSessionCookie(String name, String value)` Sets a http only cookie value to be sent back to the client.
`protected void`	`setRequest(HttpRequest request)` Sets the underlying HttpRequest
`void`	`setSessionCookie(String name, String value)` Sets a cookie value to be sent back to the client The generated cookie will be a session cookie and varnish once the user agent is closed
`void`	`setSessionValue(String key, Object value)` Stores a value in the client session.
`String`	`toString()`
`sirius.kernel.commons.Tuple<String,String>`	`tryBasicAuthentication(String realm)` Tries to perform a HTTP Basic authentication by parsing the `Authorization` header.
`WebContext`	`withCustomPath(String path)` Overwrites the path with the given one.
`WebContext`	`withCustomURI(String uri)` Overwrites the uri with the given one.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - request
```
protected HttpRequest request
```
  - cookiesOut
```
protected Map<String,Cookie> cookiesOut
```
  - postDecoder
```
protected InterfaceHttpPostRequestDecoder postDecoder
```
  - hidePost
```
protected boolean hidePost
```
  - content
```
protected Attribute content
```
  - microtimingKey
```
protected String microtimingKey
```
  - responseCommitted
```
protected volatile boolean responseCommitted
```
  - responseCompleted
```
protected volatile boolean responseCompleted
```
  - completionCallback
```
protected sirius.kernel.commons.Callback<sirius.kernel.async.CallContext> completionCallback
```
  - ssl
```
protected Boolean ssl
```
  - contentHandler
```
protected ContentHandler contentHandler
```
  - started
```
protected volatile long started
```
  - committed
```
protected volatile long committed
```
  - userAgent
```
protected UserAgent userAgent
```
  - addP3PHeader
```
protected static boolean addP3PHeader
```
  - contentSecurityPolicy
```
protected static String contentSecurityPolicy
```
  - corsAllowAll
```
protected static boolean corsAllowAll
```
  - forceHSTS
```
protected static boolean forceHSTS
```
  - hstsMaxAge
```
protected static int hstsMaxAge
```
  - HTTP_DATE_FORMAT
```
public static final String HTTP_DATE_FORMAT
```
    Date format used by HTTP date headers
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WebContext
```
public WebContext()
```
- Method Detail
  - getCtx
```
public ChannelHandlerContext getCtx()
```
    Provides access to the underlying ChannelHandlerContext
    
    Returns:
    
    the underlying channel handler context
  - enableTiming
```
public WebContext enableTiming(String key)
```
    Enables microtiming for this request.
    If null is passed in as key, the request uri is used.
    If the microtiming was already enabled, it will remain enabled, with the original key
    
    Parameters:
    
    key - the key used to pass to the microtiming framework.
    
    Returns:
    
    this to fluently work with this context
  - isValid
```
public boolean isValid()
```
    Determines if this context is attached to a request or not.
    
    Returns:
    
    true if this context is attached to a request, false otherwise
  - onComplete
```
public void onComplete(sirius.kernel.commons.Callback<sirius.kernel.async.CallContext> onComplete)
```
    Used to provide a handle which is invoked once the call is completely handled.
    Note that calling this method, removes the last completion handler.
    
    Parameters:
    
    onComplete - the handler to be invoked once the request is completely handled
  - setCtx
```
protected void setCtx(ChannelHandlerContext ctx)
```
    Sets the ChannelHandlerContext for this context.
    
    Parameters:
    
    ctx - the channel handler context to use
  - getRequest
```
public HttpRequest getRequest()
```
    Provides access to the underlying netty HttpRequest
    
    Returns:
    
    the underlying request
  - setRequest
```
protected void setRequest(HttpRequest request)
```
    Sets the underlying HttpRequest
    
    Parameters:
    
    request - the request on which this context is based
  - isLongCall
```
public boolean isLongCall()
```
    Determines if this request was marked as long call.
    This will effectively disable the idle timeout for this request.
    
    Returns:
    
    true if the request was marked as long call, false otherwise
  - markAsLongCall
```
public void markAsLongCall()
```
    Marks the request as long call.
    This will disable all idle timeout checks for this request.
  - setContentHandler
```
public void setContentHandler(ContentHandler handler)
```
    Can be set from within WebDispatcher.preparePreDispatch(WebContext) to manually handle incoming content.
    
    Parameters:
    
    handler - the handler to be supplied with content. If null, the default (memory/disk buffering) handler is applied.
  - get
```
@Nonnull
public sirius.kernel.commons.Value get(String key)
```
    Returns a value or parameter supplied by the request.
    This method first checks if an attribute with the given key exists. If not, the query string is scanned. After that, the posted content is looked through to find an appropriate value.
    
    Parameters:
    
    key - the key used to look for the value
    
    Returns:
    
    a Value representing the provided data.
  - getFirstFilled
```
public sirius.kernel.commons.Value getFirstFilled(String... keys)
```
    Returns the first non empty value for the given keys.
    This is a boilerplate method for get(String) in case the same value could be sent via different parameter names.
    
    Parameters:
    
    keys - the keys to check
    
    Returns:
    
    the first non empty value or an empty value if no data was found for all given keys.
  - hasParameter
```
public boolean hasParameter(String key)
```
    Determines if the parameter with the given name is contained in the request. Either as POST value or in the query string.
    
    Parameters:
    
    key - the parameter to check for
    
    Returns:
    
    true if the parameter is present (even if its value is null), false otherwise
  - require
```
public sirius.kernel.commons.Value require(String... keys)
```
    Returns the value provided for the given key(s) or reports an error if no non empty value was found.
    The first non empty value is used. If all values are empty, an exception is thrown.
    
    Parameters:
    
    keys - the keys to check for a value
    
    Returns:
    
    the first non empty value found for one of the given keys
  - getHttpData
```
public HttpData getHttpData(String key)
```
    Returns the posted part with the given key.
    
    Parameters:
    
    key - used to specify which part of the post request should be returned.
    
    Returns:
    
    the data provided for the given key or null if no data was supplied.
  - getFileData
```
public FileUpload getFileData(String key)
```
    Returns the file upload supplied for the given key.
    
    Parameters:
    
    key - used to specify which part of the post request should be used.
    
    Returns:
    
    a file upload sent for the given key or null if no upload data is available
  - generateLocalId
```
public long generateLocalId()
```
    Generates an ID (numeric value) which is unique withing this HTTP request.
    This can be used to create IDs for HTML elements and the like.
    
    Returns:
    
    a locally unique ID as long as less than Long.MAX_VALUE IDs are requested.
  - setAttribute
```
public void setAttribute(String key,
                         Object value)
```
    Sets an attribute for the current request.
    Attributes are neither stored nor transmitted to the client. Therefore they are only visible during the processing of this request.
    
    Parameters:
    
    key - name of the attribute
    
    value - value of the attribute
  - setCustomSessionCookieTTL
```
public void setCustomSessionCookieTTL(@Nullable
                                      Duration customSessionCookieTTL)
```
    Sets an explicit session cookie TTL (time to live).
    If a non null value is given, this will overwrite defaultSessionCookieTTL for this request/response.
    
    Parameters:
    
    customSessionCookieTTL - the new TTL for the client session cookie.
  - setSessionValue
```
public void setSessionValue(String key,
                            Object value)
```
    Stores a value in the client session.
    As this session is transmitted to the client, the given value should not be large and needs a parseable string representation
    
    Parameters:
    
    key - the name of th value to set
    
    value - the value to set
  - getSessionValue
```
public sirius.kernel.commons.Value getSessionValue(String key)
```
    Loads a value from the client session
    
    Parameters:
    
    key - the name of the value to load
    
    Returns:
    
    the value previously set in the session or an empty Value if no data is present
  - getSessionKeys
```
public List<String> getSessionKeys()
```
    Returns a list of all known session keys for the current session
    
    Returns:
    
    a list of all known keys for the current session
  - clearSession
```
public void clearSession()
```
    Clears (invalidated) the client session by removing all values.
  - cacheUserMessages
```
public void cacheUserMessages()
```
    Caches user messages to show them with the next request.
    In some interaction patterns, we cannot directly show generated messages to a user. Therefore these are cached and retrieved with the next "full" request.
    When sending a redirect or performing an ajax call + a refresh, it is not possible to show messages to a user. Therefore we cache those messages and return them with the next call to UserContext.getMessages().
  - createDistributedReadOnceCache
```
public static UserMessageCache createDistributedReadOnceCache(String name)
```
    Creates a distributed UserMessageCache if a DistributedUserMessageCacheFactory is implemented and can be injected. A LocalUserMessageCache otherwise.
    Considers the config cache.[name].ttl for the cache.
    
    Parameters:
    
    name - The cache name.
    
    Returns:
    
    The created cache.
  - restoreCachedMessages
```
public void restoreCachedMessages()
```
    Invoked by UserContext.getMessages() to fetch and apply all previously cached message.
  - clearCachedUserMessages
```
public void clearCachedUserMessages()
```
    Clears all previously cached user messages
  - getRequestedURI
```
public String getRequestedURI()
```
    Returns the decoded requested URI of the underlying HTTP request, without the query string
    
    Returns:
    
    the decoded uri of the underlying request
  - getRawRequestedURI
```
public String getRawRequestedURI()
```
    Returns the raw undecoded requested URI of the underlying HTTP request, without the query string
    
    Returns:
    
    the undecoded uri of the underlying request
  - getBaseURL
```
public String getBaseURL()
```
    Returns the base url (the protocol + host) for which this request was made.
    
    Returns:
    
    the base url which created this request, without the actual URI
  - getRequestedURL
```
public String getRequestedURL()
```
    Returns the complete URL as requested by the browser.
    
    Returns:
    
    the complete url (base url + uri) which created this request
  - getRemoteIP
```
public InetAddress getRemoteIP()
```
    Returns the remote address which sent the request
    
    Returns:
    
    the remote address of the underlying TCP connection. This will take a X-Forwarded-For header into account if the connection was opened from a known proxy ip.
  - determineRemoteIP
```
public static InetAddress determineRemoteIP(ChannelHandlerContext ctx,
                                            HttpRequest request)
```
    Tries to determine the effective remote IP for the given context and request.
    This is the remote address of the channel. However, if recognized as a proxy, we use the last IP address given in the X-Forarded-For header.
    
    Parameters:
    
    ctx - the channel context used to determine the physical IP
    
    request - the request used to read the appropriate headers for reverse proxies
    
    Returns:
    
    the effective remote address of the client
  - isTrusted
```
public boolean isTrusted()
```
    Determines if the request is from a trusted IP.
    
    Returns:
    
    true if the request is from a trusted ip (see WebServer.trustedIPs), false otherwise
  - isSSL
```
public boolean isSSL()
```
    Determines if this is an HTTPS (SSL protected) call.
    
    Returns:
    
    true if this is an HTTPS request, false otherwise
  - isCurrentRequestSSL
```
public static boolean isCurrentRequestSSL()
```
    Determines if the current request is secured by SSL.
    This is boilerplate for: CallContext.getCurrent().get(WebContext.class).isSSL()
    
    Returns:
    
    true if this is an HTTPS request, false otherwise
  - getParameter
```
public String getParameter(String key)
```
    Returns the query string or POST parameter with the given name.
    If a POST request with query string is present, parameters in the query string have precedence.
    
    Parameters:
    
    key - the name of the parameter to fetch
    
    Returns:
    
    the first value or null if the parameter was not set or empty
  - getParameters
```
public List<String> getParameters(String key)
```
    Returns all query string or POST parameters with the given name.
    If a POST request with query string is present, parameters in the query string have precedence. If values in the query string are found, the POST parameters are discarded and not added to the resulting list.
    
    Parameters:
    
    key - the name of the parameter to fetch
    
    Returns:
    
    all values in the query string
  - withCustomURI
```
public WebContext withCustomURI(String uri)
```
    Overwrites the uri with the given one.
    This can be used to control dispatching or to even re-dispatch a request for another destination.
    Note however, that only the the requestedURI, queryString and the rawRequestedURI are overwritten, not the one of the underlying request.
    
    Parameters:
    
    uri - the new uri to use. The uri and its query string will be parsed and the internal fields are updated accordingly.
    
    Returns:
    
    the web context itself for fluent method calls
  - withCustomPath
```
public WebContext withCustomPath(String path)
```
    Overwrites the path with the given one.
    This can be used to control dispatching or to even re-dispatch a request for another destination.
    Note however, that the original query string and its parameters remain.
    
    Parameters:
    
    path - the new path to use
    
    Returns:
    
    the web context itself for fluent method calls
  - getCookies
```
public Collection<Cookie> getCookies()
```
    Returns all cookies submitted by the client
    
    Returns:
    
    a list of cookies sent by the client
  - getCookie
```
public Cookie getCookie(String name)
```
    Returns a cookie with the given name, sent by the client
    
    Parameters:
    
    name - the cookie to fetch
    
    Returns:
    
    the client cookie with the given name, or nzlnull if no matching cookie was found
  - getCookieValue
```
@Nullable
public String getCookieValue(String name)
```
    Returns the data of the given client cookie wrapped as Value
    
    Parameters:
    
    name - the cookie to fetch
    
    Returns:
    
    the contents of the cookie wrapped as Value
  - setCookie
```
public void setCookie(Cookie cookie)
```
    Sets the given cookie to be sent back to the client
    
    Parameters:
    
    cookie - the cookie to send to the client
  - setSessionCookie
```
public void setSessionCookie(String name,
                             String value)
```
    Sets a cookie value to be sent back to the client
    The generated cookie will be a session cookie and varnish once the user agent is closed
    
    Parameters:
    
    name - the cookie to create
    
    value - the contents of the cookie
  - setHTTPSessionCookie
```
public void setHTTPSessionCookie(String name,
                                 String value)
```
    Sets a http only cookie value to be sent back to the client.
    The generated cookie will be a session cookie and varnish once the user agent is closed. Also this cookie will not be accessible by JavaScript and therefore slightly more secure.
    
    Parameters:
    
    name - the cookie to create
    
    value - the contents of the cookie
  - setClientCookie
```
public void setClientCookie(String name,
                            String value,
                            long maxAgeSeconds)
```
    Sets a cookie value to be sent back to the client.
    Note that his cookie is also available to JavaScript which is inherent less secure.
    
    Parameters:
    
    name - the cookie to create
    
    value - the contents of the cookie
    
    maxAgeSeconds - contains the max age of this cookie in seconds
  - setCookie
```
public void setCookie(String name,
                      String value,
                      long maxAgeSeconds)
```
    Sets a http only cookie value to be sent back to the client.
    
    Parameters:
    
    name - the cookie to create
    
    value - the contents of the cookie
    
    maxAgeSeconds - contains the max age of this cookie in seconds
  - deleteCookie
```
public void deleteCookie(@Nonnull
                         String name)
```
    Removes the given cookie from the cookies sent back to the client.
    
    Parameters:
    
    name - the cookie to delete
  - getOutCookies
```
protected Collection<Cookie> getOutCookies()
```
    Returns all cookies to be sent to the client. Used by Response to construct an appropriate header.
    
    Returns:
    
    a list of all cookies to be sent to the client.
  - getLang
```
public String getLang()
```
    Returns the accepted language of the client as two-letter language code.
    
    Returns:
    
    the two-letter code of the accepted language of the user agent. Returns the current language, if no supported language was submitted.
  - respondWith
```
public Response respondWith()
```
    Creates a response for this request.
    
    Returns:
    
    a new response used to send data to the client.
  - isResponseCommitted
```
public boolean isResponseCommitted()
```
    Determines if a response was already committed.
    If a response is committed a HTTP state and some headers have already been sent. Therefore a new / other response cannot be created to this request.
    
    Returns:
    
    true if the response has been committed, false otherwise.
  - getHeader
```
@Nullable
public String getHeader(CharSequence header)
```
    Returns the request header with the given name
    
    Parameters:
    
    header - name of the header to fetch.
    
    Returns:
    
    the value of the given header or null if no such header is present
  - getHeaderValue
```
@Nonnull
public sirius.kernel.commons.Value getHeaderValue(CharSequence header)
```
    Returns the request header wrapped as Value
    
    Parameters:
    
    header - name of the header to fetch.
    
    Returns:
    
    the contents of the named header wrapped as Value
  - getDateHeader
```
public long getDateHeader(CharSequence header)
```
    Returns the value of a date header as UNIX timestamp in milliseconds.
    
    Parameters:
    
    header - the name of the header to fetch
    
    Returns:
    
    the value in milliseconds of the submitted date or 0 if the header was not present.
  - tryBasicAuthentication
```
@Nullable
public sirius.kernel.commons.Tuple<String,String> tryBasicAuthentication(String realm)
```
    Tries to perform a HTTP Basic authentication by parsing the Authorization header.
    If no such header is found or if the contents are malformed, an 401 UNAUTHORIZED response will be generated (Response.unauthorized(String)) and null will be returned.
    In case the username and password returned by this method are invalid, use Response.unauthorized(String) to notify the client.
    
    Parameters:
    
    realm - the realm to report to the client in case of missing or malformed credentials
    
    Returns:
    
    a tuple containing username and password or null to indicate that a 401 UNAUTHORIZED response was sent in order to make the client send credentials.
  - getParameterNames
```
public Collection<String> getParameterNames()
```
    Returns a collection of all parameters names.
    This will combine both, the query string and POST parameters.
    
    Returns:
    
    a collection of all parameters sent by the client
  - getQueryString
```
@Nonnull
public String getQueryString()
```
    Returns the original query string sent by the client.
    This will not include the initial question mark.
    
    Returns:
    
    the query string (x=y&z=a...) or an empty string if there is no query string
  - getPostDecoder
```
public InterfaceHttpPostRequestDecoder getPostDecoder()
```
    Returns the post decoder used to decode the posted data.
    
    Returns:
    
    the post decoder or null, if no post request is available
  - isPOST
```
@Deprecated
public boolean isPOST()
```
    Deprecated. use isUnsafePOST() and isSafePOST() instead
    
    Determines if the current request is a POST request.
    A POST request signal the server to alter its state, knowing that side effects will occur.
    
    Returns:
    
    true if the method of the current request is POST, false otherwise
  - isSafePOST
```
public boolean isSafePOST()
```
    Determines if the current request is a POST request with checking for a valid CSRF-token.
    A POST request signal the server to alter its state, knowing that side effects will occur.
    
    Returns:
    
    true if the method of the current request is POST and the provided CSRF-token is valid, false otherwise
  - isUnsafePOST
```
public boolean isUnsafePOST()
```
    Determines if the current request is a POST request without checking for a valid CSRF-token.
    A POST request signal the server to alter its state, knowing that side effects will occur.
    
    Returns:
    
    true if the method of the current request is POST, false otherwise
  - ensureSafePOST
```
@CheckReturnValue
public boolean ensureSafePOST()
```
    Determines if the current request is a POST request with checking for a valid CSRF-token. If the token is not valid an exception is thrown in contrast to isSafePOST().
    A POST request signal the server to alter its state, knowing that side effects will occur.
    
    Returns:
    
    true if the method of the current request is POST and the provided CSRF-token is valid, false otherwise
  - hidePost
```
public void hidePost()
```
    Hide the fact that this request is a POST request.
    Sometimes it is useful to make isPOST() return false even if the current request is a POST requests. Login forms woule be one example. As a login request is sent to any URL, we don't want a common POST handler to trigger on that post data.
  - getContent
```
public InputStream getContent()
                       throws IOException
```
    Provides the body of the request as stream.
    
    Returns:
    
    an input stream reading from the body of the request.
    
    Throws:
    
    IOException - in case of an io error
  - setContentCharset
```
public void setContentCharset(Charset charset)
```
    Sets the charset of the body of the request.
    
    Parameters:
    
    charset - the charset to be applied to the body of the request
  - getContentCharset
```
public Charset getContentCharset()
```
    Returns the charset of the body of the request
    
    Returns:
    
    the charset used by the body of the request
  - getContentSize
```
public long getContentSize()
```
    Returns the size in bytes of the body of the request.
    
    Returns:
    
    the size in bytes of the http body.
  - getContentAsFile
```
public File getContentAsFile()
                      throws IOException
```
    Returns the content of the HTTP request as file on disk.
    Note that the file will be deleted once the request is completely handled.
    
    Returns:
    
    the file pointing to the content sent by the client
    
    Throws:
    
    IOException - in case of an IO error
  - getContentAsCopy
```
@Nullable
public File getContentAsCopy()
                                throws IOException
```
    Returns the content of the HTTP request as file on disk.
    Note that the file will NOT be deleted once the request is completely handled. Therefore the caller must delete this file once it has been processed.
    
    Returns:
    
    the file pointing to the content sent by the client
    
    Throws:
    
    IOException - in case of an IO error
  - addFileToCleanup
```
public void addFileToCleanup(File file)
```
    Adds a file to the cleanup list.
    All files in this list will be deleted once the request is completely handled. This can be used to wipe any intermediate files created while handling this request.
    
    Parameters:
    
    file - the file to be deleted once the request is completed.
  - getXMLContent
```
public sirius.kernel.xml.StructuredInput getXMLContent()
```
    Returns the body of the HTTP request as XML data.
    Note that all data is loaded into the heap. Therefore certain limits apply. If the data is too large, an exception will be thrown.
    
    Returns:
    
    the body of the HTTP request as XML input
  - getJSONContent
```
public com.alibaba.fastjson.JSONObject getJSONContent()
```
    Returns the body of the HTTP request as JSON data.
    Note that all data is loaded into the heap. Therefore certain limits apply. If the data is too large, an exception will be thrown.
    
    Returns:
    
    the body of the HTTP request as JSON input
  - getRequestEncoding
```
public Charset getRequestEncoding()
```
    Tries to determine the charset used for the INCOMING request.
    This is not to be confused with the desired charset of the outgoing data (specified via Accept-Charset).
    
    Returns:
    
    the charset specified via Content-Type or UTF-8 if no value is given.
  - hasContent
```
public boolean hasContent()
```
    Determines if a content is available for this request.
    
    Returns:
    
    true if content is available, false otherwise
  - isContentProbablyXML
```
public boolean isContentProbablyXML()
```
    Determines if the content body might contain XML (rather than JSON).
    The detection is kind of crude as we only check if the first non whitespace character is a <
    
    Returns:
    
    true if the content is believed to be XML, false otherwise
  - getDynamicAssetToken
```
public String getDynamicAssetToken()
```
    Returns a token which can be added to dynamic asset-URLS (/asset/dynamic/TOKEN/...) to force a reload of the specified resource.
    
    Returns:
    
    a random token which is guaranteed to be free of special chars (like / and the like)
  - getUserAgent
```
public UserAgent getUserAgent()
```
    Returns UserAgent for easy access to the user agent used for this request. Also it provides access to some assumptions based on the user agent e.g. which device was used.
    
    Returns:
    
    user agent wrapper object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fork
```
public sirius.kernel.async.SubContext fork()
```
    Specified by:
    
    fork in interface sirius.kernel.async.SubContext
  - detach
```
public void detach()
```
    Specified by:
    
    detach in interface sirius.kernel.async.SubContext

Class WebContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

request

cookiesOut

postDecoder

hidePost

content

microtimingKey

responseCommitted

responseCompleted

completionCallback

ssl

contentHandler

started

committed

userAgent

addP3PHeader

contentSecurityPolicy

corsAllowAll

forceHSTS

hstsMaxAge

HTTP_DATE_FORMAT

Constructor Detail

WebContext

Method Detail

getCtx

enableTiming

isValid

onComplete

setCtx

getRequest

setRequest

isLongCall

markAsLongCall

setContentHandler

get

getFirstFilled

hasParameter

require

getHttpData

getFileData

generateLocalId

setAttribute

setCustomSessionCookieTTL

setSessionValue

getSessionValue

getSessionKeys

clearSession

cacheUserMessages

createDistributedReadOnceCache

restoreCachedMessages

clearCachedUserMessages

getRequestedURI

getRawRequestedURI

getBaseURL

getRequestedURL

getRemoteIP

determineRemoteIP

isTrusted

isSSL

isCurrentRequestSSL

getParameter

getParameters

withCustomURI

withCustomPath

getCookies

getCookie

getCookieValue

setCookie

setSessionCookie

setHTTPSessionCookie

setClientCookie

setCookie

deleteCookie

getOutCookies

getLang