[portal-commits] JBoss Portal SVN: r6801 - in trunk/api/src/main/org/jboss/portal: spi/runtime and 1 other directory.
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
===================================================================
--- 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 = runtimeContext;
}
+ /**
+ * Returns the runtime context or null if it is not available during the event
broadcasting.
+ *
+ * @return the portal runtime context
+ */
public PortalRuntimeContext getRuntimeContext()
{
return runtimeContext;
Modified: trunk/api/src/main/org/jboss/portal/spi/runtime/PortalSession.java
===================================================================
--- 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 however it is not
possible to influence
+ * the lifecycle of the session as it is managed by the portal.
*
* @author <a href="mailto:julien@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);