[jboss-cvs] jboss-seam/src/main/org/jboss/seam/web ...

Gavin King gavin.king at jboss.com
Fri Jun 22 05:18:45 EDT 2007


  User: gavin   
  Date: 07/06/22 05:18:45

  Modified:    src/main/org/jboss/seam/web       AbstractFilter.java
                        Ajax4jsfFilter.java MultipartFilter.java
                        SeamFilter.java Session.java package-info.java
  Log:
  javadoc
  
  Revision  Changes    Path
  1.2       +14 -0     jboss-seam/src/main/org/jboss/seam/web/AbstractFilter.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: AbstractFilter.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/web/AbstractFilter.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -b -r1.1 -r1.2
  --- AbstractFilter.java	10 Feb 2007 17:26:02 -0000	1.1
  +++ AbstractFilter.java	22 Jun 2007 09:18:45 -0000	1.2
  @@ -7,6 +7,20 @@
   import javax.servlet.ServletRequest;
   import javax.servlet.http.HttpServletRequest;
   
  +/**
  + * Abstract superclass for Seam components that act
  + * as servlet filters. Note that since a filter is
  + * potentially called outside of a set of Seam
  + * contexts, it is not a true Seam component. 
  + * However, we are able to reuse the functionality
  + * for component scanning, installation and 
  + * configuration for filters. All filters must
  + * specify a @Filter annotation.
  + * 
  + * @see org.jboss.seam.annotations.Filter
  + * @author Shane Bryzak
  + *
  + */
   public abstract class AbstractFilter implements Filter
   {
      private ServletContext servletContext;
  
  
  
  1.2       +6 -0      jboss-seam/src/main/org/jboss/seam/web/Ajax4jsfFilter.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: Ajax4jsfFilter.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/web/Ajax4jsfFilter.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -b -r1.1 -r1.2
  --- Ajax4jsfFilter.java	21 Jun 2007 11:01:12 -0000	1.1
  +++ Ajax4jsfFilter.java	22 Jun 2007 09:18:45 -0000	1.2
  @@ -17,6 +17,12 @@
   import org.jboss.seam.annotations.Scope;
   import org.jboss.seam.annotations.intercept.BypassInterceptors;
   
  +/**
  + * A Seam filter component wrapper for the Ajax4JSF.
  + * 
  + * @author Pete Muir
  + * 
  + */
   @Scope(APPLICATION)
   @Name("org.jboss.seam.web.ajax4jsfFilter")
   @Install(precedence = BUILT_IN, classDependencies="org.ajax4jsf.Filter")
  
  
  
  1.7       +7 -0      jboss-seam/src/main/org/jboss/seam/web/MultipartFilter.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: MultipartFilter.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/web/MultipartFilter.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -b -r1.6 -r1.7
  --- MultipartFilter.java	20 Jun 2007 17:45:58 -0000	1.6
  +++ MultipartFilter.java	22 Jun 2007 09:18:45 -0000	1.7
  @@ -19,6 +19,13 @@
   import org.jboss.seam.annotations.Startup;
   import org.jboss.seam.annotations.intercept.BypassInterceptors;
   
  +/**
  + * A filter for decoding multipart requests, for
  + * use with the file upload control.
  + * 
  + * @author Shane Bryzak
  + *
  + */
   @Startup
   @Scope(APPLICATION)
   @Name("org.jboss.seam.web.multipartFilter")
  
  
  
  1.9       +12 -0     jboss-seam/src/main/org/jboss/seam/web/SeamFilter.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: SeamFilter.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/web/SeamFilter.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -b -r1.8 -r1.9
  --- SeamFilter.java	10 Jun 2007 19:39:16 -0000	1.8
  +++ SeamFilter.java	22 Jun 2007 09:18:45 -0000	1.9
  @@ -24,6 +24,18 @@
   import org.jboss.seam.util.SortItem;
   import org.jboss.seam.util.Sorter;
   
  +/**
  + * A servlet filter that orchestrates the stack of Seam
  + * component filters, and controls ordering. Filter
  + * ordering is specified via the @Filter annotation.
  + * Filters may optionally extend AbstractFilter.
  + * 
  + * @see org.jboss.seam.annotations.Filter
  + * @see AbstractFilter
  + * 
  + * @author Shane Bryzak
  + *
  + */
   public class SeamFilter implements Filter
   {
      private static final LogProvider log = Logging.getLogProvider(SeamFilter.class);   
  
  
  
  1.2       +36 -0     jboss-seam/src/main/org/jboss/seam/web/Session.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: Session.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/web/Session.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -b -r1.1 -r1.2
  --- Session.java	20 Jun 2007 22:11:31 -0000	1.1
  +++ Session.java	22 Jun 2007 09:18:45 -0000	1.2
  @@ -9,6 +9,20 @@
   import org.jboss.seam.contexts.Contexts;
   import org.jboss.seam.core.AbstractMutable;
   
  +/**
  + * Controls HttpSession invalidation in any
  + * servlet or JSF environment. Since Seam
  + * keeps internal state in the HttpSession,
  + * is is illegal to call HttpSession.invalidate()
  + * while Seam contexts are active.
  + * 
  + * Applications using Seam security should call
  + * Identity.logout() instead of calling this
  + * component directly.
  + * 
  + * @author Gavin King
  + *
  + */
   @Scope(ScopeType.SESSION)
   @Name("org.jboss.seam.web.session")
   @BypassInterceptors
  @@ -19,17 +33,33 @@
      private boolean invalidateOnSchemeChange;
      private String currentScheme;
   
  +   /**
  +    * Is HttpSession invalidation scheduled
  +    * for the end of this request?
  +    */
      public boolean isInvalid()
      {
         return isInvalid;
      }
   
  +   /**
  +    * Schedule HttpSession invalidation at the
  +    * end of the request.
  +    *
  +    */
      public void invalidate()
      {
         this.isInvalid = true;
         setDirty();
      }
      
  +   /**
  +    * Should we invalidate the session due to a change in
  +    * the request scheme?
  +    * 
  +    * @param requestScheme the scheme of the current request
  +    * @return true if we should invalidate the session
  +    */
      public boolean isInvalidDueToNewScheme(String requestScheme)
      {
         if (invalidateOnSchemeChange)
  @@ -57,11 +87,17 @@
         }
      }
   
  +   /**
  +    * Is session invalidation on scheme change enabled?
  +    */
      public boolean isInvalidateOnSchemeChange()
      {
         return invalidateOnSchemeChange;
      }
   
  +   /**
  +    * Enable or disable session invalidation on scheme change?
  +    */
      public void setInvalidateOnSchemeChange(boolean invalidateOnSchemeChange)
      {
         setDirty();
  
  
  
  1.3       +3 -0      jboss-seam/src/main/org/jboss/seam/web/package-info.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: package-info.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/web/package-info.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -b -r1.2 -r1.3
  --- package-info.java	20 Jun 2007 05:48:03 -0000	1.2
  +++ package-info.java	22 Jun 2007 09:18:45 -0000	1.3
  @@ -1,3 +1,6 @@
  +/**
  + * Seam components for use in a servlet environment.
  + */
   @Namespace(value="http://jboss.com/products/seam/web", prefix="org.jboss.seam.web")
   package org.jboss.seam.web;
   
  
  
  



More information about the jboss-cvs-commits mailing list