org.apache.cocoon.faces
Class FacesAction

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.faces.FacesAction
All Implemented Interfaces:
Initializable, Component, Configurable, Contextualizable, LogEnabled, ThreadSafe, Action

public class FacesAction
extends AbstractLogEnabled
implements Action, ThreadSafe, Contextualizable, Configurable, Initializable

Version:
CVS $Id: FacesAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Vadim Gritsenko

Field Summary
static String REQUEST_REDIRECTOR_ATTRIBUTE
           
 
Fields inherited from interface org.apache.cocoon.acting.Action
ROLE
 
Constructor Summary
FacesAction()
           
 
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.
 void configure(Configuration configuration)
           
 void contextualize(Context avalonContext)
           
 void initialize()
           
 
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

REQUEST_REDIRECTOR_ATTRIBUTE

public static final String REQUEST_REDIRECTOR_ATTRIBUTE
See Also:
Constant Field Values
Constructor Detail

FacesAction

public FacesAction()
Method Detail

contextualize

public void contextualize(Context avalonContext)
                   throws ContextException
Specified by:
contextualize in interface Contextualizable
Throws:
ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException
Specified by:
configure in interface Configurable
Throws:
ConfigurationException

initialize

public void initialize()
                throws Exception
Specified by:
initialize in interface Initializable
Throws:
Exception

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        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
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


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.