[jboss-cvs] jboss-seam/src/main/org/jboss/seam/contexts ...
Gavin King
gavin.king at jboss.com
Fri Jun 22 05:18:40 EDT 2007
User: gavin
Date: 07/06/22 05:18:40
Modified: src/main/org/jboss/seam/contexts
ApplicationContext.java Context.java
EventContext.java FacesLifecycle.java
Lifecycle.java ServerConversationContext.java
ServletLifecycle.java SessionContext.java
TestLifecycle.java
Added: src/main/org/jboss/seam/contexts package-info.java
Log:
javadoc
Revision Changes Path
1.2 +5 -0 jboss-seam/src/main/org/jboss/seam/contexts/ApplicationContext.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: ApplicationContext.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/ApplicationContext.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- ApplicationContext.java 10 Jun 2007 19:39:15 -0000 1.1
+++ ApplicationContext.java 22 Jun 2007 09:18:40 -0000 1.2
@@ -11,6 +11,11 @@
import org.jboss.seam.ScopeType;
/**
+ * Application context - state associated with a
+ * deployment to a particular node. State is typically
+ * neither persistent across deployments, not
+ * replicated to other nodes.
+ *
* @author Gavin King
*/
public class ApplicationContext extends BasicContext
1.9 +44 -15 jboss-seam/src/main/org/jboss/seam/contexts/Context.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: Context.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/Context.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -b -r1.8 -r1.9
--- Context.java 10 Jun 2007 19:39:15 -0000 1.8
+++ Context.java 22 Jun 2007 09:18:40 -0000 1.9
@@ -1,27 +1,56 @@
/*
- * JBoss, Home of Professional Open Source
- *
- * Distributable under LGPL license.
- * See terms of license at gnu.org.
- */
+ * JBoss, Home of Professional Open Source
+ *
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
+ */
package org.jboss.seam.contexts;
import org.jboss.seam.ScopeType;
/**
- * A set of named components and items of data that
- * is associated with a particular seam context.
+ * API for accessing named components and named values that
+ * are currently associated with a particular seam scope.
*
* @author Gavin King
*/
public interface Context
{
+ /**
+ * Get a value by name.
+ */
public Object get(String name);
+ /**
+ * Get a component instance, by its component name,
+ * as determined by the @Name annotation value.
+ */
public Object get(Class clazz);
+ /**
+ * Set a value.
+ */
public void set(String name, Object value);
+ /**
+ * Unset a value.
+ */
public void remove(String name);
+ /**
+ * Is the value set?
+ */
public boolean isSet(String name);
+ /**
+ * Get all names defined in the context.
+ */
public String[] getNames();
+ /**
+ * Force synchronization to the underlying state store.
+ *
+ * Some implementations of Context "persist" state back to
+ * the underlying store synchronously, others asynchronously.
+ * This method is usually called by Seam, when necessary.
+ */
public void flush();
+ /**
+ * Get the scope that this context object is associated with,
+ */
public ScopeType getType();
}
1.7 +3 -0 jboss-seam/src/main/org/jboss/seam/contexts/EventContext.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: EventContext.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/EventContext.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- EventContext.java 10 Jun 2007 19:39:15 -0000 1.6
+++ EventContext.java 22 Jun 2007 09:18:40 -0000 1.7
@@ -11,6 +11,9 @@
import org.jboss.seam.ScopeType;
/**
+ * Event context - spans a single request to
+ * the server.
+ *
* @author Gavin King
*/
public class EventContext extends BasicContext
1.7 +4 -0 jboss-seam/src/main/org/jboss/seam/contexts/FacesLifecycle.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: FacesLifecycle.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/FacesLifecycle.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- FacesLifecycle.java 21 Jun 2007 20:32:00 -0000 1.6
+++ FacesLifecycle.java 22 Jun 2007 09:18:40 -0000 1.7
@@ -16,6 +16,10 @@
import org.jboss.seam.web.Session;
/**
+ * Methods for setup and teardown of Seam contexts at the
+ * beginning and end of JSF requests.
+ *
+ * @see org.jboss.seam.jsf.SeamPhaseListener
* @author Gavin King
* @author <a href="mailto:theute at jboss.org">Thomas Heute</a>
*/
1.104 +2 -0 jboss-seam/src/main/org/jboss/seam/contexts/Lifecycle.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: Lifecycle.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/Lifecycle.java,v
retrieving revision 1.103
retrieving revision 1.104
diff -u -b -r1.103 -r1.104
--- Lifecycle.java 20 Jun 2007 17:49:42 -0000 1.103
+++ Lifecycle.java 22 Jun 2007 09:18:40 -0000 1.104
@@ -16,6 +16,8 @@
import org.jboss.seam.log.Logging;
/**
+ * Methods for setup and teardown of Seam contexts.
+ *
* @author Gavin King
* @author <a href="mailto:theute at jboss.org">Thomas Heute</a>
*/
1.31 +2 -1 jboss-seam/src/main/org/jboss/seam/contexts/ServerConversationContext.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: ServerConversationContext.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/ServerConversationContext.java,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -b -r1.30 -r1.31
--- ServerConversationContext.java 21 Jun 2007 20:32:00 -0000 1.30
+++ ServerConversationContext.java 22 Jun 2007 09:18:40 -0000 1.31
@@ -22,7 +22,8 @@
/**
* A conversation context is a logical context that lasts longer than
- * a request but shorter than a login session
+ * a request but shorter than a login session. Conversation state
+ * may be passivated or replicated.
*
* @author Gavin King
* @author <a href="mailto:theute at jboss.org">Thomas Heute</a>
1.4 +3 -0 jboss-seam/src/main/org/jboss/seam/contexts/ServletLifecycle.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: ServletLifecycle.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/ServletLifecycle.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- ServletLifecycle.java 21 Jun 2007 20:32:00 -0000 1.3
+++ ServletLifecycle.java 22 Jun 2007 09:18:40 -0000 1.4
@@ -21,6 +21,9 @@
import org.jboss.seam.web.Session;
/**
+ * Methods for setup and teardown of Seam contexts at the
+ * beginning and end of servlet requests.
+ *
* @author Gavin King
* @author <a href="mailto:theute at jboss.org">Thomas Heute</a>
*/
1.5 +8 -5 jboss-seam/src/main/org/jboss/seam/contexts/SessionContext.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: SessionContext.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/SessionContext.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- SessionContext.java 20 Jun 2007 08:23:17 -0000 1.4
+++ SessionContext.java 22 Jun 2007 09:18:40 -0000 1.5
@@ -1,9 +1,9 @@
/*
- * JBoss, Home of Professional Open Source
- *
- * Distributable under LGPL license.
- * See terms of license at gnu.org.
- */
+ * JBoss, Home of Professional Open Source
+ *
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
+ */
package org.jboss.seam.contexts;
import java.util.ArrayList;
@@ -13,6 +13,9 @@
import org.jboss.seam.Seam;
/**
+ * Session context - state associated with a user session.
+ * Session state may be passivated or replicated.
+ *
* @author Gavin King
*/
public class SessionContext extends BasicContext
1.2 +3 -0 jboss-seam/src/main/org/jboss/seam/contexts/TestLifecycle.java
(In the diff below, changes in quantity of whitespace are not shown.)
Index: TestLifecycle.java
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/contexts/TestLifecycle.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- TestLifecycle.java 20 Jun 2007 08:23:17 -0000 1.1
+++ TestLifecycle.java 22 Jun 2007 09:18:40 -0000 1.2
@@ -16,6 +16,9 @@
import org.jboss.seam.servlet.ServletApplicationMap;
/**
+ * Methods for setup and teardown of Seam contexts at the
+ * beginning and end of a test.
+ *
* @author Gavin King
*/
public class TestLifecycle
1.1 date: 2007/06/22 09:18:40; author: gavin; state: Exp;jboss-seam/src/main/org/jboss/seam/contexts/package-info.java
Index: package-info.java
===================================================================
/**
* The Seam Context API and implementations.
*/
package org.jboss.seam.contexts;
More information about the jboss-cvs-commits
mailing list