org.apache.turbine.modules.actions
Class VelocitySecureAction

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.turbine.util.velocity.VelocityActionEvent
                  org.apache.turbine.modules.actions.VelocityAction
                      org.apache.turbine.modules.actions.VelocitySecureAction

public abstract class VelocitySecureAction

extends VelocityAction

VelocitySecure action. Always performs a Security Check that you've defined before executing the doBuildtemplate(). You should extend this class and add the specific security check needed. If you have a number of screens that need to perform the same check, you could make a base screen by extending this class and implementing the isAuthorized(). Then each action that needs to perform the same check could extend your base action.

Version:

$Id: VelocitySecureAction.java 534527 2007-05-02 16:10:59Z tv $

Author:

Dave Bryson, Jon S. Stevens, Jason van Zyl

Field Summary

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, log, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

VelocitySecureAction()

Method Summary

abstract void	doPerform(RunData data, org.apache.velocity.context.Context context) Implement this to add information to the context.
protected abstract boolean	isAuthorized(RunData data) Implement this method to perform the security check needed.
protected void	perform(RunData data) This method overrides the method in WebMacroSiteAction to perform a security check first.

Methods inherited from class org.apache.turbine.modules.actions.VelocityAction

doPerform, getContext, setTemplate

Methods inherited from class org.apache.turbine.util.velocity.VelocityActionEvent

executeEvents

Methods inherited from class org.apache.turbine.modules.ActionEvent

considerKey, executeEvents, formatString

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocitySecureAction

public VelocitySecureAction()

Method Detail

doPerform

public abstract void doPerform(RunData data,
                               org.apache.velocity.context.Context context)
                        throws java.lang.Exception

Implement this to add information to the context.

Specified by:

doPerform in class VelocityAction

Parameters:

data - Turbine information.

context - Context for web pages.

Throws:

java.lang.Exception - a generic exception.

perform

protected void perform(RunData data)
                throws java.lang.Exception

This method overrides the method in WebMacroSiteAction to perform a security check first.

Overrides:

perform in class VelocityAction

Parameters:

data - Turbine information.

Throws:

java.lang.Exception - a generic exception.

isAuthorized

protected abstract boolean isAuthorized(RunData data)
                                 throws java.lang.Exception

Implement this method to perform the security check needed. You should set the template in this method that you want the user to be sent to if they're unauthorized.

Parameters:

data - Turbine information.

Returns:

True if the user is authorized to access the screen.

Throws:

java.lang.Exception - a generic exception.