[portal-commits] JBoss Portal SVN: r7046 - in trunk: api/src/main/org/jboss/portal/api/event and 10 other directories.

Author: julien(a)jboss.com Date: 2007-04-25 11:54:20 -0400 (Wed, 25 Apr 2007) New Revision: 7046 Added: trunk/api/src/main/org/jboss/portal/api/PortalRuntimeContext.java trunk/api/src/main/org/jboss/portal/api/navstate/ trunk/api/src/main/org/jboss/portal/api/navstate/NavigationalStateContext.java Removed: trunk/api/src/main/org/jboss/portal/spi/runtime/NavigationalStateContext.java trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java Modified: trunk/api/src/main/org/jboss/portal/api/event/PortalEventContext.java trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEvent.java trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java trunk/core-samples/src/main/org/jboss/portal/core/portlet/test/event/WindowConstraintEventListener.java trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/Navigation.java trunk/core/src/main/org/jboss/portal/core/impl/api/CoreNavigationalStateContext.java trunk/core/src/main/org/jboss/portal/core/impl/api/CorePortalNode.java trunk/core/src/main/org/jboss/portal/core/impl/api/CorePortalRuntimeContext.java trunk/core/src/main/org/jboss/portal/core/impl/api/user/UserEventContext.java trunk/core/src/main/org/jboss/portlet/JBossActionResponse.java trunk/core/src/main/org/jboss/portlet/JBossRenderResponse.java trunk/core/src/resources/portal-core-war/WEB-INF/jsp/header/tabs.jsp Log: minor reorg of API for non published classes Copied: trunk/api/src/main/org/jboss/portal/api/PortalRuntimeContext.java (from rev 7042, trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java) =================================================================== --- trunk/api/src/main/org/jboss/portal/api/PortalRuntimeContext.java (rev 0) +++ trunk/api/src/main/org/jboss/portal/api/PortalRuntimeContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -0,0 +1,56 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.api; + +import org.jboss.portal.api.navstate.NavigationalStateContext; +import org.jboss.portal.api.PortalSession; + +/** + * The portal runtime context which provides access to runtime objects. + * + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 1.1 $ + */ +public interface PortalRuntimeContext +{ + /** + * Return the user id or null if no user is associated with the context. + * + * @return the user id + */ + String getUserId(); + + /** + * Return the portal session or null if no session is associated with the context. + * + * @return the portal session + */ + PortalSession getSession(); + + /** + * Returns the navigational state context or null if no navigational state is associated with the context. + * + * @return the navigational state context + */ + NavigationalStateContext getNavigationalStateContext(); +} Modified: trunk/api/src/main/org/jboss/portal/api/event/PortalEventContext.java =================================================================== --- trunk/api/src/main/org/jboss/portal/api/event/PortalEventContext.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/api/src/main/org/jboss/portal/api/event/PortalEventContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -22,7 +22,7 @@ ******************************************************************************/ package org.jboss.portal.api.event; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; +import org.jboss.portal.api.PortalRuntimeContext; /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> Added: trunk/api/src/main/org/jboss/portal/api/navstate/NavigationalStateContext.java =================================================================== --- trunk/api/src/main/org/jboss/portal/api/navstate/NavigationalStateContext.java (rev 0) +++ trunk/api/src/main/org/jboss/portal/api/navstate/NavigationalStateContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -0,0 +1,72 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.api.navstate; + +import org.jboss.portal.WindowState; +import org.jboss.portal.Mode; +import org.jboss.portal.api.node.PortalNode; + +/** + * Provide access to a portion of the navigational state managed by the portal. + * + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 1.1 $ + */ +public interface NavigationalStateContext +{ + /** + * Returns the window state of a window or null if it is not found. + * + * @param window the window from which the window state is returned + * @return the window state + * @throws IllegalArgumentException + */ + WindowState getWindowState(PortalNode window) throws IllegalArgumentException; + + /** + * Updates the window state of a window. + * + * @param window the window to update + * @param windowState the new window state value + * @throws IllegalArgumentException + */ + void setWindowState(PortalNode window, WindowState windowState) throws IllegalArgumentException; + + /** + * Returns the mode of a window or null if it is not found. + * + * @param window the window from which the mode is returned + * @return the mode + * @throws IllegalArgumentException + */ + Mode getMode(PortalNode window) throws IllegalArgumentException; + + /** + * Updates the mode of a window. + * + * @param window the window to update + * @param mode the new mode value + * @throws IllegalArgumentException + */ + void setMode(PortalNode window, Mode mode) throws IllegalArgumentException; +} Modified: trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java =================================================================== --- trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -22,7 +22,7 @@ ******************************************************************************/ package org.jboss.portal.api.node; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; +import org.jboss.portal.api.PortalRuntimeContext; import java.util.Collection; import java.util.Map; Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEvent.java =================================================================== --- trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEvent.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEvent.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -23,13 +23,14 @@ package org.jboss.portal.api.node.event; import org.jboss.portal.api.node.PortalNode; +import org.jboss.portal.api.event.PortalEvent; /** * Base class for all portal node events. * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> */ -public abstract class PortalNodeEvent +public abstract class PortalNodeEvent extends PortalEvent { /** The portal node targetted by this event. */ Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java =================================================================== --- trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -24,7 +24,6 @@ import org.jboss.portal.api.node.PortalNode; import org.jboss.portal.api.event.PortalEventContext; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; /** * The context in which a <code>PortalNodeEvent</code> is dispatched. Deleted: trunk/api/src/main/org/jboss/portal/spi/runtime/NavigationalStateContext.java =================================================================== --- trunk/api/src/main/org/jboss/portal/spi/runtime/NavigationalStateContext.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/api/src/main/org/jboss/portal/spi/runtime/NavigationalStateContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -1,72 +0,0 @@ -/****************************************************************************** - * JBoss, a division of Red Hat * - * Copyright 2006, Red Hat Middleware, LLC, and individual * - * contributors as indicated by the @authors tag. See the * - * copyright.txt in the distribution for a full listing of * - * individual contributors. * - * * - * This is free software; you can redistribute it and/or modify it * - * under the terms of the GNU Lesser General Public License as * - * published by the Free Software Foundation; either version 2.1 of * - * the License, or (at your option) any later version. * - * * - * This software is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * - * Lesser General Public License for more details. * - * * - * You should have received a copy of the GNU Lesser General Public * - * License along with this software; if not, write to the Free * - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * - ******************************************************************************/ -package org.jboss.portal.spi.runtime; - -import org.jboss.portal.WindowState; -import org.jboss.portal.Mode; -import org.jboss.portal.api.node.PortalNode; - -/** - * Provide access to a portion of the navigational state managed by the portal. - * - * @author <a href="mailto:julien@jboss.org">Julien Viet</a> - * @version $Revision: 1.1 $ - */ -public interface NavigationalStateContext -{ - /** - * Returns the window state of a window or null if it is not found. - * - * @param window the window from which the window state is returned - * @return the window state - * @throws IllegalArgumentException - */ - WindowState getWindowState(PortalNode window) throws IllegalArgumentException; - - /** - * Updates the window state of a window. - * - * @param window the window to update - * @param windowState the new window state value - * @throws IllegalArgumentException - */ - void setWindowState(PortalNode window, WindowState windowState) throws IllegalArgumentException; - - /** - * Returns the mode of a window or null if it is not found. - * - * @param window the window from which the mode is returned - * @return the mode - * @thrpows IllegalArgumentException - */ - Mode getMode(PortalNode window) throws IllegalArgumentException; - - /** - * Updates the mode of a window. - * - * @param window the window to update - * @param mode the new mode value - * @throws IllegalArgumentException - */ - void setMode(PortalNode window, Mode mode) throws IllegalArgumentException; -} Deleted: trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java =================================================================== --- trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/api/src/main/org/jboss/portal/spi/runtime/PortalRuntimeContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -1,53 +0,0 @@ -/****************************************************************************** - * JBoss, a division of Red Hat * - * Copyright 2006, Red Hat Middleware, LLC, and individual * - * contributors as indicated by the @authors tag. See the * - * copyright.txt in the distribution for a full listing of * - * individual contributors. * - * * - * This is free software; you can redistribute it and/or modify it * - * under the terms of the GNU Lesser General Public License as * - * published by the Free Software Foundation; either version 2.1 of * - * the License, or (at your option) any later version. * - * * - * This software is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * - * Lesser General Public License for more details. * - * * - * You should have received a copy of the GNU Lesser General Public * - * License along with this software; if not, write to the Free * - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * - ******************************************************************************/ -package org.jboss.portal.spi.runtime; - -import org.jboss.portal.api.PortalSession; - -/** - * The portal runtime context which provides access to runtime objects. - * - * @author <a href="mailto:julien@jboss.org">Julien Viet</a> - * @version $Revision: 1.1 $ - */ -public interface PortalRuntimeContext -{ - /** - * Return the user id or null if no user is associated with the context. - * - * @return the user id - */ - String getUserId(); - - /** - * Return the portal session or null if no session is associated with the context. - */ - PortalSession getSession(); - - /** - * Returns the navigational state context or null if no navigational state is associated with the context. - * - * @return the navigational state context - */ - NavigationalStateContext getNavigationalStateContext(); -} Modified: trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/Navigation.java =================================================================== --- trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/Navigation.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core/src/main/org/jboss/portal/core/aspects/controller/node/Navigation.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -23,7 +23,7 @@ package org.jboss.portal.core.aspects.controller.node; import org.jboss.portal.core.impl.api.CorePortalNode; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; +import org.jboss.portal.api.PortalRuntimeContext; /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> Modified: trunk/core/src/main/org/jboss/portal/core/impl/api/CoreNavigationalStateContext.java =================================================================== --- trunk/core/src/main/org/jboss/portal/core/impl/api/CoreNavigationalStateContext.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core/src/main/org/jboss/portal/core/impl/api/CoreNavigationalStateContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -22,7 +22,7 @@ ******************************************************************************/ package org.jboss.portal.core.impl.api; -import org.jboss.portal.spi.runtime.NavigationalStateContext; +import org.jboss.portal.api.navstate.NavigationalStateContext; import org.jboss.portal.core.ns.NavigationalStateKey; import org.jboss.portal.core.model.portal.ns.WindowNavigationalState; import org.jboss.portal.api.node.PortalNode; Modified: trunk/core/src/main/org/jboss/portal/core/impl/api/CorePortalNode.java =================================================================== --- trunk/core/src/main/org/jboss/portal/core/impl/api/CorePortalNode.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core/src/main/org/jboss/portal/core/impl/api/CorePortalNode.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -27,6 +27,7 @@ import org.jboss.portal.api.node.event.PortalNodeEvent; import org.jboss.portal.api.node.event.PortalNodeEventContext; import org.jboss.portal.api.node.event.PortalNodeEventListener; +import org.jboss.portal.api.PortalRuntimeContext; import org.jboss.portal.common.path.RelativePathParser; import org.jboss.portal.common.i18n.ResourceBundleManager; import org.jboss.portal.common.i18n.SimpleResourceBundleFactory; @@ -34,7 +35,6 @@ import org.jboss.portal.core.model.portal.PortalObject; import org.jboss.portal.core.model.portal.PortalObjectId; import org.jboss.portal.core.model.portal.PortalObjectPermission; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; import org.jboss.portal.security.spi.auth.PortalAuthorizationManager; import java.util.Collection; Modified: trunk/core/src/main/org/jboss/portal/core/impl/api/CorePortalRuntimeContext.java =================================================================== --- trunk/core/src/main/org/jboss/portal/core/impl/api/CorePortalRuntimeContext.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core/src/main/org/jboss/portal/core/impl/api/CorePortalRuntimeContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -22,8 +22,8 @@ ******************************************************************************/ package org.jboss.portal.core.impl.api; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; -import org.jboss.portal.spi.runtime.NavigationalStateContext; +import org.jboss.portal.api.PortalRuntimeContext; +import org.jboss.portal.api.navstate.NavigationalStateContext; import org.jboss.portal.api.PortalSession; import org.jboss.portal.core.controller.ControllerContext; import org.jboss.portal.core.controller.ControllerCommand; Modified: trunk/core/src/main/org/jboss/portal/core/impl/api/user/UserEventContext.java =================================================================== --- trunk/core/src/main/org/jboss/portal/core/impl/api/user/UserEventContext.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core/src/main/org/jboss/portal/core/impl/api/user/UserEventContext.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -23,7 +23,7 @@ package org.jboss.portal.core.impl.api.user; import org.jboss.portal.api.event.PortalEventContext; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; +import org.jboss.portal.api.PortalRuntimeContext; /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> Modified: trunk/core/src/main/org/jboss/portlet/JBossActionResponse.java =================================================================== --- trunk/core/src/main/org/jboss/portlet/JBossActionResponse.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core/src/main/org/jboss/portlet/JBossActionResponse.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -24,13 +24,13 @@ import org.jboss.portal.api.node.PortalNode; import org.jboss.portal.api.node.PortalNodeURL; +import org.jboss.portal.api.PortalRuntimeContext; import org.jboss.portal.common.util.URLTools; import org.jboss.portal.core.aspects.controller.node.Navigation; import org.jboss.portal.core.controller.portlet.SignOutResponse; import org.jboss.portal.portlet.impl.jsr168.api.ActionResponseImpl; import org.jboss.portal.portlet.impl.jsr168.api.PortletRequestImpl; import org.jboss.portal.portlet.invocation.ActionInvocation; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; import javax.portlet.PortletRequest; Modified: trunk/core/src/main/org/jboss/portlet/JBossRenderResponse.java =================================================================== --- trunk/core/src/main/org/jboss/portlet/JBossRenderResponse.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core/src/main/org/jboss/portlet/JBossRenderResponse.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -24,12 +24,12 @@ import org.jboss.portal.api.node.PortalNode; import org.jboss.portal.api.node.PortalNodeURL; +import org.jboss.portal.api.PortalRuntimeContext; import org.jboss.portal.core.aspects.controller.node.Navigation; import org.jboss.portal.portlet.impl.jsr168.api.PortletRequestImpl; import org.jboss.portal.portlet.impl.jsr168.api.RenderResponseImpl; import org.jboss.portal.portlet.invocation.PortletInvocation; import org.jboss.portal.portlet.invocation.RenderInvocation; -import org.jboss.portal.spi.runtime.PortalRuntimeContext; /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> Modified: trunk/core/src/resources/portal-core-war/WEB-INF/jsp/header/tabs.jsp =================================================================== --- trunk/core/src/resources/portal-core-war/WEB-INF/jsp/header/tabs.jsp 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core/src/resources/portal-core-war/WEB-INF/jsp/header/tabs.jsp 2007-04-25 15:54:20 UTC (rev 7046) @@ -2,7 +2,7 @@ <%@ page import="org.jboss.portal.api.node.PortalNode" %> <%@ page import="java.util.Locale" %> <%@ page import="java.util.ArrayList" %> -<%@ page import="org.jboss.portal.spi.runtime.PortalRuntimeContext" %> +<%@ page import="org.jboss.portal.api.PortalRuntimeContext" %> <% PortalNode root = (PortalNode)request.getAttribute("org.jboss.portal.api.PORTAL_NODE"); Modified: trunk/core-samples/src/main/org/jboss/portal/core/portlet/test/event/WindowConstraintEventListener.java =================================================================== --- trunk/core-samples/src/main/org/jboss/portal/core/portlet/test/event/WindowConstraintEventListener.java 2007-04-25 15:30:21 UTC (rev 7045) +++ trunk/core-samples/src/main/org/jboss/portal/core/portlet/test/event/WindowConstraintEventListener.java 2007-04-25 15:54:20 UTC (rev 7046) @@ -28,8 +28,8 @@ import org.jboss.portal.api.node.event.PageRenderEvent; import org.jboss.portal.api.node.event.WindowNavigationEvent; import org.jboss.portal.api.node.PortalNode; +import org.jboss.portal.api.navstate.NavigationalStateContext; import org.jboss.portal.theme.ThemeConstants; -import org.jboss.portal.spi.runtime.NavigationalStateContext; import org.jboss.portal.WindowState; import java.util.Map;