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.headerresource;
18  
19  import java.util.Map;
20  
21  import javax.portlet.PortletRequest;
22  
23  import org.apache.jetspeed.container.url.BasePortalURL;
24  import org.apache.jetspeed.request.RequestContext;
25  
26  /***
27   * HeaderResourceFactory provides HeaderResource instance to manage tags, such
28   * as <link> and <script>, in <head> tag.
29   * 
30   * HeaderResourceFactory is defined by jetspeed-spring.xml. If you want to use
31   * customized HeaderResource, the parameter needs to be changed in
32   * jetspeed-spring.xml.
33   * 
34   * @author <a href="mailto:shinsuke@yahoo.co.jp">Shinsuke Sugaya</a>
35   * @version $Id: PortalReservedParameters.java 188569 2005-05-13 13:35:18Z weaver $
36   */
37  public interface HeaderResourceFactory
38  {
39  
40      /***
41       * Provides HeaderResource instance from RequestContext.
42       * 
43       * @param requestContext
44       * @return
45       */
46      public abstract HeaderResource getHeaderResouce(RequestContext requestContext);
47      
48      /***
49       * Provides HeaderResource instance from RequestContext.
50       * 
51       * @param requestContext
52       * @return
53       */
54      public abstract HeaderResource getHeaderResource( RequestContext requestContext, BasePortalURL baseUrlAccess, boolean isDesktop, Map headerConfiguration );
55  
56      /***
57       * Provides HeaderResource instance from PortletRequest.
58       * 
59       * @param request
60       * @return
61       */
62      public abstract HeaderResource getHeaderResouce(PortletRequest request);
63  
64  }