org.apache.jetspeed.aggregator

Interface PortletTrackingManager

public interface PortletTrackingManager

The Portlet Tracking Manager will track portlets rendering statistics, taking portlets out of service when their rendering time exceeds a configurable threshold. This threshold has two parameters: defaultPortletTimeout is a value in milliseconds representing the maximum render time to be considered as a timeout for a given portlet window. outOfServiceLimit represents the number of times the portlet window reaches the timeout threshold before it is taken out of service.

This service is used primarily by the rendering engine to determine whether to take a portlet window out of service to avoid long 'timeouts' when rendering a portlet. The service also provides functions to put the portlet windows back into service.

Version:

$Id: $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exceededTimeout(long renderTime, PortletWindow window) Given a render time, ask if the given portlet window has exceeded the timeout threshold
long	getDefaultPortletTimeout() Returns the default timeout threshold for rendering a portlet in milliseconds.
int	getOutOfServiceLimit() The number of times a portlet window can timeout before it is taken out of service
List<PortletTrackingInfo>	getOutOfServiceList() Retrieve the list of out of service portlet windows for the entire system
PortletTrackingInfo	getOutOfServiceList(String fullPortletName) Retrieve the list of out of service portlet windows for a given portlet, or an empty PortletTrackingInfo if none are found
void	incrementRenderTimeoutCount(PortletWindow window) Increment the render timeout count for a given portlet window
boolean	isEnabled() Returns true if this service is enabled, otherwise false.
boolean	isOutOfService(PortletWindow window) Ask if a given window is out of service or not
void	putIntoService(List<String> fullPortletNames) Given a list of full portlet names in format of portletApp::portletName, put all windows back into service for each of the portlet names given.
void	putIntoService(PortletWindow window) Put a given portlet window that is out of service back into service and re-enable rendering of the window
void	setExpiration(PortletWindow window, long expiration) Set a specific caching expiration timeout for a given portlet window
void	success(PortletWindow window) Reset this portlet window as successfully rendered, clearing all expiration counts
void	takeOutOfService(PortletWindow window) Take a given portlet window out of service.

Method Detail

getDefaultPortletTimeout

long getDefaultPortletTimeout()

Returns the default timeout threshold for rendering a portlet in milliseconds. This threshold is used to determine if the portlet has timed out, and is used in combination with getOutOfServiceLimit

Returns:

the default rendering timeout

getOutOfServiceLimit

int getOutOfServiceLimit()

The number of times a portlet window can timeout before it is taken out of service

Returns:

the number of times a portlet window can time out before it is considered out of service

isOutOfService

boolean isOutOfService(PortletWindow window)

Ask if a given window is out of service or not

Parameters:

window - this window will be checked

Returns:

true when the portlet window is determined to be out of service

exceededTimeout

boolean exceededTimeout(long renderTime,
                      PortletWindow window)

Given a render time, ask if the given portlet window has exceeded the timeout threshold

Parameters:

renderTime - the time it took to render a portlet

window - this window will be checked

Returns:

true when the render time exceeded the timeout threshold

incrementRenderTimeoutCount

void incrementRenderTimeoutCount(PortletWindow window)

Increment the render timeout count for a given portlet window

Parameters:

window - the portlet window to be incremented

setExpiration

void setExpiration(PortletWindow window,
                 long expiration)

Set a specific caching expiration timeout for a given portlet window

Parameters:

window - this window will have a new expiration timeout value

expiration - the value of the timeout expiration

success

void success(PortletWindow window)

Reset this portlet window as successfully rendered, clearing all expiration counts

Parameters:

window - this window will have its expiration status reset

takeOutOfService

void takeOutOfService(PortletWindow window)

Take a given portlet window out of service. This portlet window will no longer be rendered.

Parameters:

window - this window will be taken out of service

putIntoService

void putIntoService(PortletWindow window)

Put a given portlet window that is out of service back into service and re-enable rendering of the window

Parameters:

window - this window will be put back into service

putIntoService

void putIntoService(List<String> fullPortletNames)

Given a list of full portlet names in format of portletApp::portletName, put all windows back into service for each of the portlet names given. Note that a portlet can have many windows associated with it. Each of the windows associated with a given portlet will be put back into service.

Parameters:

fullPortletNames - a list of strings of full portlet names in format portletApp::portletName

getOutOfServiceList

PortletTrackingInfo getOutOfServiceList(String fullPortletName)

Retrieve the list of out of service portlet windows for a given portlet, or an empty PortletTrackingInfo if none are found

Parameters:

fullPortletName - a full portlet names in format portletApp::portletName

Returns:

a single PortletTrackingInfo which includes a list of window ids

getOutOfServiceList

List<PortletTrackingInfo> getOutOfServiceList()

Retrieve the list of out of service portlet windows for the entire system

Returns:

a list of portlet windows represented by PortletTrackingInfo

isEnabled

boolean isEnabled()

Returns true if this service is enabled, otherwise false. The service is enabled via the jetspeed.properties property named portal.core.aggregator.portlet.timeout. The value represents the timeout threshold in milliseconds. A value of zero disables portlet tracking.

Returns:

true if this service is enabled, otherwise false