View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed;
18  
19  import javax.portlet.PortletMode;
20  import javax.portlet.WindowState;
21  
22  import org.apache.jetspeed.administration.PortalConfiguration;
23  import org.apache.jetspeed.engine.Engine;
24  
25  /***
26   * Portal Context associated with running thread of the engine
27   *
28   * @author <a href="mailto:david@bluesunrise.com">David Sean Taylor</a>
29   * @version $Id: PortalContext.java 185962 2004-03-08 01:03:33Z jford $
30   */
31  public interface PortalContext extends javax.portlet.PortalContext
32  {
33      public Engine getEngine();
34  
35      public PortalConfiguration getConfiguration();
36      public void setConfiguration(PortalConfiguration configuration);
37  
38      public String getConfigurationProperty(String key);
39      public String getConfigurationProperty(String key, String defaultValue);
40  
41      public void setAttribute(String name, Object value);
42      public Object getAttribute(String name);
43  
44      /***
45       * Returns the application root for this Jetspeed engine context.
46       *
47       * @return a <code>String</code> containing the application root path for this Jetspeed context.
48       */
49      public String getApplicationRoot();
50  
51      /***
52       * Sets the application root path for this Jetspeed engine context.
53       *
54       * @param applicationRoot - the applicationRoot path on the file system.
55       */
56      public void setApplicationRoot(String applicationRoot);
57      
58      public boolean isPortletModeAllowed(PortletMode mode);
59      public boolean isWindowStateAllowed(WindowState state);
60  }