com.gentics.cr.portlet
Class BaseNavigationPortlet

java.lang.Object
  javax.portlet.GenericPortlet
      com.gentics.cr.portlet.AGenticsPortlet
          com.gentics.cr.portlet.BaseNavigationPortlet

All Implemented Interfaces:

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

public class BaseNavigationPortlet
extends AGenticsPortlet

The Class BaseNavigationPortlet.

Field Summary

private String[]	attributes The attributes.
private static org.apache.jcs.JCS	cache
private static String	CACHEZONE_KEY Key for the cache zone
static String	NAVIGATIONCACHE_CONFIG_KEY configuration key for enabling (default) or disabling the JCS content cache.
static String	NAVIGATIONCACHE_CONFIG_TIME_KEY key for the caching time
private static String	ROOT_ATTRIBUTE_KEY
private String	rootAttribute
private com.gentics.cr.RequestProcessor	rp The request processor.
private com.gentics.cr.template.ITemplate	template
private static String	TEMPLATE_PATH_KEY
private String	tmplPath The tmpl path.
private com.gentics.cr.util.velocity.VelocityTools	tools VelocityTools to deploy into the template context.

Fields inherited from class com.gentics.cr.portlet.AGenticsPortlet

CONTENTID_OVERRIDE_ATTRIBUTE, CONTENTID_RENDER_PARAMETER, INITPARAM_EDITTEMPLATE_NAME, INITPARAM_STARTFOLDER_NAME, INITPARAM_STARTPAGE_NAME, INITPARAM_VIEWTEMPLATE_NAME, log, PAGE_RULE

Constructor Summary

BaseNavigationPortlet()

Method Summary

void	doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
private Collection<String>	getActivePath(Collection<com.gentics.cr.CRResolvableBean> coll, String active) Gets the active path.
private Collection<com.gentics.cr.CRResolvableBean>	getNavigationObject(String startFolder) This method fetches the navigation object from the Request Processor and handles the caching when configured.
protected void	initialize() the portlet instance initialize method.

Methods inherited from class com.gentics.cr.portlet.AGenticsPortlet

getContentid, getCrConf, getFileTemplate, getLog, getStartfolder, getStartpage, init, processAction, setCrConf, setLog

Methods inherited from class javax.portlet.GenericPortlet

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

Methods inherited from class java.lang.Object

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

Field Detail

CACHEZONE_KEY

private static final String CACHEZONE_KEY

Key for the cache zone

See Also:

Constant Field Values

NAVIGATIONCACHE_CONFIG_KEY

public static final String NAVIGATIONCACHE_CONFIG_KEY

configuration key for enabling (default) or disabling the JCS content cache. Default: disabled

See Also:

Constant Field Values

NAVIGATIONCACHE_CONFIG_TIME_KEY

public static final String NAVIGATIONCACHE_CONFIG_TIME_KEY

key for the caching time

See Also:

Constant Field Values

TEMPLATE_PATH_KEY

private static final String TEMPLATE_PATH_KEY

See Also:

Constant Field Values

ROOT_ATTRIBUTE_KEY

private static final String ROOT_ATTRIBUTE_KEY

See Also:

Constant Field Values

rootAttribute

private String rootAttribute

rp

private com.gentics.cr.RequestProcessor rp

The request processor.

tmplPath

private String tmplPath

The tmpl path.

template

private com.gentics.cr.template.ITemplate template

tools

private com.gentics.cr.util.velocity.VelocityTools tools

VelocityTools to deploy into the template context.

attributes

private String[] attributes

The attributes.

cache

private static org.apache.jcs.JCS cache

Constructor Detail

BaseNavigationPortlet

public BaseNavigationPortlet()

Method Detail

initialize

protected void initialize()

Description copied from class: AGenticsPortlet

the portlet instance initialize method.

in this method every kind of Gentics portlet can initialize its own connectors and helpers

please remeber! Always call super.init(); if you override this method!

This method is called exact once on portlet init.

Please use this method if you have to initialize components within your portlet instance (E.g. connectors, helper classes etc.)

Specified by:

initialize in class AGenticsPortlet

doView

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

Overrides:

doView in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

getNavigationObject

private Collection<com.gentics.cr.CRResolvableBean> getNavigationObject(String startFolder)
                                                                 throws com.gentics.cr.exceptions.CRException,
                                                                        javax.portlet.PortletException

This method fetches the navigation object from the Request Processor and handles the caching when configured.

Parameters:

startFolder - the folder for which the navigation should be builded

Returns:

Collection the navigation object

Throws:

com.gentics.cr.exceptions.CRException

javax.portlet.PortletException

getActivePath

private Collection<String> getActivePath(Collection<com.gentics.cr.CRResolvableBean> coll,
                                         String active)

Gets the active path.

Parameters:

coll - the coll

active - the active

Returns:

the active path