net.sf.portions.action
Class ExtendedPortletAction

java.lang.Object
  net.sf.portions.action.PortletAction
      net.sf.portions.action.ExtendedPortletAction

Direct Known Subclasses:

ExistAttributePortletAction, ForwardPortletAction, RemoveAttributePortletAction

public abstract class ExtendedPortletAction

extends PortletAction

Clase base "extendida" de la jerarquía de Actions que implementa una máquina de estados.

Version:

1.0 01 Jan 2007

Author:

Raúl Herranz

Field Summary

protected Action	action Datos de configuración de la action
protected PortletForm	form El bean opcional, instancia de PortletForm, para la petición
protected javax.portlet.PortletRequest	request La petición que procesa la Action
protected javax.portlet.PortletResponse	response La respuesta que crea la Action

Fields inherited from class net.sf.portions.action.PortletAction

log

Constructor Summary

ExtendedPortletAction()

Method Summary

protected void	catchException(java.lang.Exception e) Encierra el tratamiento de cualquier excepción que se pueda lanzar durante la ejecución de la lógica de negocio de la Action.
Forward	execute(Action action, PortletForm form, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Método abstracto que deberán sobreescribir las Actions hijas para ejecutar sus propias tareas.
protected abstract void	executeLogic() Encierra la lógica de negocio de la Action.
protected Forward	findFailure() Retorna un Forward que redirecciona a una página de error.
private Forward	findForward(java.lang.String name) Retorna el Forward indicado mediante el atributo "name" del modo (view, edit o help) correspondiente.
protected Forward	findSuccess() Retorna un Forward que redirecciona a una página de éxito.
protected void	postProcess() Permite comprobar las postcondiciones que debe cumplir la Action.
protected void	preProcess() Permite comprobar las precondiciones que debe cumplir la Action.

Methods inherited from class net.sf.portions.action.PortletAction

findForward

Methods inherited from class java.lang.Object

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

Field Detail

action

protected Action action

Datos de configuración de la action

form

protected PortletForm form

El bean opcional, instancia de PortletForm, para la petición

request

protected javax.portlet.PortletRequest request

La petición que procesa la Action

response

protected javax.portlet.PortletResponse response

La respuesta que crea la Action

Constructor Detail

ExtendedPortletAction

public ExtendedPortletAction()

Method Detail

execute

public final Forward execute(Action action,
                             PortletForm form,
                             javax.portlet.PortletRequest request,
                             javax.portlet.PortletResponse response)
                      throws ExecuteActionException

Description copied from class: PortletAction

Método abstracto que deberán sobreescribir las Actions hijas para ejecutar sus propias tareas.

Specified by:

execute in class PortletAction

Parameters:

action - Datos de configuración de la action

form - El bean opcional, instancia de PortletForm, para la petición

request - La petición que se está procesando

response - La respuesta que se está creando

Returns:

Forward al que se le pasará el control

Throws:

ExecuteActionException - Si la ejecución del método provoca algún tipo de excepción

See Also:

PortletAction.execute(net.sf.portions.controller.configuration.Action, net.sf.portions.form.PortletForm, javax.portlet.PortletRequest, javax.portlet.PortletResponse)

preProcess

protected void preProcess()

Permite comprobar las precondiciones que debe cumplir la Action. En caso de que no se cumpla alguna precondición se debe dejar un registro de la incidencia mediante la creación de un mensaje. Esta acción provocará la redirección del flujo de ejecución hacia una página de error mediante la invocación del método findFailure().

executeLogic

protected abstract void executeLogic()
                              throws ExecuteActionException

Encierra la lógica de negocio de la Action. Éste método debe ser sobrescrito de forma obligatoria por aquellas Actions que hereden de la ExtendedPortletAction.

Throws:

ExecuteActionException - Si la ejecución del método provoca algún tipo de excepción

postProcess

protected void postProcess()

Permite comprobar las postcondiciones que debe cumplir la Action. En caso de que no se cumpla alguna postcondición se debe dejar un registro de la incidencia mediante la creación de un mensaje. Esta acción provocará la redirección del flujo de ejecución hacia una página de error mediante la invocación del método findFailure().

findFailure

protected Forward findFailure()

Retorna un Forward que redirecciona a una página de error. La implementación por defecto obtendrá el Forward "failure" del modo (view, edit o help) correspondiente.

Returns:

Forward al que se le pasará el control

findSuccess

protected Forward findSuccess()

Retorna un Forward que redirecciona a una página de éxito. La implementación por defecto obtendrá el Forward "success" del modo (view, edit o help) correspondiente.

Returns:

Forward al que se le pasará el control

findForward

private Forward findForward(java.lang.String name)

Retorna el Forward indicado mediante el atributo "name" del modo (view, edit o help) correspondiente.

Parameters:

name - Nombre del Forward que se retornará

Returns:

Forward al que se le pasará el control

catchException

protected void catchException(java.lang.Exception e)
                       throws ExecuteActionException

Encierra el tratamiento de cualquier excepción que se pueda lanzar durante la ejecución de la lógica de negocio de la Action. La implementación por defecto del método se limita a lanzar una excepción del tipo ExecuteActionException cuyo mensaje se corresponderá con el mensaje de la excepción capturada.

Parameters:

e - Excepción lanzada durante la ejecución de la Action

Throws:

ExecuteActionException - Excepción que encapsula la excepción capturada