From portal-commits at lists.jboss.org Wed Mar 21 20:26:52 2007
Content-Type: multipart/mixed; boundary="===============7633632634643280871=="
MIME-Version: 1.0
From: portal-commits at lists.jboss.org
To: portal-commits at lists.jboss.org
Subject: [portal-commits] JBoss Portal SVN: r6801 - in
 trunk/api/src/main/org/jboss/portal: spi/runtime and 1 other directory.
Date: Wed, 21 Mar 2007 20:26:52 -0400
Message-ID: <E1HUB8m-00056R-Hv@committer01.frg.pub.inap.atl.jboss.com>

--===============7633632634643280871==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: julien(a)jboss.com
Date: 2007-03-21 20:26:50 -0400 (Wed, 21 Mar 2007)
New Revision: 6801

Modified:
   trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java
   trunk/api/src/main/org/jboss/portal/spi/runtime/PortalSession.java
Log:
minor javadoc

Modified: trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java	2007-03-=
22 00:23:50 UTC (rev 6800)
+++ trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java	2007-03-=
22 00:26:50 UTC (rev 6801)
@@ -33,7 +33,7 @@
 public abstract class PortalEvent
 {
 =

-   /** . */
+   /** The portal runtime context. */
    protected PortalRuntimeContext runtimeContext;
 =

    protected PortalEvent(PortalRuntimeContext runtimeContext)
@@ -41,6 +41,11 @@
       this.runtimeContext =3D runtimeContext;
    }
 =

+   /**
+    * Returns the runtime context or null if it is not available during th=
e event broadcasting.
+    *
+    * @return the portal runtime context
+    */
    public PortalRuntimeContext getRuntimeContext()
    {
       return runtimeContext;

Modified: trunk/api/src/main/org/jboss/portal/spi/runtime/PortalSession.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/api/src/main/org/jboss/portal/spi/runtime/PortalSession.java	2007=
-03-22 00:23:50 UTC (rev 6800)
+++ trunk/api/src/main/org/jboss/portal/spi/runtime/PortalSession.java	2007=
-03-22 00:26:50 UTC (rev 6801)
@@ -23,14 +23,19 @@
 package org.jboss.portal.spi.runtime;
 =

 /**
- * The portal session.
+ * The portal session, the portal session attributes are accessible howeve=
r it is not possible to influence
+ * the lifecycle of the session as it is managed by the portal.
  *
  * @author <a href=3D"mailto:julien(a)jboss.org">Julien Viet</a>
  * @version $Revision: 1.1 $
  */
 public interface PortalSession
 {
-
+   /**
+    * Return the session id.
+    *
+    * @return the session id
+    */
    String getId();
 =

    Object getAttribute(String name);


--===============7633632634643280871==--