org.apache.portals.applications.webcontent2.portlet

Class WebContentPortlet

java.lang.Object

javax.portlet.GenericPortlet

org.apache.portals.bridges.common.GenericServletPortlet

org.apache.portals.bridges.velocity.GenericVelocityPortlet

org.apache.portals.applications.webcontent2.portlet.WebContentPortlet

All Implemented Interfaces:

javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

public class WebContentPortlet
extends org.apache.portals.bridges.velocity.GenericVelocityPortlet

WebContentPortlet * WebContentPortlet Allows navigation inside the portlet and caches the latest URL TODO: Preferences, cache stream instead of URL *

Version:

$Id: WebContentPortlet.java 891414 2009-12-16 20:19:02Z rwatler $

Author:

Roger Ruttimann

Field Summary

Fields

Modifier and Type	Field and Description
static String	BROWSER_ACTION_NEXT_PAGE
static String	BROWSER_ACTION_PARAM
static String	BROWSER_ACTION_PREVIOUS_PAGE
static String	BROWSER_ACTION_REFRESH_PAGE
static String	EDIT_SOURCE_PARAM
static String	FORM_MULTIPART_METHOD
static String	HISTORY
static String	HTTP_STATE
protected static org.slf4j.Logger	log
static String	NO_URL
static String	VIEW_SOURCE_PARAM Configuration constants.

Fields inherited from class org.apache.portals.bridges.velocity.GenericVelocityPortlet

PORTLET_BRIDGE_CONTEXT

Fields inherited from class org.apache.portals.bridges.common.GenericServletPortlet

allowPreferences, defaultActionPage, defaultCustomPage, defaultEditPage, defaultHelpPage, defaultViewPage, PARAM_ACTION_PAGE, PARAM_ALLOW_PREFERENCES, PARAM_CUSTOM_PAGE, PARAM_EDIT_PAGE, PARAM_HELP_PAGE, PARAM_MAX_PAGE, PARAM_VIEW_PAGE

Constructor Summary

Constructors

Constructor and Description
WebContentPortlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpRequestBase	createHttpRequest(org.apache.http.impl.client.CloseableHttpClient client, String method, String uri, Map<String,String[]> queryParams, Map<String,String[]> formPostParams, javax.portlet.RenderRequest request)
protected Rewriter	createRewriter(javax.portlet.PortletRequest request, RewriterController rewriterController, Ruleset ruleset)
void	doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected byte[]	doHttpWebContent(org.apache.http.impl.client.CloseableHttpClient httpClient, org.apache.http.client.CookieStore cookieStore, org.apache.http.client.methods.HttpRequestBase httpRequest, int retryCount, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, WebContentRewriter rewriter)
protected byte[]	doPreemptiveAuthentication(org.apache.http.impl.client.CloseableHttpClient client, org.apache.http.client.CookieStore cookieStore, org.apache.http.client.methods.HttpRequestBase httpRequest, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected boolean	doRequestedAuthentication(org.apache.http.impl.client.CloseableHttpClient client, org.apache.http.client.CookieStore cookieStore, org.apache.http.client.methods.HttpRequestBase httpRequest, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
void	doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) doView Renders the URL in the following order 1) SESSION_PARAMETER 2)cached version 3) defined for preference SRC
protected byte[]	doWebContent(String method, String sourceAttr, Map sourceParams, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected org.apache.http.impl.client.CloseableHttpClient	getHttpClient(javax.portlet.RenderRequest request, org.apache.http.client.CookieStore cookieStore)
protected org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder(javax.portlet.PortletRequest request, org.apache.http.client.CookieStore cookieStore)
protected org.apache.http.client.protocol.HttpClientContext	getHttpClientContext(javax.portlet.PortletRequest request, org.apache.http.client.methods.HttpRequestBase httpRequest) Override this method to give a custom HttpClientContext when executing HttpClient.
protected RewriterController	getRewriterController(String contextPath)
void	init(javax.portlet.PortletConfig config) Initialize portlet configuration.
void	processAction(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse) processAction() Checks action initiated by the WebContent portlet which means that a user has clicked on an URL

Methods inherited from class org.apache.portals.bridges.velocity.GenericVelocityPortlet

doCustom, doHelp, doPreferencesEdit, getContext, getContext, render, setupPreferencesEdit

Methods inherited from class org.apache.portals.bridges.common.GenericServletPortlet

getDefaultActionPage, getDefaultCustomPage, getDefaultEditPage, getDefaultHelpPage, getDefaultViewPage, processPreferencesAction, setDefaultActionPage, setDefaultCustomPage, setDefaultEditPage, setDefaultHelpPage, setDefaultViewPage

Methods inherited from class javax.portlet.GenericPortlet

destroy, doDispatch, doHeaders, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, processEvent, serveResource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VIEW_SOURCE_PARAM

public static final String VIEW_SOURCE_PARAM

Configuration constants.

See Also:

Constant Field Values

EDIT_SOURCE_PARAM

public static final String EDIT_SOURCE_PARAM

See Also:

Constant Field Values

BROWSER_ACTION_PARAM

public static final String BROWSER_ACTION_PARAM

See Also:

Constant Field Values

BROWSER_ACTION_PREVIOUS_PAGE

public static final String BROWSER_ACTION_PREVIOUS_PAGE

See Also:

Constant Field Values

BROWSER_ACTION_REFRESH_PAGE

public static final String BROWSER_ACTION_REFRESH_PAGE

See Also:

Constant Field Values

BROWSER_ACTION_NEXT_PAGE

public static final String BROWSER_ACTION_NEXT_PAGE

See Also:

Constant Field Values

HISTORY

public static final String HISTORY

See Also:

Constant Field Values

HTTP_STATE

public static final String HTTP_STATE

See Also:

Constant Field Values

log

protected static final org.slf4j.Logger log

FORM_MULTIPART_METHOD

public static final String FORM_MULTIPART_METHOD

See Also:

Constant Field Values

NO_URL

public static final String NO_URL

See Also:

Constant Field Values

Constructor Detail

WebContentPortlet

public WebContentPortlet()

Method Detail

init

public void init(javax.portlet.PortletConfig config)
          throws javax.portlet.PortletException

Initialize portlet configuration.

Specified by:

init in interface javax.portlet.Portlet

Overrides:

init in class org.apache.portals.bridges.velocity.GenericVelocityPortlet

Throws:

javax.portlet.PortletException

processAction

public void processAction(javax.portlet.ActionRequest actionRequest,
                 javax.portlet.ActionResponse actionResponse)
                   throws javax.portlet.PortletException,
                          IOException

processAction() Checks action initiated by the WebContent portlet which means that a user has clicked on an URL

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class org.apache.portals.bridges.velocity.GenericVelocityPortlet

Parameters:

actionRequest -

actionResponse -

Throws:

javax.portlet.PortletException

IOException

doView

public void doView(javax.portlet.RenderRequest request,
          javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   IOException

doView Renders the URL in the following order 1) SESSION_PARAMETER 2)cached version 3) defined for preference SRC

