org.apache.cocoon.acting
Interface Action

All Superinterfaces:

Component

All Known Implementing Classes:

AbstractAction, AbstractAuthAction, AbstractComplementaryConfigurableAction, AbstractConfigurableAction, AbstractDatabaseAction, AbstractFormsAction, AbstractMultiAction, AbstractValidatorAction, AbstractWoodyAction, AuthAction, AuthAction, BookmarkAction, CacheEventAction, CheckAccessAction, ClearCacheAction, ClearPersistentStoreAction, ComposerAction, ConfigurableComposerAction, ConfigurableServiceableAction, CopletSetDataAction, CopySourceAction, DatabaseAction, DatabaseAddAction, DatabaseAddAction, DatabaseAuthenticatorAction, DatabaseCookieAuthenticatorAction, DatabaseDeleteAction, DatabaseDeleteAction, DatabaseQueryAction, DatabaseSelectAction, DatabaseSelectAction, DatabaseUpdateAction, DatabaseUpdateAction, DbXMLAuthenticatorAction, FacesAction, FormManagerAction, FormValidatorAction, GetContinuationAction, HandleFormSubmitAction, HandleFormSubmitAction, HelloAction, HttpCacheAction, HttpHeaderAction, InitForm1Action, InitForm1Action, InputModuleAction, JMSPublisherAction, LocaleAction, LoggedInAction, LoggedInAction, LoginAction, LoginAction, LoginAction, LogoutAction, LogoutAction, LogoutAction, MailAction, MakeFormAction, MakeFormAction, ObjectModelAction, OraAddAction, OraUpdateAction, PreemptiveLoaderAction, PreparePortalAction, PropagatorAction, RequestParamAction, RequestParameterExistsAction, ResourceExistsAction, SaveAction, ScriptAction, Sendmail, SendmailAction, ServerPagesAction, ServiceableAction, SessionAction, SessionFormAction, SessionInvalidatorAction, SessionIsValidAction, SessionPropagatorAction, SessionStateAction, SessionValidatorAction, SetCharacterEncodingAction, SetterAction, TagtestAction, URLAction

public interface Action
extends Component

Version:

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

Author:

Giacomo Pati

Field Summary

static String

ROLE

Method Summary

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

Field Detail

ROLE

static final String ROLE

Method Detail

act

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

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.

Parameters:

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

parameters - 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