com.xpn.xwiki

Interface XWikiContextInitializer

@Role
public interface XWikiContextInitializer

Initialize a XWikiContext with various properties.

Since:

9.11RC1

Version:

$Id: dbb7b951775f54e2ca596b2d803b85270cdc719a $

Method Summary

Modifier and Type	Method and Description
XWikiContextInitializer	authenticate() Indicate that the current user should be authenticated.
XWikiContextInitializer	fallbackOnStub() Fallback on a stub XWikiContext if there is any issue.
XWikiContext	initialize(org.xwiki.context.ExecutionContext econtext)

Method Detail

authenticate

XWikiContextInitializer authenticate()

Indicate that the current user should be authenticated.

Returns:

this

fallbackOnStub

XWikiContextInitializer fallbackOnStub()

Fallback on a stub XWikiContext if there is any issue.

Returns:

this

initialize

XWikiContext initialize(org.xwiki.context.ExecutionContext econtext)
                 throws XWikiException

Parameters:

econtext - the ExecutionContext to inject the XWikiContext in, or null

Returns:

an initialized XWikiContext

Throws:

XWikiException - when failing to initialize the XWiki context