01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.api;
23:
24: import org.jboss.portal.api.navstate.NavigationalStateContext;
25: import org.jboss.portal.api.session.PortalSession;
26:
27: /**
28: * The portal runtime context which provides access to runtime objects.
29: *
30: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
31: * @version $Revision: 8785 $
32: */
33: public interface PortalRuntimeContext {
34: /**
35: * Return the user id or null if no user is associated with the context.
36: *
37: * @return the user id
38: */
39: String getUserId();
40:
41: /**
42: * Return the portal session or null if no session is associated with the context.
43: *
44: * @return the portal session
45: */
46: PortalSession getSession();
47:
48: /**
49: * Returns the navigational state context or null if no navigational state is associated with the context.
50: *
51: * @return the navigational state context
52: */
53: NavigationalStateContext getNavigationalStateContext();
54: }
|