Overrides:

doView in class org.apache.portals.bridges.velocity.GenericVelocityPortlet

Throws:

javax.portlet.PortletException

IOException

doEdit

public void doEdit(javax.portlet.RenderRequest request,
          javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   IOException

Overrides:

doEdit in class org.apache.portals.bridges.velocity.GenericVelocityPortlet

Throws:

javax.portlet.PortletException

IOException

doWebContent

protected byte[] doWebContent(String method,
                  String sourceAttr,
                  Map sourceParams,
                  javax.portlet.RenderRequest request,
                  javax.portlet.RenderResponse response)
                       throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

doHttpWebContent

protected byte[] doHttpWebContent(org.apache.http.impl.client.CloseableHttpClient httpClient,
                      org.apache.http.client.CookieStore cookieStore,
                      org.apache.http.client.methods.HttpRequestBase httpRequest,
                      int retryCount,
                      javax.portlet.RenderRequest request,
                      javax.portlet.RenderResponse response,
                      WebContentRewriter rewriter)
                           throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

doPreemptiveAuthentication

protected byte[] doPreemptiveAuthentication(org.apache.http.impl.client.CloseableHttpClient client,
                                org.apache.http.client.CookieStore cookieStore,
                                org.apache.http.client.methods.HttpRequestBase httpRequest,
                                javax.portlet.RenderRequest request,
                                javax.portlet.RenderResponse response)

doRequestedAuthentication

protected boolean doRequestedAuthentication(org.apache.http.impl.client.CloseableHttpClient client,
                                org.apache.http.client.CookieStore cookieStore,
                                org.apache.http.client.methods.HttpRequestBase httpRequest,
                                javax.portlet.RenderRequest request,
                                javax.portlet.RenderResponse response)

getRewriterController

protected RewriterController getRewriterController(String contextPath)
                                            throws Exception

Throws:

Exception

createRewriter

protected Rewriter createRewriter(javax.portlet.PortletRequest request,
                      RewriterController rewriterController,
                      Ruleset ruleset)
                           throws RewriterException

Throws:

RewriterException

getHttpClientBuilder

protected org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder(javax.portlet.PortletRequest request,
                                                                 org.apache.http.client.CookieStore cookieStore)

getHttpClient

protected org.apache.http.impl.client.CloseableHttpClient getHttpClient(javax.portlet.RenderRequest request,
                                                            org.apache.http.client.CookieStore cookieStore)
                                                                 throws IOException

Throws:

IOException

getHttpClientContext

protected org.apache.http.client.protocol.HttpClientContext getHttpClientContext(javax.portlet.PortletRequest request,
                                                                     org.apache.http.client.methods.HttpRequestBase httpRequest)

Override this method to give a custom HttpClientContext when executing HttpClient.

Parameters:

request -

Returns:

createHttpRequest

protected org.apache.http.client.methods.HttpRequestBase createHttpRequest(org.apache.http.impl.client.CloseableHttpClient client,
                                                               String method,
                                                               String uri,
                                                               Map<String,String[]> queryParams,
                                                               Map<String,String[]> formPostParams,
                                                               javax.portlet.RenderRequest request)
                                                                    throws IOException,
                                                                           URISyntaxException

Throws:

IOException

URISyntaxException