WebContext (JWIG)

java.lang.Object
- dk.brics.jwig.WebContext

Direct Known Subclasses:

AbstractHandler, SessionThread, WebApp
```
public abstract class WebContext
extends Object
```
Context for web execution.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CACHE_PRIORITY` Priority for the server cache web method.
`static ServletContext`	`context`
`static int`	`HANDLERS` Priority to use for handlers.
`(package private) static String`	`JWIG_DEFUNCT_SESSION`
`Logger`	`log` Logger.
`static int`	`MAX_PRIORITY` Priority for the main web method.
`static int`	`PRE_CACHE` Priority to use for web methods to be executed before the server cache, such as authentication methods.

Constructor Summary

Constructors
Constructor and Description

WebContext()
Constructs a new empty web context object.

Constructors
Constructor and Description
`WebContext()` Constructs a new empty web context object.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addCookie(Cookie c, boolean send_now)` Adds a cookie to the response.
`static void`	`addResponseInvalidator(Object obj)` Registers the given object as observable for the response.
`Object`	`augment()` Augments the current XML response with script code, JWIG logo, and web app params.
`Object`	`cache()` Server cache web method.
`protected String`	`getCacheAugmentedString(String url)`
`Cookie[]`	`getCookies()` Returns (non-null) array of cookies from the request.
`static URL`	`getRequestURL()` Returns the URL of the current request.
`static Response`	`getResponse()` Returns the current response object.
`static ServletContext`	`getServletContext()` Returns the `ServletContext` object.
`static HttpServletRequest`	`getServletRequest()` Returns the `HttpServletRequest` object.
`static HttpServletResponse`	`getServletResponse()` Returns the `HttpServletResponse` object.
`User`	`getUser()` Gets the user for the request, using HTTP Basic authentication.
`protected String`	`getWebAppParam(String name)` Gets the string representation of the web app parameter with this name
`<E> E`	`getWebAppParam(String name, Class<E> type)` Returns the web app parameter of the given name.
`static URL`	`getWebAppURL(boolean secure)` Generates a URL for the root of the current web application.
`WebSite`	`getWebSite()` Returns the web site object.
`static URL`	`getWebSiteURL()` Generates a URL for the root of this website.
`static URL`	`getWebSiteURL(boolean secure)` Generates a URL for the root of the web site.
`Object`	`handlers()` Invoked automatically from generated XML pages for executing a handler.
`void`	`handleUpdatedObjects()` Invalidates pages in the cache based on which objects are updated
`boolean`	`isSecure()` Checks whether the request was made using a secure channel, such as SSL/TLS.
`void`	`jwigJS()`
`Object`	`main()` Main web method.
`static URL`	`makeURL(boolean secure, Class<? extends WebApp> cl, Map<String,?> webapp_args, String method, Object... args)` Generates a URL for the given web method within the same web site and in the given web app, with web app arguments.
`static URL`	`makeURL(boolean secure, Class<? extends WebApp> cl, String method, Object... args)` Generates a URL for the given web method within the same web site and in the given web app.
`static URL`	`makeURL(boolean secure, Map<String,?> webapp_args, String method, Object... args)` Generates a URL for the given web method within the same web site, with web app arguments.
`static URL`	`makeURL(boolean secure, String method, Object... args)` Generates a URL for the given web method within the same web site.
`static URL`	`makeURL(Class<? extends WebApp> cl, String method, Object... args)` Generates a URL for the given web method within the same web site and in the given web app.
`static URL`	`makeURL(Map<String,?> webapp_args, String method, Object... args)` Generates a URL for the given web method within the same web site, with web app arguments.
`static URL`	`makeURL(String method, Object... args)` Generates a URL for the given web method within the same web site.
`static Object`	`next()` Invokes the next web method in the chain.
`static void`	`punish(String key)`
`SendFailedException`	`sendEmail(Email message)` Sends an email using JavaMail.
`List<SendFailedException>`	`sendEmails(List<Email> messages)` Sends a collection of emails.
`List<SendFailedException>`	`sendEmailsAsynchronously(List<Email> messages)` Works like `sendEmails(java.util.List)` but sends the emails in a separate thread.
`static void`	`sendResponse()` Sends the current response.
`String`	`touchSessions(Session[] s)` Invoked automatically from generated XML pages for refreshing active sessions.
`void`	`transportSessionHandlers()` If a piece of XML contains a handler and this piece of XML is stored in a session between requests, we need to make sure that the handler is transported from one request to the next. An example of this pattern exists in the guessing game example of jwig, where XML is stored in the session and updated from one request to the next.
`static void`	`update(Object obj)` Informs observers that the given object has been updated.

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

