org.apache.jetspeed.portal.portlets
Class WebPagePortlet

java.lang.Object
  extended byorg.apache.jetspeed.portal.portlets.AbstractPortlet
      extended byorg.apache.jetspeed.portal.portlets.AbstractInstancePortlet
          extended byorg.apache.jetspeed.portal.portlets.WebPagePortlet
All Implemented Interfaces:
Cacheable, Portlet, PortletState, org.apache.turbine.services.cache.Refreshable, java.io.Serializable

public class WebPagePortlet
extends AbstractInstancePortlet

A class that loads a web page and filters it to have certain features deleted.

Author:
Ingo Rammer, Santiago Gala, David Sean Taylor, David G. Powers
See Also:
Serialized Form

Field Summary
protected  boolean cacheContent
           
protected  boolean contentStale
           
protected  boolean initDone
           
protected  java.lang.String password
           
protected  HTMLRewriter rewriter
           
protected  java.lang.String username
           
 
Fields inherited from class org.apache.jetspeed.portal.portlets.AbstractPortlet
content
 
Fields inherited from interface org.apache.jetspeed.portal.Portlet
PORTLET_MAXIMIZED, PORTLET_MINIMIZED, PORTLET_NORMAL
 
Constructor Summary
WebPagePortlet()
           
 
Method Summary
 org.apache.ecs.ConcreteElement getContent(org.apache.turbine.util.RunData data)
          This methods outputs the content of the portlet for a given request.
protected  java.io.Reader getReader(java.lang.String url)
          took this from FileServerPortlet as it was private
 void init()
          Initialize this portlet by defining a HTML rewriter.
 void refresh()
          Usually called by caching system when portlet is marked as expired, but has not be idle longer then TimeToLive.
protected  java.lang.String selectUrl(org.apache.turbine.util.RunData data, PortletConfig config)
          Select the URL to use for this portlet.
 
Methods inherited from class org.apache.jetspeed.portal.portlets.AbstractInstancePortlet
getHandle
 
Methods inherited from class org.apache.jetspeed.portal.portlets.AbstractPortlet
allowClose, allowCustomize, allowInfo, allowMaximize, allowMinimize, allowPrintFriendly, allowView, clearContent, getAllowEdit, getAllowMaximize, getAllowView, getAttribute, getContent, getContent, getCreationTime, getDescription, getDescription, getExpirationMillis, getExpire, getHandle, getID, getImage, getImage, getInstance, getName, getPortletConfig, getTitle, getTitle, isCacheable, isClosed, isMinimized, isShowTitleBar, providesCustomization, setAttribute, setCacheable, setCachedObject, setClosed, setContent, setContent, setContent, setCreationTime, setDescription, setExpirationMillis, setHandle, setID, setImage, setMinimized, setName, setPortletConfig, setTitle, setTitle, supportsType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

rewriter

protected HTMLRewriter rewriter

initDone

protected boolean initDone

contentStale

protected boolean contentStale

cacheContent

protected boolean cacheContent

username

protected java.lang.String username

password

protected java.lang.String password
Constructor Detail

WebPagePortlet

public WebPagePortlet()
Method Detail

init

public void init()
          throws PortletException
Initialize this portlet by defining a HTML rewriter.

Specified by:
init in interface Portlet
Overrides:
init in class AbstractPortlet
Throws:
PortletException - Initialization failed

getReader

protected java.io.Reader getReader(java.lang.String url)
                            throws java.io.IOException
took this from FileServerPortlet as it was private

Throws:
java.io.IOException

getContent

public org.apache.ecs.ConcreteElement getContent(org.apache.turbine.util.RunData data)
This methods outputs the content of the portlet for a given request.

Specified by:
getContent in interface Portlet
Overrides:
getContent in class AbstractPortlet
Parameters:
data - the RunData object for the request
Returns:
the content to be displayed to the user-agent

refresh

public void refresh()
Usually called by caching system when portlet is marked as expired, but has not be idle longer then TimeToLive. Any cached content that is expired need to be refreshed.

Specified by:
refresh in interface org.apache.turbine.services.cache.Refreshable
Overrides:
refresh in class AbstractPortlet

selectUrl

protected java.lang.String selectUrl(org.apache.turbine.util.RunData data,
                                     PortletConfig config)
Select the URL to use for this portlet.

Returns:
The URL to use for this portlet


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.