com.gentics.cr.portlet

Class BaseContentPortlet

java.lang.Object

javax.portlet.GenericPortlet

com.gentics.cr.portlet.AGenticsPortlet

com.gentics.cr.portlet.AContentDisplayPortlet

com.gentics.cr.portlet.BaseContentPortlet

All Implemented Interfaces:

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

public class BaseContentPortlet
extends AContentDisplayPortlet

The Class BaseContentPortlet.

Field Summary

Fields

Modifier and Type	Field and Description
private CCPortletConfig	crSearchConf The cr search conf.
static String	MODE_CONTENT The Constant MODE_CONTENT.
static String	MODE_NAME The Constant MODE_NAME.
static String	MODE_SEARCH The Constant MODE_SEARCH.
private static String	SEARCHCONFIGNAME_CONFIG_KEY The Constant SEARCHCONFIGNAME_CONFIG_KEY.
private static String	SEARCHCONFIGNAME_DEFAULT The Constant SEARCHCONFIGNAME_DEFAULT.
private RESTSimpleStreamContainer	searchContainer The search_container.
private static String	SEARCHTERM_BUILDER_CLASS_KEY
private SearchTermBuilder	searchTermBuilder
private String	searchtermBuilderClass
private Class<?>	searchTermBuilderClazz

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

attributes, ATTRIBUTES_KEY, downloadMimetypes, ISVELOCITYRENDERED_KEY, vEngine

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, TEMPLATE_CACHEZONE_KEY, TEMPLATECACHE_CONFIG_KEY

Constructor Summary

Constructors

Constructor and Description
BaseContentPortlet()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
void	doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected void	doInternalView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) Do internal view.
protected void	handleError(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, javax.portlet.PortletException exception) Handle error.
protected void	initialize() the portlet instance initialize method.
private void	prepareSearchResponse(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) Prepare search response.
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
void	processEvent(javax.portlet.EventRequest request, javax.portlet.EventResponse response)

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

dispatch, doView, executeVelocityRender, getRp, prepareDisplayResponse, serveResource

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

getContentid, getCrConf, getLog, getStartfolder, getStartpage, getTemplate, init, setCrConf, setLog

Methods inherited from class javax.portlet.GenericPortlet

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

Methods inherited from class java.lang.Object

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

Field Detail

SEARCHCONFIGNAME_DEFAULT

private static final String SEARCHCONFIGNAME_DEFAULT

The Constant SEARCHCONFIGNAME_DEFAULT.

See Also:

Constant Field Values

SEARCHCONFIGNAME_CONFIG_KEY

private static final String SEARCHCONFIGNAME_CONFIG_KEY

The Constant SEARCHCONFIGNAME_CONFIG_KEY.

See Also:

Constant Field Values

SEARCHTERM_BUILDER_CLASS_KEY

private static final String SEARCHTERM_BUILDER_CLASS_KEY

See Also:

Constant Field Values

searchtermBuilderClass

private String searchtermBuilderClass

searchTermBuilderClazz

private Class<?> searchTermBuilderClazz

MODE_NAME

public static final String MODE_NAME

The Constant MODE_NAME.

See Also:

Constant Field Values

MODE_CONTENT

public static final String MODE_CONTENT

The Constant MODE_CONTENT.

See Also:

Constant Field Values

MODE_SEARCH

public static final String MODE_SEARCH

The Constant MODE_SEARCH.

See Also:

Constant Field Values

searchContainer

private RESTSimpleStreamContainer searchContainer

The search_container.

crSearchConf

private CCPortletConfig crSearchConf

The cr search conf.

searchTermBuilder

private SearchTermBuilder searchTermBuilder

Constructor Detail

BaseContentPortlet

public BaseContentPortlet()

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

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

Overrides:

initialize in class AContentDisplayPortlet

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 AContentDisplayPortlet

Throws:

javax.portlet.PortletException

IOException

processEvent

public final void processEvent(javax.portlet.EventRequest request,
                javax.portlet.EventResponse response)
                        throws javax.portlet.PortletException,
                               IOException

Specified by:

processEvent in interface javax.portlet.EventPortlet

Overrides:

processEvent in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

doEdit

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

Overrides:

doEdit in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

handleError

protected void handleError(javax.portlet.RenderRequest request,
               javax.portlet.RenderResponse response,
               javax.portlet.PortletException exception)
                    throws javax.portlet.PortletException

Description copied from class: AContentDisplayPortlet

Handle error.

Specified by:

handleError in class AContentDisplayPortlet

Parameters:

request - the request

response - the response

exception - the exception

Throws:

javax.portlet.PortletException

doInternalView

protected void doInternalView(javax.portlet.RenderRequest request,
                  javax.portlet.RenderResponse response)
                       throws javax.portlet.PortletException,
                              IOException

Description copied from class: AContentDisplayPortlet

Do internal view. TODO

TODO

Specified by:

doInternalView in class AContentDisplayPortlet

Parameters:

request - the request

response - the response

Throws:

javax.portlet.PortletException - the portlet exception

IOException - Signals that an I/O exception has occurred.

prepareSearchResponse

private void prepareSearchResponse(javax.portlet.RenderRequest request,
                         javax.portlet.RenderResponse response)
                            throws IOException

Prepare search response.

Parameters:

request - the request

response - the response

Throws:

IOException - Signals that an I/O exception has occurred.

destroy

public void destroy()

Specified by:

destroy in interface javax.portlet.Portlet

Overrides:

destroy in class javax.portlet.GenericPortlet