1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.container

File RequestInitializer.java

 

Code metrics

0
0
0
1
42
7
0
-
-
0
-

Classes

Class Line # Actions
RequestInitializer 32 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.container;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Let any component that need to perform further initializations involving the Request
26    * do so. For example the Velocity component creates a brand new Velocity Context which
27    * it puts in the Request.
28    *
29    * @version $Id: 526166275b454494b1e126be8a2054da22519625 $
30    */
31    @Role
 
32    public interface RequestInitializer
33    {
34    /**
35    * Perform initializations here, such as storing objects in the Request.
36    *
37    * @param request the XWiki Request object
38    * @throws RequestInitializerException if the initialization fails. It's expected that the
39    * application should stop if this happens.
40    */
41    void initialize(Request request) throws RequestInitializerException;
42    }