1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package com.xpn.xwiki

File XWikiContextInitializer.java

 

Code metrics

0
0
0
1
54
10
0
-
-
0
-

Classes

Class Line # Actions
XWikiContextInitializer 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 com.xpn.xwiki;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.context.ExecutionContext;
24   
25    /**
26    * Initialize a {@link XWikiContext} with various properties.
27    *
28    * @version $Id: dbb7b951775f54e2ca596b2d803b85270cdc719a $
29    * @since 9.11RC1
30    */
31    @Role
 
32    public interface XWikiContextInitializer
33    {
34    /**
35    * Indicate that the current user should be authenticated.
36    *
37    * @return this
38    */
39    XWikiContextInitializer authenticate();
40   
41    /**
42    * Fallback on a stub XWikiContext if there is any issue.
43    *
44    * @return this
45    */
46    XWikiContextInitializer fallbackOnStub();
47   
48    /**
49    * @param econtext the {@link ExecutionContext} to inject the {@link XWikiContext} in, or null
50    * @return an initialized {@link XWikiContext}
51    * @throws XWikiException when failing to initialize the XWiki context
52    */
53    XWikiContext initialize(ExecutionContext econtext) throws XWikiException;
54    }