Keel 2.1RC2

org.keel.clients.cocoon
Class CocoonClientConnector

java.lang.Object
  extended byorg.keel.clients.AbstractClientConnector
      extended byorg.keel.clients.webapp.AbstractWebappClientConnector
          extended byorg.keel.clients.cocoon.CocoonClientConnector
All Implemented Interfaces:
ClientConnector, WebappClientConnector
Direct Known Subclasses:
FacesCocoonClientConnector

public class CocoonClientConnector
extends AbstractWebappClientConnector

The glue to connect Cocoon to Keel

Version:
$Revision: 1.5 $ $Date: 2004/05/11 20:44:19 $
Author:
Michael Nash, Schatterjee Created on May 24, 2003

Field Summary
protected  Configuration config
           
protected  Request creq
           
protected  Response cres
           
protected  java.lang.String model
           
protected  java.lang.String root
           
 
Fields inherited from class org.keel.clients.webapp.AbstractWebappClientConnector
COMMAND_PARAM, COMMAND_PARAM_LEN, initParamsParsed, KEEL_MODEL_PARAM, MODEL_PARAM, PARAMETER_PARAM
 
Fields inherited from class org.keel.clients.AbstractClientConnector
clientContext, log, myClients
 
Constructor Summary
CocoonClientConnector()
           
 
Method Summary
 KeelResponse execute()
          Run the business model, using a request/response pair The description sounds curious since the method doesn't take a request as an argument! This is because although most webapps use the HttpServletRequest/HttpServletResponse pair, some, particularly Cocoon, do not and use their own abstraction.
 java.lang.String getForward(KeelResponse kres)
          Determine a string that tells the client where to navigate next
 void setConfiguration(Configuration config)
           
 void setModel(java.lang.String model)
           
 void setRequest(Request creq)
           
 void setResponse(Response cres)
           
 void setRoot(java.lang.String newRoot)
           
 
Methods inherited from class org.keel.clients.webapp.AbstractWebappClientConnector
createRequest, execute, getWebappPath, makeKeelRequest, makeWebappResponse, parseInitParameters, preProcessParamName, processCommandParam, processNonCommandParam, setRequestAttributes, setRequestCookies, setRequestModel, setRequestParameters, setResponseCookies
 
Methods inherited from class org.keel.clients.AbstractClientConnector
createClients, execute, getClient, removeClient, setContext, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.keel.clients.ClientConnector
execute, setContext, setLogger
 

Field Detail

creq

protected Request creq

cres

protected Response cres

config

protected Configuration config

model

protected java.lang.String model

root

protected java.lang.String root
Constructor Detail

CocoonClientConnector

public CocoonClientConnector()
Method Detail

setRequest

public void setRequest(Request creq)

setResponse

public void setResponse(Response cres)

setConfiguration

public void setConfiguration(Configuration config)

setRoot

public void setRoot(java.lang.String newRoot)

setModel

public void setModel(java.lang.String model)

execute

public KeelResponse execute()
                     throws ClientException,
                            ModelException
Description copied from interface: WebappClientConnector
Run the business model, using a request/response pair The description sounds curious since the method doesn't take a request as an argument! This is because although most webapps use the HttpServletRequest/HttpServletResponse pair, some, particularly Cocoon, do not and use their own abstraction. So, the method preferred here, is that the WebappClientConnector implementation will pass in the the appropriate request/response and other paramters in the constructor and use those during the execution of this method. See org.keel.clients.struts.StrutsClientConnector and org.keel.clients.cocoon.CocoocClientConnector for examples.

Returns:
The Keel response
Throws:
ModelException
ClientException
See Also:
org.keel.clients.webapp.WebappClientConnector#execute(org.keel.clients.webapp.WebappRequest, org.keel.clients.webapp.WebappResponse, java.lang.String)

getForward

public java.lang.String getForward(KeelResponse kres)
Description copied from interface: WebappClientConnector
Determine a string that tells the client where to navigate next

Parameters:
kres - The Keel response returned by execute()
Returns:
See Also:
org.keel.clients.webapp.WebappClientConnector#getForward()

Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.