org.apache.cocoon.portal.acting
Class BookmarkAction

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
          org.apache.cocoon.acting.ServiceableAction
              org.apache.cocoon.portal.acting.BookmarkAction

All Implemented Interfaces:

Component, LogEnabled, Parameterizable, Serviceable, ThreadSafe, Action

public class BookmarkAction
extends ServiceableAction
implements ThreadSafe, Parameterizable

This action helps you in creating bookmarks The definition file is: tagetId layout|coplet copletId layoutId

Version:

CVS $Id: BookmarkAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler

Field Summary

protected String	configurationFile
protected Map	eventMap
protected String	historyParameterName
protected SourceValidity	oldValidity
protected boolean	reloadCheck

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

BookmarkAction()

Method Summary

Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters par) Controls the processing against some values of the Dictionary objectModel and returns a Map object with values used in subsequent sitemap substitution patterns.
void	parameterize(Parameters parameters)

Methods inherited from class org.apache.cocoon.acting.ServiceableAction

service

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

eventMap

protected Map eventMap

historyParameterName

protected String historyParameterName

configurationFile

protected String configurationFile

oldValidity

protected SourceValidity oldValidity

reloadCheck

protected boolean reloadCheck

Constructor Detail

BookmarkAction

public BookmarkAction()

Method Detail

parameterize

public void parameterize(Parameters parameters)
                  throws ParameterException

Specified by:

parameterize in interface Parameterizable

Throws:

ParameterException

See Also:

Parameterizable.parameterize(org.apache.avalon.framework.parameters.Parameters)

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters par)
        throws Exception

Description copied from interface: Action

Controls the processing against some values of the Dictionary objectModel and returns a Map object with values used in subsequent sitemap substitution patterns. NOTE: This interface is designed so that implentations can be ThreadSafe. When an action is ThreadSafe, only one instance serves all requests : this reduces memory usage and avoids pooling.

Specified by:

act in interface Action

resolver - The SourceResolver in charge

objectModel - The Map with object of the calling environment which can be used to select values this controller may need (ie Request, Response).

source - A source String to the Action

par - The Parameters for this invocation

Returns:

Map The returned Map object with sitemap substitution values which can be used in subsequent elements attributes like src= using a xpath like expression: src="mydir/{myval}/foo" If the return value is null the processing inside the element of the sitemap will be skipped.

Throws:

Exception - Indicates something is totally wrong

See Also:

Action.act(org.apache.cocoon.environment.Redirector, org.apache.cocoon.environment.SourceResolver, java.util.Map, java.lang.String, org.apache.avalon.framework.parameters.Parameters)