View Javadoc

1   /*
2    * $Id: TilesContextFactory.java 527536 2007-04-11 15:44:51Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.tiles.context;
22  
23  import org.apache.tiles.TilesApplicationContext;
24  
25  import java.util.Map;
26  
27  /***
28   * Creates an instance of the appropriate TilesApplicationContext implementation.
29   *
30   * @since Sep 21, 2006
31   * @version $Rev: 527536 $ $Date: 2007-04-11 17:44:51 +0200 (Wed, 11 Apr 2007) $
32   */
33  public interface TilesContextFactory {
34  
35      /***
36       * Initialize the factory.
37       *
38       * @param configurationParameters A map of parameters.
39       */
40      void init(Map<String, String> configurationParameters);
41  
42      /***
43       * Create a TilesApplicationContext for the given context.
44       *
45       * @param context The (application) context to use.
46       * @return TilesApplicationContext The Tiles application context.
47       */
48      TilesApplicationContext createApplicationContext(Object context);
49  
50      /***
51       * Create a TilesRequestContext for the given context,
52       * request, and response.
53       *
54       * @param context  the associated {@link TilesApplicationContext}
55       * @param requestItems  the associated request items, typically a request and a response.
56       * @return TilesRequestContext
57       */
58      TilesRequestContext createRequestContext(TilesApplicationContext context,
59                                               Object... requestItems);
60  }