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.portlet;
18  
19  import javax.portlet.PortletPreferences;
20  
21  public interface PortletHeaderRequest
22  {    
23      /***
24       * Returns the web context path for the portal  
25       * @return the portal context path, for example "/jetspeed"
26       */
27      String getPortalContextPath();
28      
29      /***
30       * Returns the portlet applicatoin context path 
31       * 
32       * @return
33       */
34      String getPortletApplicationContextPath();
35      
36      /***
37       * Get the portlet preferences
38       */
39      PortletPreferences getPreferences();
40      
41      /***
42       * Get the init parameter by name
43       */
44      String getInitParameter( String name );
45  }