net.sf.portions.controller
Class PortletController

java.lang.Object
  extended byjavax.portlet.GenericPortlet
      extended bynet.sf.portions.controller.PortletController
All Implemented Interfaces:
javax.portlet.Portlet, javax.portlet.PortletConfig

public class PortletController
extends javax.portlet.GenericPortlet

Controlador del framework Portions, el cual implementa el patrón MVC (Modelo-Vista-Controlador) para Portlets JSR-168. Este controlador se configura a través del fichero de configuración /WEB-INF/portlet-config.xml. A continuación se muestra un ejemplo del contenido de este fichero:

 <?xml version="1.0" encoding="UTF-8"?>
 <portlet-config>
  <form-beans>
   <form-bean name="patronForm" 
       type="net.sf.portions.sample.form.PatronPortletForm" />
   <form-bean name="idForm"
       type="net.sf.portions.sample.form.IdPortletForm" />
  </form-beans>
  <global-forwards>
   <forward name="success"
       mode="view" 
       path="/jsp/view_1.jsp" 
       content="text/html"/>
   <forward name="failure"
       mode="view" 
       path="/jsp/view_1.jsp" 
       content="text/html"/>
   <forward name="success"
       mode="edit" 
       path="/jsp/edit.jsp" 
       content="text/html"/>
   <forward name="failure"
       mode="edit" 
       path="/jsp/edit.jsp" 
       content="text/html"/>
   <forward name="success"
       mode="help" 
       path="/jsp/help.jsp" 
       content="text/html"/>
   <forward name="failure"
       mode="help" 
       path="/jsp/help.jsp" 
       content="text/html"/>
  </global-forwards>
  <action-mappings>	
   <action name="step1"
       type="net.sf.portions.sample.action.Step1PortletAction">
    <forward name="success"
        mode="view" 
        path="/jsp/view_1.jsp" 
        content="text/html"/>
   </action>
   <action name="step2"
       type="net.sf.portions.sample.action.Step2PortletAction"
       input="/jsp/view_1.jsp"
       content="text/html"
       formName="patronForm"
       scope="request">
    <forward name="success"
        mode="view" 
        path="/jsp/view_2.jsp" 
        content="text/html"/>
   </action>
   <!-- ... -->
  </action-mappings>
  <message-resources parameter="resources.ApplicationResources" />
  <plug-in className="net.sf.portions.validator.ValidatorPlugIn">
   <set-property property="pathnames" value="/WEB-INF/validation.xml"/>
  </plug-in>
 </portlet-config>
 

Version:
1.0 01 Jan 2007
Author:
Raúl Herranz

Field Summary
protected  org.apache.commons.logging.Log log
          Log de la clase
 
Fields inherited from class javax.portlet.GenericPortlet
 
Constructor Summary
PortletController()
           
 
Method Summary
protected  void doEdit(Forward forward, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
          Muestra el modo edit del portlet
protected  void doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
protected  void doHelp(Forward forward, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
          Muestra el modo help del portlet
protected  void doHelp(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
private  void doRender(Forward forward, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, java.lang.String mode, java.lang.String name)
          Muestra el modo indicado del portlet
protected  void doView(Forward forward, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
          Muestra el modo view del portlet
protected  void doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
protected  Forward getActualForward(javax.portlet.PortletRequest request)
          Permite obtener el forward actual al que debe pasarse el control
 void init(javax.portlet.PortletConfig config)
          Realiza las tareas de inicialización del controlador, que incluyen el realizar una llamada al método init de la clase ConfigHelper para cargar los datos de configuración del fichero /WEB-INF/portlet-config.xml
 void processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
          Procesa una petición de acción al portlet.
 
Methods inherited from class javax.portlet.GenericPortlet
destroy, doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init, render
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected org.apache.commons.logging.Log log
Log de la clase

Constructor Detail

PortletController

public PortletController()
Method Detail

init

public void init(javax.portlet.PortletConfig config)
          throws javax.portlet.PortletException
Realiza las tareas de inicialización del controlador, que incluyen el realizar una llamada al método init de la clase ConfigHelper para cargar los datos de configuración del fichero /WEB-INF/portlet-config.xml

Throws:
javax.portlet.PortletException
See Also:
GenericPortlet.init()

doView

protected final void doView(javax.portlet.RenderRequest request,
                            javax.portlet.RenderResponse response)
                     throws javax.portlet.PortletException,
                            java.io.IOException
Throws:
javax.portlet.PortletException
java.io.IOException
See Also:
GenericPortlet.doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)

doEdit

protected final void doEdit(javax.portlet.RenderRequest request,
                            javax.portlet.RenderResponse response)
                     throws javax.portlet.PortletException,
                            java.io.IOException
Throws:
javax.portlet.PortletException
java.io.IOException
See Also:
GenericPortlet.doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)

doHelp

protected final void doHelp(javax.portlet.RenderRequest request,
                            javax.portlet.RenderResponse response)
                     throws javax.portlet.PortletException,
                            java.io.IOException
Throws:
javax.portlet.PortletException
java.io.IOException
See Also:
GenericPortlet.doHelp(javax.portlet.RenderRequest, javax.portlet.RenderResponse)

doView

protected void doView(Forward forward,
                      javax.portlet.RenderRequest request,
                      javax.portlet.RenderResponse response)
               throws javax.portlet.PortletException,
                      java.io.IOException
Muestra el modo view del portlet

Parameters:
forward - Forward con los datos de configuración
request - La petición que se está procesando
response - La respuesta que se está creando
Throws:
javax.portlet.PortletException - Si no es posible procesar la petición
java.io.IOException - Si ocurre algún problema en la E/S

doEdit

protected void doEdit(Forward forward,
                      javax.portlet.RenderRequest request,
                      javax.portlet.RenderResponse response)
               throws javax.portlet.PortletException,
                      java.io.IOException
Muestra el modo edit del portlet

Parameters:
forward - Forward con los datos de configuración
request - La petición que se está procesando
response - La respuesta que se está creando
Throws:
javax.portlet.PortletException - Si no es posible procesar la petición
java.io.IOException - Si ocurre algún problema en la E/S

doHelp

protected void doHelp(Forward forward,
                      javax.portlet.RenderRequest request,
                      javax.portlet.RenderResponse response)
               throws javax.portlet.PortletException,
                      java.io.IOException
Muestra el modo help del portlet

Parameters:
forward - Forward con los datos de configuración
request - La petición que se está procesando
response - La respuesta que se está creando
Throws:
javax.portlet.PortletException - Si no es posible procesar la petición
java.io.IOException - Si ocurre algún problema en la E/S

doRender

private void doRender(Forward forward,
                      javax.portlet.RenderRequest request,
                      javax.portlet.RenderResponse response,
                      java.lang.String mode,
                      java.lang.String name)
               throws javax.portlet.PortletException,
                      java.io.IOException
Muestra el modo indicado del portlet

Parameters:
forward - Forward con los datos de configuración
request - La petición que se está procesando
response - La respuesta que se está creando
Throws:
javax.portlet.PortletException - Si no es posible procesar la petición
java.io.IOException - Si ocurre algún problema en la E/S

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          java.io.IOException
Procesa una petición de acción al portlet.

Throws:
javax.portlet.PortletException
java.io.IOException
See Also:
GenericPortlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)

getActualForward

protected Forward getActualForward(javax.portlet.PortletRequest request)
Permite obtener el forward actual al que debe pasarse el control

Parameters:
request - La petición que se está procesando
Returns:
Datos del forward al que se pasará el control