- Field Detail
  - CACHE_PRIORITY
```
public static final int CACHE_PRIORITY
```
    Priority for the server cache web method.
    
    See Also:
    cache(), Constant Field Values
  - context
```
public static ServletContext context
```
  - HANDLERS
```
public static final int HANDLERS
```
    Priority to use for handlers.
    
    See Also:
    handlers(), Constant Field Values
  - JWIG_DEFUNCT_SESSION
```
static final String JWIG_DEFUNCT_SESSION
```
    See Also:
    Constant Field Values
  - log
```
public final Logger log
```
    Logger.
  - MAX_PRIORITY
```
public static final int MAX_PRIORITY
```
    Priority for the main web method.
    
    See Also:
    main(), Constant Field Values
  - PRE_CACHE
```
public static final int PRE_CACHE
```
    Priority to use for web methods to be executed before the server cache, such as authentication methods.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - WebContext
```
WebContext()
```
    Constructs a new empty web context object.
- Method Detail
  - addCookie
```
protected void addCookie(Cookie c,
             boolean send_now)
```
    Adds a cookie to the response.
    
    Parameters:
    send_now - if set, the cookie is sent immediately without storing it in the response cache
  - addResponseInvalidator
```
public static void addResponseInvalidator(Object obj)
```
    Registers the given object as observable for the response. This means that if the object is updated (see @link #update(Object)), the response is invalidated in the cache.
  - augment
```
@URLPattern(value="**")
@Priority(value=2147483646)
@GET
@POST
@PUT
@DELETE
@TRACE
@HEAD
public Object augment()
```
    Augments the current XML response with script code, JWIG logo, and web app params. TODO: for all XML output (including XMLProducer): remove empty ul/ol/... (see PostProcessor.flex in old JWIG)
  - cache
```
@GET
@URLPattern(value="**")
@Priority(value=500)
public Object cache()
```
    Server cache web method. Checks whether the client's cached resource is valid (using If-Modified-Since and ETag) and whether the requested resource is in the server cache. Only considers GET requests. Invokes next() if a valid cached resource is not available.
  - getCacheAugmentedString
```
protected String getCacheAugmentedString(String url)
```
  - getCookies
```
public Cookie[] getCookies()
```
    Returns (non-null) array of cookies from the request.
  - getRequestURL
```
public static URL getRequestURL()
```
    Returns the URL of the current request.
  - getResponse
```
public static Response getResponse()
```
    Returns the current response object.
  - getServletContext
```
public static ServletContext getServletContext()
```
    Returns the ServletContext object.
  - getServletRequest
```
public static HttpServletRequest getServletRequest()
```
    Returns the HttpServletRequest object.
  - getServletResponse
```
public static HttpServletResponse getServletResponse()
```
    Returns the HttpServletResponse object.
  - getUser
```
public User getUser()
```
    Gets the user for the request, using HTTP Basic authentication. Returns null if not available.
  - getWebAppParam
```
protected String getWebAppParam(String name)
```
    Gets the string representation of the web app parameter with this name
  - getWebAppParam
```
public <E> E getWebAppParam(String name,
                   Class<E> type)
```
    Returns the web app parameter of the given name.
  - getWebAppURL
```
public static URL getWebAppURL(boolean secure)
```
    Generates a URL for the root of the current web application.
    
    Parameters:
    secure - if true, use https, otherwise http
  - getWebSite
```
public final WebSite getWebSite()
```
    Returns the web site object.
  - getWebSiteURL
```
public static URL getWebSiteURL()
```
    Generates a URL for the root of this website. The URL uses https iff the request does. Requires the calling thread to be bound to a request.
  - getWebSiteURL
```
public static URL getWebSiteURL(boolean secure)
```
    Generates a URL for the root of the web site. If the calling thread is bound to a request this method will return the URL for the WebSite either from the configuration (if available) or (otherwise by inspecting the current request. Otherwise if the method is called without a request context, this method will only inspect the configuration.
    The result of calling this method will be the same with or without a request context if the jwig.base_url and jwig.base_url_secure properties have been set in jwig.properties.
    
    Parameters:
    secure - if true, use https, otherwise http
  - handlers
```
@Priority(value=0)
@URLPattern(value="handlers/*")
public Object handlers()
                throws IOException
```
    Invoked automatically from generated XML pages for executing a handler.
    
    Throws:
    
    IOException
  - handleUpdatedObjects
```
@PUT
@DELETE
@POST
@URLPattern(value="**")
@Priority(value=500)
public void handleUpdatedObjects()
```
    Invalidates pages in the cache based on which objects are updated
  - isSecure
```
public boolean isSecure()
```
    Checks whether the request was made using a secure channel, such as SSL/TLS.
  - jwigJS
```
@Priority(value=1000)
@URLPattern(value="jwig.js")
public void jwigJS()
            throws IOException
```
    Throws:
    
    IOException
  - main
```
@URLPattern(value="**")
@Priority(value=2147483647)
@GET
@POST
@PUT
@DELETE
@TRACE
@HEAD
public final Object main()
                  throws InterruptedException
```
    Main web method. Catches exceptions and reports them as HTTP errors.
    
    Throws:
    
    InterruptedException
  - makeURL
```
public static URL makeURL(boolean secure,
          Class<? extends WebApp> cl,
          Map<String,?> webapp_args,
          String method,
          Object... args)
```
    Generates a URL for the given web method within the same web site and in the given web app, with web app arguments.
    
    Parameters:
    secure - if true, use https, otherwise http
    cl - the web app to search for the method in
    webapp_args - web app arguments. This map can define values for arguments defined by the WebApp class (rather than the web method). See section 4.3 in the manual for details
    method - the name of the web method
    args - arguments to the web method. These arguments will be encoded using toString and will be part of the request URL for the web method. The list of args must match the list of formal parameters in the web method both in terms of number and types. The parameter will be mapped to names based on their order.
  - makeURL
```
public static URL makeURL(boolean secure,
          Class<? extends WebApp> cl,
          String method,
          Object... args)
```
    Generates a URL for the given web method within the same web site and in the given web app.
    
    Parameters:
    secure - if true, use https, otherwise http
    cl - the web app to search for the method in
    method - the name of the web method
    args - arguments to the web method. These arguments will be encoded using toString and will be part of the request URL for the web method. The list of args must match the list of formal parameters in the web method both in terms of number and types. The parameter will be mapped to names based on their order.
  - makeURL
```
public static URL makeURL(boolean secure,
          Map<String,?> webapp_args,
          String method,
          Object... args)
```
    Generates a URL for the given web method within the same web site, with web app arguments.
    
    Parameters:
    secure - if true, use https, otherwise http
    webapp_args - web app arguments. This map can define values for arguments defined by the WebApp class (rather than the web method). See section 4.3 in the manual for details
    method - the name of the web method (optionally qualified by the class name, default: this web app)
    args - arguments to the web method. These arguments will be encoded using toString and will be part of the request URL for the web method. The list of args must match the list of formal parameters in the web method both in terms of number and types. The parameter will be mapped to names based on their order.
  - makeURL
```
public static URL makeURL(boolean secure,
          String method,
          Object... args)
```
    Generates a URL for the given web method within the same web site.
    
    Parameters:
    secure - if true, use https, otherwise http
    method - the name of the web method (optionally qualified by the class name, default: this web app)
    args - arguments to the web method. These arguments will be encoded using toString and will be part of the request URL for the web method. The list of args must match the list of formal parameters in the web method both in terms of number and types. The parameter will be mapped to names based on their order.
  - makeURL
```
public static URL makeURL(Class<? extends WebApp> cl,
          String method,
          Object... args)
```
    Generates a URL for the given web method within the same web site and in the given web app. The URL uses https if the current request is on a secure connection.
    
    Parameters:
    cl - the web app to search for the method in
    method - the name of the web method
    args - arguments to the web method. These arguments will be encoded using toString and will be part of the request URL for the web method. The list of args must match the list of formal parameters in the web method both in terms of number and types. The parameter will be mapped to names based on their order.
  - makeURL
```
public static URL makeURL(Map<String,?> webapp_args,
          String method,
          Object... args)
```
    Generates a URL for the given web method within the same web site, with web app arguments. The URL uses https if the current request is on a secure connection.
    
    Parameters:
    webapp_args - web app arguments. This map can define values for arguments defined by the WebApp class (rather than the web method). See section 4.3 in the manual for details
    method - the name of the web method (optionally qualified by the class name, default: this web app)
    args - arguments to the web method. These arguments will be encoded using toString and will be part of the request URL for the web method. The list of args must match the list of formal parameters in the web method both in terms of number and types. The parameter will be mapped to names based on their order.
  - makeURL
```
public static URL makeURL(String method,
          Object... args)
```
    Generates a URL for the given web method within the same web site. The URL uses https if the current request is on a secure connection.
    
    Parameters:
    method - the name of the web method (optionally qualified by the class name, default: this web app)
    args - arguments to the web method. These arguments will be encoded using toString and will be part of the request URL for the web method. The list of args must match the list of formal parameters in the web method both in terms of number and types. The parameter will be mapped to names based on their order.
  - next
```
public static Object next()
```
    Invokes the next web method in the chain.
  - punish
```
public static void punish(String key)
```
  - sendEmail
```
public SendFailedException sendEmail(Email message)
                              throws JWIGException
```
    Sends an email using JavaMail. All configuration properties starting with mail. are used for setting up a JavaMail session when the web app is initialized.
    
    Returns:
    a SendFailedException or null if there is no error
    
    Throws:
    
    JWIGException - in case of other errors than SendFailedException
    See Also:
    WebApp.setProperty(String, Object), sendEmails(List)
  - sendEmails
```
public List<SendFailedException> sendEmails(List<Email> messages)
                                     throws JWIGException
```
    Sends a collection of emails.
    
    Returns:
    a list of SendFailedExceptions, one for each message being sent, with null meaning "no error"
    
    Throws:
    
    JWIGException - in case of other errors than SendFailedException
    See Also:
    sendEmail(Email)
  - sendEmailsAsynchronously
```
public List<SendFailedException> sendEmailsAsynchronously(List<Email> messages)
                                                   throws JWIGException
```
    Works like sendEmails(java.util.List) but sends the emails in a separate thread. For large batches of emails this means that the application does not have to wait. Errors can however not be propagated using this method
    
    Parameters:
    messages - Messages to send
    
    Returns:
    an empty list
    
    Throws:
    
    JWIGException
  - sendResponse
```
public static void sendResponse()
```
    Sends the current response. Use in filter web methods (i.e. only GET requests) for producing response. If no response has been sent and the method has return type void, then the next web method in the chain is invoked when the filter web method returns. Also used for producing a temporary response and continuing execution.
  - touchSessions
```
@Priority(value=1000)
public String touchSessions(Session[] s)
```
    Invoked automatically from generated XML pages for refreshing active sessions.
  - transportSessionHandlers
```
@Priority(value=2147483646)
@URLPattern(value="**")
public void transportSessionHandlers()
```
    If a piece of XML contains a handler and this piece of XML is stored in a session between requests, we need to make sure that the handler is transported from one request to the next.
    
    An example of this pattern exists in the guessing game example of jwig, where XML is stored in the session and updated from one request to the next. This method allows for handlers to be transported from one request where the handler is part of the XML and to the current request if the URL of the handler is part of the XML that is returned if those two requests share the same session.
  - update
```
public static void update(Object obj)
```
    Informs observers that the given object has been updated.
    
    See Also:
    XMLProducer, addResponseInvalidator(Object)

Class WebContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CACHE_PRIORITY

context

HANDLERS

JWIG_DEFUNCT_SESSION

log

MAX_PRIORITY

PRE_CACHE

Constructor Detail

WebContext

Method Detail

addCookie

addResponseInvalidator

augment

cache

getCacheAugmentedString

getCookies

getRequestURL

getResponse

getServletContext

getServletRequest

getServletResponse

getUser

getWebAppParam

getWebAppParam

getWebAppURL

getWebSite

getWebSiteURL

getWebSiteURL

handlers

handleUpdatedObjects

isSecure

jwigJS

main

makeURL

makeURL

makeURL

makeURL

makeURL

makeURL

makeURL

next

punish

sendEmail

sendEmails

sendEmailsAsynchronously

sendResponse

touchSessions

transportSessionHandlers

update