Examples of net.sourceforge.stripes.controller.FlashScope

Package net.sourceforge.stripes.controller

Examples of net.sourceforge.stripes.controller.FlashScope

net.sourceforge.stripes.controller.FlashScope
A FlashScope is an object that can be used to store objects and make them available as request parameters during this request cycle and the next one. It is extremely useful when implementing the redirect-after-post pattern in which an ActionBean receives a POST, does some processing and then redirects to a JSP to display the outcome. FlashScopes make temporary use of session to store themselves briefly between two requests.

In general, use of the FlashScope should be intermediated by the {@link net.sourceforge.stripes.action.ActionBeanContext}, making it transparent to the rest of the application. Any object that is put into a FlashScope will be immediately exposed in the current request as a request attribute, and under certain conditions will also be exposed in the subsequent request as a request attribute.

To make values available to the subsequent request a parameter must be included in the redirect URL that identifies the flash scope to use (this avoids collisions where two concurrent requests in the same session might otherwise cause problems for one another). The Stripes {@link net.sourceforge.stripes.action.RedirectResolution} will automaticallyinsert this parameter into the URL when a flash scope is present. Should you wish to issue redirects using a different mechanism you will need to add the parameter using code similar to the following:
```
 FlashScope flash = FlashScope.getCurrent(request, false); if (flash != null) { url.addParameter(StripesConstants.URL_KEY_FLASH_SCOPE_ID, flash.key()); } 
```
The lifecycle of a FlashScope is managed is conjunction with the {@link StripesFilter}. FlashScopes are manufactured using lazy instantiation when {@code FlashScope.getCurrent(request, true)} is called. When a request is completed, theStripesFilter notifies the current FlashScope that the request is over, which causes it to record the time when the request terminated. On the subsequent request, if the flash scope is referenced by a URL parameter, then it is removed from session and it's contents are pushed into request attributes for the current request.

To ensure that orphaned FlashScopes do not consume increasing amounts of HttpSession memory, the StripesFilter, after each request, checks to see if any FlashScopes have recently expired. A FlashScope is expired when the length of time from the end of the request that created the FlashScope is greater than the timeout set on the FlashScope. The default timeout is 120 seconds (or two minutes), and can be varied by calling {@link #setTimeout(int)} Since the timerstarts when a request completes, and FlashScopes are only meant to live from the end of one request to the beginning of a subsequent request this value is set quite low.
@author Tim Fennell @since Stripes 1.2

     *
     * @return a List of Message objects associated with the current request, never null.
     */
    @SuppressWarnings("unchecked")
  public List<Message> getMessages(String key) {
        FlashScope scope = FlashScope.getCurrent(getRequest(), true);
        List<Message> messages = (List<Message>) scope.get(key);


        if (messages == null) {
            messages = new ArrayList<Message>();
            scope.put(key, messages);
        }


        return messages;
    }

View Full Code Here

            addParameters(request.getParameterMap());
        }


        // Add any beans to the flash scope
        if (this.beans != null) {
            FlashScope flash = FlashScope.getCurrent(request, true);
            for (ActionBean bean : this.beans) {
                flash.put(bean);
            }
        }


        // If a flash scope exists, add the parameter to the request
        FlashScope flash = FlashScope.getCurrent(request, false);
        if (flash != null) {
            addParameter(StripesConstants.URL_KEY_FLASH_SCOPE_ID, flash.key());
        }


        // Prepend the context path if requested
        String url = getUrl(request.getLocale());
        if (prependContext) {

View Full Code Here

          if (attachment != null) {
            if (attachment.getSize() > 0) {
              if (tckt==null) {
                tckt = bill.createTicket(getSession(), getAccount());
                setId(tckt.id());
                FlashScope oFscope = FlashScope.getCurrent(getContext().getRequest(), true);
                oFscope.put("ticket_docid", tckt.id());
              }
              TicketNote note = tckt.createNote(getSession(), attachment.getInputStream(), incCapturedCount(), attachment.getFileName());
              if (getCapturedPage1().length()==0) setCapturedPage1(note.id());
              attachment.delete();
            } else {

View Full Code Here

        Ticket tckt = bill.createTicket(getSession(), new AccountingAccount(getSession(), sAccount));
        disconnect();
        DepositToZespedBridge oDzb = new DepositToZespedBridge(CaptureService.BILLNOTES, lDepositId, Long.parseLong(tckt.getId()));
        oDzb.start();
        Log.out.debug("Done attaching sides");
        FlashScope oFscope = FlashScope.getCurrent(getContext().getRequest(), true);
        oFscope.put("ticket_docid", tckt.id());
      }      
      new CreditBurner(getSessionAttribute("user_uuid"),
               getSessionAttribute("customer_account_docid"),
               sService, sFlavor).start();
    } catch (Exception e) {

View Full Code Here

      sRetVal = sDefaultValue;
    return sRetVal;
  }
  
  public void setParam(String sParamName, String sParamValue) {
    FlashScope oFscope = FlashScope.getCurrent(getContext().getRequest(), true);
    oFscope.put(sParamName, sParamValue);    
  }

View Full Code Here

     *
     * @return a List of Message objects associated with the current request, never null.
     */
    @SuppressWarnings("unchecked")
  public List<Message> getMessages(String key) {
        FlashScope scope = FlashScope.getCurrent(getRequest(), true);
        List<Message> messages = (List<Message>) scope.get(key);


        if (messages == null) {
            messages = new ArrayList<Message>();


            /*
             * Messages imported from previous flash scope will be present in request scope but not
             * in current flash scope. Handle such cases by copying the existing messages to a new
             * list in the current flash and request scopes.
             */
            if (getRequest().getAttribute(key) instanceof List) {
                try {
                    for (Message message : ((List<Message>) getRequest().getAttribute(key))) {
                        messages.add(message);
                    }
                }
                catch (ClassCastException e) {
                    messages.clear();
                }
            }


            scope.put(key, messages);
        }


        return messages;
    }

View Full Code Here

            addParameters(request.getParameterMap());
        }


        // Add any beans to the flash scope
        if (this.beans != null) {
            FlashScope flash = FlashScope.getCurrent(request, true);
            for (ActionBean bean : this.beans) {
                flash.put(bean);
            }
        }


        // If a flash scope exists, add the parameter to the request
        FlashScope flash = FlashScope.getCurrent(request, false);
        if (flash != null) {
            addParameter(StripesConstants.URL_KEY_FLASH_SCOPE_ID, flash.key());
        }


        // Prepend the context path if requested
        String url = getUrl(request.getLocale());
        if (prependContext) {

View Full Code Here

TOP

Related Classes of net.sourceforge.stripes.controller.FlashScope

com.zesped.action.AttachDeposit

com.zesped.action.BaseActionBean

com.zesped.action.UploadBillNote

net.sourceforge.stripes.action.ActionBean

net.sourceforge.stripes.action.ActionBeanContext

net.sourceforge.stripes.action.RedirectResolution

javax.servlet.http.HttpServletResponse

java.util.concurrent.Semaphore

net.sourceforge.stripes.exception.StripesRuntimeException

javax.servlet.http.HttpSession

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.