com.gentics.cr.portlet

Class AGenticsPortlet

java.lang.Object

javax.portlet.GenericPortlet

com.gentics.cr.portlet.AGenticsPortlet

All Implemented Interfaces:

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

Direct Known Subclasses:

AContentDisplayPortlet, BaseNavigationPortlet, BaseSearchPortlet

public abstract class AGenticsPortlet
extends javax.portlet.GenericPortlet

The Class AbstractGenticsPortlet.

This is the basic Gentics portlet abstract class that provides some basic features

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENTID_OVERRIDE_ATTRIBUTE The Constant CONTENTID_OVERRIDE_PARAMETER.
static String	CONTENTID_RENDER_PARAMETER The Constant CONTENTID_RENDER_PARAMETER.
private CCPortletConfig	crConf The Content Repository configuration.
static String	INITPARAM_EDITTEMPLATE_NAME The Constant INITPARAM_EDITTEMPLATE_NAME.
static String	INITPARAM_STARTFOLDER_NAME The Constant INITPARAM_STARTFOLDER_NAME.
static String	INITPARAM_STARTPAGE_NAME The Constant INITPARAM_STARTPAGE_NAME.
static String	INITPARAM_VIEWTEMPLATE_NAME The Constant INITPARAM_VIEWTAMPLATE_NAME.
protected org.apache.log4j.Logger	log the Logger.
static String	PAGE_RULE the Page Rule.
private String	startfolder the startfolder for this portlet instance.
private String	startpage the startpage for this portlet instance.
static String	TEMPLATE_CACHEZONE_KEY The Constant TEMPLATE_CACHEZONE_KEY.
private org.apache.jcs.JCS	templateCache the template cache
static String	TEMPLATECACHE_CONFIG_KEY configuration key for enabling or disabling the JCS template cache.

Constructor Summary

Constructors

Constructor and Description
AGenticsPortlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getContentid(javax.portlet.RenderRequest request) Returns the current contentid for the portlet.
protected CCPortletConfig	getCrConf() Gets the cr conf.
protected org.apache.log4j.Logger	getLog() Gets the log.
protected String	getStartfolder() Gets the startfolder.
protected String	getStartpage() Gets the startpage.
protected com.gentics.cr.template.ITemplate	getTemplate(String templatePath) Gets the File Template from configured Template path or from default template file path if left empty.
void	init()
protected abstract void	initialize() the portlet instance initialize method.
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
protected void	setCrConf(CCPortletConfig crConfig) Sets the cr conf.
protected void	setLog(org.apache.log4j.Logger logger) Sets the log.
private void	setStartfolder(String sf) Sets the startfolder.
private void	setStartpage(String sp) Sets the startpage.

Methods inherited from class javax.portlet.GenericPortlet

destroy, doDispatch, doEdit, doHeaders, doHelp, doView, 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

INITPARAM_STARTPAGE_NAME

public static final String INITPARAM_STARTPAGE_NAME

The Constant INITPARAM_STARTPAGE_NAME.

See Also:

Constant Field Values

INITPARAM_STARTFOLDER_NAME

public static final String INITPARAM_STARTFOLDER_NAME

The Constant INITPARAM_STARTFOLDER_NAME.

See Also:

Constant Field Values

INITPARAM_VIEWTEMPLATE_NAME

public static final String INITPARAM_VIEWTEMPLATE_NAME

The Constant INITPARAM_VIEWTAMPLATE_NAME.

See Also:

Constant Field Values

INITPARAM_EDITTEMPLATE_NAME

public static final String INITPARAM_EDITTEMPLATE_NAME

The Constant INITPARAM_EDITTEMPLATE_NAME.

See Also:

Constant Field Values

CONTENTID_RENDER_PARAMETER

public static final String CONTENTID_RENDER_PARAMETER

The Constant CONTENTID_RENDER_PARAMETER.

See Also:

Constant Field Values

CONTENTID_OVERRIDE_ATTRIBUTE

public static final String CONTENTID_OVERRIDE_ATTRIBUTE

The Constant CONTENTID_OVERRIDE_PARAMETER.

See Also:

Constant Field Values

TEMPLATECACHE_CONFIG_KEY

public static final String TEMPLATECACHE_CONFIG_KEY

configuration key for enabling or disabling the JCS template cache. Default: disabled

See Also:

Constant Field Values

TEMPLATE_CACHEZONE_KEY

public static final String TEMPLATE_CACHEZONE_KEY

The Constant TEMPLATE_CACHEZONE_KEY.

See Also:

Constant Field Values

PAGE_RULE

public static final String PAGE_RULE

the Page Rule. this is the page rule to find out, whether an object is a resource (image, css, js) or not.

See Also:

Constant Field Values

log

protected org.apache.log4j.Logger log

the Logger.

crConf

private CCPortletConfig crConf

The Content Repository configuration.

startfolder

private String startfolder

the startfolder for this portlet instance.

startpage

private String startpage

the startpage for this portlet instance.

templateCache

private org.apache.jcs.JCS templateCache

the template cache

Constructor Detail

AGenticsPortlet

public AGenticsPortlet()

Method Detail

init

public final void init()

Overrides:

init in class javax.portlet.GenericPortlet

initialize

protected abstract void initialize()

the portlet instance initialize method.

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

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.)

processAction

public void processAction(javax.portlet.ActionRequest request,
                 javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          IOException

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

getContentid

protected String getContentid(javax.portlet.RenderRequest request)
                       throws com.gentics.cr.exceptions.CRException

Returns the current contentid for the portlet. The first contentid found by checking the following will be returned:

1. Portlet Session Parameter [portletName]_contentid (which will be removed afterwards)
2. Render Request Parameter [portletName]_contentid
3. Render Request Parameter contentid
4. Default contentid configured for the portlet
5. Startpage configured for the portlet

Parameters:

request - the request

Returns:

the current contentid

Throws:

com.gentics.cr.exceptions.CRException

getTemplate

protected com.gentics.cr.template.ITemplate getTemplate(String templatePath)
                                                 throws FileNotFoundException,
                                                        com.gentics.cr.exceptions.CRException

Gets the File Template from configured Template path or from default template file path if left empty.

Parameters:

templatePath - the path of the template

Returns:

the FileTemplate

Throws:

FileNotFoundException - the file not found exception

com.gentics.cr.exceptions.CRException - the cR exception

getLog

protected org.apache.log4j.Logger getLog()

Gets the log.

Returns:

the log

setLog

protected void setLog(org.apache.log4j.Logger logger)

Sets the log.

Parameters:

logger - the new log

getCrConf

protected CCPortletConfig getCrConf()

Gets the cr conf.

Returns:

the cr conf

setCrConf

protected void setCrConf(CCPortletConfig crConfig)

Sets the cr conf.

Parameters:

crConfig - the new cr conf

getStartfolder

protected String getStartfolder()

Gets the startfolder.

Returns:

the startfolder

setStartfolder

private void setStartfolder(String sf)

Sets the startfolder.

Parameters:

sf - the new startfolder

getStartpage

protected String getStartpage()

Gets the startpage.

Returns:

the startpage

setStartpage

private void setStartpage(String sp)

Sets the startpage.

Parameters:

sp - the new startpage