RenderingJob (Jetspeed-2 Core API 2.3.1 API)

All Superinterfaces:

Runnable
```
public interface RenderingJob
extends Runnable
```
A rendering worker, running on its own thread if using parallel rendering. This worker thread processes rendering jobs of portlet windows and notifies the WorkerMonitor when the job is completed.

Version:

$Id: $

Author:

David Sean Taylor

Field Summary

Fields
Modifier and Type Field and Description

static String ACCESS_CONTROL_CONTEXT_WORKER_ATTR
Worker attribute name of AccessControlContext object in the current request processing context.

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_CONTROL_CONTEXT_WORKER_ATTR` Worker attribute name of AccessControlContext object in the current request processing context.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execute()` Execute the rendering of a portlet window, delegating to the portlet container.
`int`	`getExpirationCache()` The expiration cache timeout value in seconds for the content of this job
`ContentFragment`	`getFragment()` The content fragment to hold the rendered output of this job
`PortletContent`	`getPortletContent()` Returns the portlet content buffer associated with this job
`PortletDefinition`	`getPortletDefinition()` Returns the portlet definition associated with this portlet window and job
`PortletRenderer`	`getRenderer()` Deprecated.
`javax.servlet.http.HttpServletRequest`	`getRequest()` The underlying HttpServletRequest used to render this job
`RequestContext`	`getRequestContext()` The request context associated with this job
`javax.servlet.http.HttpServletResponse`	`getResponse()` The underlying HttpServletResponse used to render this job
`long`	`getTimeout()` The timeout for rendering this job in milliseconds.
`PortletWindow`	`getWindow()` Returns the portlet window associated with this job
`Object`	`getWorkerAttribute(String name)` Retrieve a generic worker attribute associated it with this job.
`boolean`	`isTimeout()` Determines if this job has exceeded the timeout for rendering this job in milliseconds.
`void`	`removeWorkerAttribute(String name)` Remove a generic worker attribute associated with this job.
`void`	`setTimeout(long portletTimeout)` The timeout for rendering this job in milliseconds.
`void`	`setWorkerAttribute(String name, Object value)` Set a generic worker attribute and associate it with this job.

Methods inherited from interface java.lang.Runnable
run

- Field Detail
  - ACCESS_CONTROL_CONTEXT_WORKER_ATTR
```
static final String ACCESS_CONTROL_CONTEXT_WORKER_ATTR
```
    Worker attribute name of AccessControlContext object in the current request processing context.
- Method Detail
  - execute
```
void execute()
```
    Execute the rendering of a portlet window, delegating to the portlet container. Exceptions are never thrown from this method since it can be run in a separate thread. All exceptions are kept internal and returned in the job's state and content. Portlet tracking and timeout processing should be handled by implementations.
  - getRenderer
```
PortletRenderer getRenderer()
```
    Deprecated.
    
    Returns the portlet renderer service managing this job
    
    Returns:
    the renderer service
  - getWindow
```
PortletWindow getWindow()
```
    Returns the portlet window associated with this job
    
    Returns:
    the portlet window
  - getPortletContent
```
PortletContent getPortletContent()
```
    Returns the portlet content buffer associated with this job
    
    Returns:
    the portlet content buffer
  - setTimeout
```
void setTimeout(long portletTimeout)
```
    The timeout for rendering this job in milliseconds. Depending on the PortletTrackingManager policy, this portlet can be taken out of service after timing out repeatedly.
    
    Parameters:
    portletTimeout - the rendering timeout in milliseconds
  - getTimeout
```
long getTimeout()
```
    The timeout for rendering this job in milliseconds. Depending on the PortletTrackingManager policy, this portlet can be taken out of service after timing out repeatedly.
    
    Returns:
    the rendering timeout in milliseconds
  - isTimeout
```
boolean isTimeout()
```
    Determines if this job has exceeded the timeout for rendering this job in milliseconds. Depending on the PortletTrackingManager policy this portlet can be taken out of service after timing out repeatedly.
    
    Returns:
    true if this job has exceeded the timeout in rendering
  - getPortletDefinition
```
PortletDefinition getPortletDefinition()
```
    Returns the portlet definition associated with this portlet window and job
    
    Returns:
    the portlet definition from the portlet registry
  - getRequest
```
javax.servlet.http.HttpServletRequest getRequest()
```
    The underlying HttpServletRequest used to render this job
    
    Returns:
    the underlying HttpServletRequest
  - getResponse
```
javax.servlet.http.HttpServletResponse getResponse()
```
    The underlying HttpServletResponse used to render this job
    
    Returns:
    the underlying HttpServletResponse
  - getFragment
```
ContentFragment getFragment()
```
    The content fragment to hold the rendered output of this job
    
    Returns:
    the content fragment
  - getRequestContext
```
RequestContext getRequestContext()
```
    The request context associated with this job
    
    Returns:
    the request context
  - getExpirationCache
```
int getExpirationCache()
```
    The expiration cache timeout value in seconds for the content of this job
    
    Returns:
    the expiration cache timeout in seconds
  - setWorkerAttribute
```
void setWorkerAttribute(String name,
                      Object value)
```
    Set a generic worker attribute and associate it with this job.
    
    Parameters:
    name - the name of the attribute
    value - the value of the attribute
  - getWorkerAttribute
```
Object getWorkerAttribute(String name)
```
    Retrieve a generic worker attribute associated it with this job.
    
    Parameters:
    name - the name of the attribute
    
    Returns:
    the value of the attribute
  - removeWorkerAttribute
```
void removeWorkerAttribute(String name)
```
    Remove a generic worker attribute associated with this job.
    
    Parameters:
    name - the name oof the attribute

Interface RenderingJob

Field Summary

Method Summary

Methods inherited from interface java.lang.Runnable

Field Detail

ACCESS_CONTROL_CONTEXT_WORKER_ATTR

Method Detail

execute

getRenderer

getWindow

getPortletContent

setTimeout

getTimeout

isTimeout

getPortletDefinition

getRequest

getResponse

getFragment

getRequestContext

getExpirationCache

setWorkerAttribute

getWorkerAttribute

removeWorkerAttribute