| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| XWikiStubContextProvider | 36 | 0 | - | 0 | 0 |
| 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.util; | |
| 21 | ||
| 22 | import org.xwiki.component.annotation.Role; | |
| 23 | ||
| 24 | import com.xpn.xwiki.XWikiContext; | |
| 25 | ||
| 26 | /** | |
| 27 | * Tool to make easier to generate stub XWikiContext. It's supposed to be initialized once with the first request and it | |
| 28 | * can be called to get a stub context generated from this initial XWikiContext. | |
| 29 | * <p> | |
| 30 | * The reason to initialize it based on first request is to get some informations we could not know otherwise like a | |
| 31 | * default scheme/host/port. | |
| 32 | * | |
| 33 | * @version $Id: 82d8bda8039a0ec18e5fe44b7cdfcfd8ec945d90 $ | |
| 34 | */ | |
| 35 | @Role | |
| 36 | public interface XWikiStubContextProvider | |
| 37 | { | |
| 38 | /** | |
| 39 | * Initialize a stub context from a real context. | |
| 40 | * <p> | |
| 41 | * We create initial stub context from a real XWikiContext to have a stub as complete as possible. Like getting the | |
| 42 | * proper host/port/scheme, the engine context etc. | |
| 43 | * | |
| 44 | * @param context a real XWikiContext | |
| 45 | */ | |
| 46 | void initialize(XWikiContext context); | |
| 47 | ||
| 48 | /** | |
| 49 | * @return a usable XWikiContext | |
| 50 | */ | |
| 51 | XWikiContext createStubContext(); | |
| 52 | } |