Examples of net.sourceforge.stripes.action.ActionBean

net.sourceforge.stripes.action.ActionBean
Interface for all classes that respond to user interface events. Implementations receive information about the event (usually a form submission) in two ways. The first is through a ActionBeanContext object which will always be set on the ActionBean prior to any user implemented "handler" methods being invoked. The second is through the setting of JavaBean style properties on the object (and nested JavaBeans). Values submitted in an HTML Form will be bound to a property on the object if such a property is defined. The ActionBeanContext is used primarily to provide access to Servlet APIs such as the request and response, and other information generated during the pre-processing of the request.

How Stripes determines which method to invoke is based on Annotations as opposed to a strict interface. Firstly, each ActionBean should be annotated with a UrlBinding which specifies the path within the web application that the ActionBean will be bound to. E.g:
```
 @UrlBinding("/action/SampleAction") public SampleActionBean implements ActionBean { ... 
```
At run time Stripes will discover all implementations of ActionBean and, when a form is submitted, will locate the ActionBean to use by matching the path in the request to the UrlBinding annotation on the ActionBean.

The way in which a specific event is mapped to a "handler" method can vary. The default method used by Stripes is to identify the name of the button or image button used to submit the request, and to find the handler method that can handle that event. The way this is declared in the ActionBean is like this:
```
 @HandlesEvent("SampleEvent") public Resolution sample() throws Exception { ... return new ForwardResolution("/SampleJsp2.jsp"); } 
```
Event names specified in the HandlesEvent annotation should be unique within a given ActionBean (and it's superclasses), but can be re-used across ActionBeans. For example, a given ActionBean should not have two methods with the annotation @HandlesEvent("Update"), but it would be perfectly reasonable to have two different ActionBeans handle events, from different forms, called Update.

It is also possible to designate a method as the default method for handling events in the case that Stripes cannot figure out a specific handler method to invoke. This occurs most often when a form is submitted by the user hitting the enter/return key, and so no form button is activated. Essentially the default handler is specifying the default operation for your form. In forms that have only one handler method, that method should always be declared as the default. For example:
```
 @HandlesEvent("Search") @DefaultHandler public Resolution findUsers() throws Exception { ... return new ForwardResolution("/SearchResults.jsp"); } 
```
Handler methods have two options for what to do when they have finished their processing. The preferred option is to return an instance of an implementation of Resolution. This keeps things clean and makes it a little easier to change how things work down the road. The other option is to return nothing, and simply use the Servlet API (available through the ActionBeanContext) to render a response to the user directly.

An ActionBean may optionally implement the {@link ValidationErrorHandler} interface whichallows the ActionBean to modify what happens when validation errors occur.
@see Resolution @see ActionBeanContext @see ValidationErrorHandler @author Tim Fennell

        ctx.setLifecycleStage(LifecycleStage.HandlerResolution);
        ctx.setInterceptors(config.getInterceptors(LifecycleStage.HandlerResolution));


        return ctx.wrap( new Interceptor() {
            public Resolution intercept(ExecutionContext ctx) throws Exception {
                ActionBean bean = ctx.getActionBean();
                ActionBeanContext context = ctx.getActionBeanContext();
                ActionResolver resolver = config.getActionResolver();


                // Then lookup the event name and handler method etc.
                String eventName = resolver.getEventName(bean.getClass(), context);
                context.setEventName(eventName);


                final Method handler;
                if (eventName != null) {
                    handler = resolver.getHandler(bean.getClass(), eventName);
                }
                else {
                    handler = resolver.getDefaultHandler(bean.getClass());
                    if (handler != null) {
                        context.setEventName(resolver.getHandledEvent(handler));
                    }
                }


                // Insist that we have a handler
                if (handler == null) {
                    throw new StripesServletException(
                            "No handler method found for request with  ActionBean [" +
                            bean.getClass().getName() + "] and eventName [ " + eventName + "]");
                }


                log.debug("Resolved event: ", context.getEventName(), "; will invoke: ",
                          bean.getClass().getSimpleName(), ".", handler.getName(), "()");


                ctx.setHandler(handler);
                return null;
            }
        });

View Full Code Here

     *         be aborted in favor of another Resolution, null otherwise.
     */
    public static Resolution doCustomValidation(final ExecutionContext ctx,
                                                final boolean alwaysInvokeValidate) throws Exception {
        final ValidationErrors errors = ctx.getActionBeanContext().getValidationErrors();
        final ActionBean bean = ctx.getActionBean();
        final Method handler = ctx.getHandler();
        final boolean doBind = handler != null && handler.getAnnotation(DontBind.class) == null;
        final boolean doValidate = doBind && handler.getAnnotation(DontValidate.class) == null;
        Configuration config = StripesFilter.getConfiguration();


        // Run the bean's methods annotated with @ValidateMethod if the following conditions are met:
        //   l. This event is not marked to bypass binding 
        //   2. This event is not marked to bypass validation (doValidate == true)
        //   3. We have no errors so far OR alwaysInvokeValidate is true
        if (doValidate) {


            ctx.setLifecycleStage(LifecycleStage.CustomValidation);
            ctx.setInterceptors(config.getInterceptors(LifecycleStage.CustomValidation));


            return ctx.wrap( new Interceptor() {
        public Resolution intercept(ExecutionContext context) throws Exception {
                    // Run any of the annotated validation methods
                    Method[] validations = findCustomValidationMethods(bean.getClass());
                    for (Method validation : validations) {
                        ValidationMethod ann = validation.getAnnotation(ValidationMethod.class);


                        boolean run = (ann.when() == ValidationState.ALWAYS)
                                   || (ann.when() == ValidationState.DEFAULT && alwaysInvokeValidate)

View Full Code Here

        // If we have errors, add the action path to them
        fillInValidationErrors(ctx);


        Resolution resolution = null;
        if (doValidate) {
            ActionBean bean = ctx.getActionBean();
            ActionBeanContext context = ctx.getActionBeanContext();
            ValidationErrors errors = context.getValidationErrors();


            // Now if we have errors and the bean wants to handle them...
            if (errors.size() > 0 && bean instanceof ValidationErrorHandler) {

View Full Code Here

     *         should be processed in favor of continuing on to handler invocation
     */
    public static Resolution invokeEventHandler(ExecutionContext ctx) throws Exception {
        final Configuration config = StripesFilter.getConfiguration();
        final Method handler = ctx.getHandler();
        final ActionBean bean = ctx.getActionBean();


        // Finally execute the handler method!
        ctx.setLifecycleStage(LifecycleStage.EventHandling);
        ctx.setInterceptors(config.getInterceptors(LifecycleStage.EventHandling));


        return ctx.wrap( new Interceptor() {
            public Resolution intercept(ExecutionContext ctx) throws Exception {
                Object returnValue = handler.invoke(bean);
                fillInValidationErrors(ctx);


                if (returnValue != null && returnValue instanceof Resolution) {
                    ctx.setResolutionFromHandler(true);
                    return (Resolution) returnValue;
                }
                else if (returnValue != null) {
                    log.warn("Expected handler method ", handler.getName(), " on class ",
                             bean.getClass().getSimpleName(), " to return a Resolution. Instead it ",
                             "returned: ", returnValue);
                }


                return null;
            }

View Full Code Here


    /**
     * Gets the (potentially empty) set of Validation Errors that were produced by the request.
     */
    public ValidationErrors getValidationErrors() {
        ActionBean bean = (ActionBean) this.request.getAttribute(StripesConstants.REQ_ATTR_ACTION_BEAN);
        return bean.getContext().getValidationErrors();
    }

View Full Code Here

        if (form != null) {
            actionPath = form.getAction();
            beanClass = form.getActionBeanClass();
        }
        else {
            ActionBean mainBean = (ActionBean) getPageContext().getRequest().getAttribute(StripesConstants.REQ_ATTR_ACTION_BEAN);
            if (mainBean != null) {
                beanClass = mainBean.getClass();
            }
        }
        return LocalizationUtility.getLocalizedFieldName(name, actionPath, beanClass, locale);
    }

View Full Code Here

    /**
     * Find errors that are related to the form field this input tag represents and place
     * them in an instance variable to use during error rendering.
     */
    protected void loadErrors() throws StripesJspException {
        ActionBean actionBean = getActionBean();
        if (actionBean != null) {
            ValidationErrors validationErrors = actionBean.getContext().getValidationErrors();


            if (validationErrors != null) {
                this.fieldErrors = validationErrors.get(getName());
            }
        }

View Full Code Here

     * @return the name of the form to be used for this request
     */
    public ActionBean getActionBean(ActionBeanContext context) throws StripesServletException {
        HttpServletRequest request = context.getRequest();
        String path = HttpUtil.getRequestedPath(request);
        ActionBean bean = getActionBean(context, path);
        request.setAttribute(RESOLVED_ACTION, getUrlBindingFromPath(path));
        return bean;
    }

View Full Code Here

     * @return a Class<ActionBean> for the ActionBean requested
     * @throws StripesServletException if the UrlBinding does not match an ActionBean binding
     */
    public ActionBean getActionBean(ActionBeanContext context, String path) throws StripesServletException {
        Class<? extends ActionBean> beanClass = getActionBeanType(path);
        ActionBean bean;


        if (beanClass == null) {
            throw new ActionBeanNotFoundException(path, getUrlBindingFactory().getPathMap());
        }

View Full Code Here

    public void put(ActionBean bean) {
        String binding = StripesFilter.getConfiguration()
                                      .getActionResolver().getUrlBinding(bean.getClass());
        super.put(binding, bean);


        ActionBean main = (ActionBean) request.getAttribute(StripesConstants.REQ_ATTR_ACTION_BEAN);
        if (main != null && main.equals(bean)) {
            super.put(StripesConstants.REQ_ATTR_ACTION_BEAN, bean);
        }
    }

View Full Code Here

0 1 2 3 4 5 6 7

TOP

Related Classes of net.sourceforge.stripes.action.ActionBean

auxiliar.SecurityInterceptor

net.sf.esims.util.EsimsSecurityInterceptor

net.sourceforge.stripes.controller.AnnotatedClassActionResolver

net.sourceforge.stripes.controller.BeforeAfterMethodInterceptor

net.sourceforge.stripes.controller.DispatcherHelper

net.sourceforge.stripes.controller.FlashScope

net.sourceforge.stripes.controller.HttpCacheInterceptor

net.sourceforge.stripes.controller.NameBasedActionResolver

net.sourceforge.stripes.examples.bugzooky.ext.SecurityInterceptor

net.sourceforge.stripes.exception.DefaultExceptionHandler

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.