java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<Object,Object>
  - - com.xpn.xwiki.XWikiContext

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>
```
public class XWikiContext
extends Hashtable<Object,Object>
```
Represents the execution environment for all the wiki pages. An instance of the Context class is available as a predefined variable for scripting inside any wiki page. You can access it using $xcontext in Velocity scripts or simply xcontext in Groovy ones. The Context class provides a means of getting contextual information about the current request or configuring XWiki on the fly.

Version:

$Id: 77d5e73e83142360ea9a3585e338b29d44a70213 $

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`EXECUTIONCONTEXT_KEY`
`static String`	`INACTIVE_USER_REFERENCE`	The reference of a logged-in inactive user: in such case the context user reference is guest, so we store the actual logged-in user with that key.
`static String`	`KEY_LEGACY_VELOCITYCONTEXT`	Deprecated. use `VelocityManager.getVelocityContext()` instead
`protected static org.slf4j.Logger`	`LOGGER`	Logging helper object.
`static int`	`MODE_ATOM`
`static int`	`MODE_GWT`
`static int`	`MODE_GWT_DEBUG`
`static int`	`MODE_PDF`
`static int`	`MODE_PORTLET`
`static int`	`MODE_SERVLET`
`static int`	`MODE_XMLRPC`
`static ParameterizedType`	`TYPE_PROVIDER`	Type instance for `Provider<XWikiContext>`.

Constructor Summary

Constructors
Constructor Description

XWikiContext()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addBaseClass(BaseClass bclass)`
`void`	`addDisplayedField(String fieldname)`
`XWikiContext`	`clone()`
`void`	`declareInExecutionContext(org.xwiki.context.ExecutionContext executionContext)`	There are several places where the XWiki context needs to be declared in the execution, so we add a common method here.
`void`	`dropPermissions()`	Drop permissions for the remainder of the request cycle.
`void`	`flushClassCache()`	Empty the class cache.
`Object`	`get(Object key)`
`String`	`getAction()`
`DocumentReference`	`getAuthorReference()`
`BaseClass`	`getBaseClass(DocumentReference classReference)`
`int`	`getCacheDuration()`
`String`	`getDatabase()`	Deprecated. since 6.1M1, use `getWikiId()` instead
`List<String>`	`getDisplayedFields()`
`XWikiDocument`	`getDoc()`
`String`	`getEditorWysiwyg()`	Deprecated. since 8.2RC1 when we started using the Edit Module to load the configured WYSIWYG editor
`XWikiEngineContext`	`getEngineContext()`
`XWikiForm`	`getForm()`
`String`	`getInterfaceLanguage()`	Deprecated. since 6.0M1, use `getInterfaceLocale()` instead
`Locale`	`getInterfaceLocale()`
`String`	`getLanguage()`	Deprecated. since 4.3M1 use `getLocale()` instead
`String`	`getLinksAction()`
`String`	`getLinksQueryString()`
`Locale`	`getLocale()`
`String`	`getLocalUser()`	Deprecated. since 3.1M1 use `getUserReference()` instead
`String`	`getMainXWiki()`
`XWikiMessageTool`	`getMessageTool()`	Deprecated. since 4.3M2 use `ContextualLocalizationManager` component instead
`int`	`getMode()`
`String`	`getOriginalDatabase()`	Deprecated. since 6.1M1, use `getOriginalWikiId()` instead
`String`	`getOriginalWikiId()`	Get the "original" wiki id.
`XWikiRequest`	`getRequest()`
`XWikiResponse`	`getResponse()`
`URL`	`getURL()`
`XWikiURLFactory`	`getURLFactory()`
`String`	`getUser()`	Deprecated. since 3.1M1 use `getUserReference()` instead
`DocumentReference`	`getUserReference()`
`Util`	`getUtil()`
`XWikiValidationStatus`	`getValidationStatus()`
`XWiki`	`getWiki()`
`String`	`getWikiId()`
`WikiReference`	`getWikiReference()`
`XWikiDocument`	`getWikiServer()`
`XWikiUser`	`getXWikiUser()`	Deprecated. since 3.1M1 use `getUserReference()` instead
`boolean`	`hasDroppedPermissions()`
`boolean`	`isFinished()`	Define if a response has been already sent or not.
`boolean`	`isMainWiki()`
`boolean`	`isMainWiki(String wikiName)`
`boolean`	`isResponseSent()`	Define if a response has been already sent or not and if the template parsing should be done.
`Object`	`put(Object key, Object value)`
`Object`	`remove(Object key)`
`void`	`removeBaseClass(DocumentReference classReference)`
`void`	`setAction(String action)`
`void`	`setCacheDuration(int cacheDuration)`
`void`	`setDatabase(String wikiId)`	Deprecated. since 6.1M1, use `setWikiId(String)` instead
`void`	`setDoc(XWikiDocument doc)`
`void`	`setEngineContext(XWikiEngineContext engine_context)`
`void`	`setFinished(boolean finished)`	See `isFinished()`.
`void`	`setForm(XWikiForm form)`
`void`	`setInterfaceLocale(Locale interfaceLocale)`
`void`	`setLanguage(String language)`	Deprecated. since 4.3M1 use `setLocale(Locale)` instead
`void`	`setLinksAction(String action)`
`void`	`setLinksQueryString(String value)`
`void`	`setLocale(Locale locale)`
`void`	`setMainXWiki(String str)`
`void`	`setMode(int mode)`
`void`	`setOriginalDatabase(String wikiId)`	Deprecated. since 6.1M1, use `setOriginalWikiId(String)` instead
`void`	`setOriginalWikiId(String wikiId)`	Set the "original" wiki id.
`void`	`setRequest(XWikiRequest request)`
`void`	`setResponse(XWikiResponse response)`
`void`	`setResponseSent(boolean responseSent)`	See `isResponseSent()`.
`void`	`setURL(URL url)`
`void`	`setURLFactory(XWikiURLFactory URLFactory)`
`void`	`setUser(String user)`	Deprecated. since 3.1M1 use `setUserReference(DocumentReference)` instead
`void`	`setUserReference(DocumentReference userReference)`
`void`	`setValidationStatus(XWikiValidationStatus status)`
`void`	`setWiki(XWiki wiki)`
`void`	`setWikiId(String wikiId)`
`void`	`setWikiReference(WikiReference wikiReference)`
`void`	`unsetLinksAction()`
`void`	`unsetLinksQueryString()`

Methods inherited from class java.util.Hashtable
clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keys, keySet, merge, putAll, putIfAbsent, rehash, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_PROVIDER
```
public static final ParameterizedType TYPE_PROVIDER
```
    Type instance for Provider<XWikiContext>.
    
    Since:
    
    5.0M1
  - MODE_SERVLET
```
public static final int MODE_SERVLET
```
    See Also:
    
    Constant Field Values
  - MODE_PORTLET
```
public static final int MODE_PORTLET
```
    See Also:
    
    Constant Field Values
  - MODE_XMLRPC
```
public static final int MODE_XMLRPC
```
    See Also:
    
    Constant Field Values
  - MODE_ATOM
```
public static final int MODE_ATOM
```
    See Also:
    
    Constant Field Values
  - MODE_PDF
```
public static final int MODE_PDF
```
    See Also:
    
    Constant Field Values
  - MODE_GWT
```
public static final int MODE_GWT
```
    See Also:
    
    Constant Field Values
  - MODE_GWT_DEBUG
```
public static final int MODE_GWT_DEBUG
```
    See Also:
    
    Constant Field Values
  - EXECUTIONCONTEXT_KEY
```
public static final String EXECUTIONCONTEXT_KEY
```
    See Also:
    
    Constant Field Values
  - KEY_LEGACY_VELOCITYCONTEXT
```
@Deprecated
public static final String KEY_LEGACY_VELOCITYCONTEXT
```
    Deprecated.
    use VelocityManager.getVelocityContext() instead
    
    See Also:
    
    Constant Field Values
  - INACTIVE_USER_REFERENCE
```
@Unstable
public static final String INACTIVE_USER_REFERENCE
```
    The reference of a logged-in inactive user: in such case the context user reference is guest, so we store the actual logged-in user with that key.
    
    Since:
    
    14.3RC1, 13.10.5
    
    See Also:
    
    Constant Field Values
  - LOGGER
```
protected static final org.slf4j.Logger LOGGER
```
    Logging helper object.
- Constructor Detail
  - XWikiContext
```
public XWikiContext()
```
- Method Detail
  - getWiki
```
public XWiki getWiki()
```
  - getUtil
```
public Util getUtil()
```
  - setWiki
```
public void setWiki(XWiki wiki)
```
  - getEngineContext
```
public XWikiEngineContext getEngineContext()
```
  - setEngineContext
```
public void setEngineContext(XWikiEngineContext engine_context)
```
  - getRequest
```
public XWikiRequest getRequest()
```
  - setRequest
```
public void setRequest(XWikiRequest request)
```
  - getAction
```
public String getAction()
```
  - setAction
```
public void setAction(String action)
```
  - getResponse
```
public XWikiResponse getResponse()
```
  - setResponse
```
public void setResponse(XWikiResponse response)
```
  - getDatabase
```
@Deprecated
public String getDatabase()
```
    Deprecated.
    since 6.1M1, use getWikiId() instead
  - getWikiId
```
public String getWikiId()
```
    Returns:
    
    the id of the current wiki, or null if none is set
    
    Since:
    
    6.1M1
  - getWikiReference
```
public WikiReference getWikiReference()
```
    Returns:
    
    the reference of the current wiki or null if none is set
    
    Since:
    
    7.2M1
  - setDatabase
```
@Deprecated
public void setDatabase(String wikiId)
```
    Deprecated.
    since 6.1M1, use setWikiId(String) instead
    
    Parameters:
    
    wikiId - the current wiki id
  - setWikiId
```
public void setWikiId(String wikiId)
```
    Parameters:
    
    wikiId - the current wiki id
    
    Since:
    
    6.1M1
  - setWikiReference
```
public void setWikiReference(WikiReference wikiReference)
```
    Parameters:
    
    wikiReference - the current wiki reference
    
    Since:
    
    7.2M1
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map<Object,Object>
    
    Overrides:
    
    get in class Hashtable<Object,Object>
  - put
```
public Object put(Object key,
                  Object value)
```
    Make sure to keep wiki field and map synchronized.
    
    Specified by:
    
    put in interface Map<Object,Object>
    
    Overrides:
    
    put in class Hashtable<Object,Object>
    
    See Also:
    
    Hashtable.put(java.lang.Object, java.lang.Object)
  - remove
```
public Object remove(Object key)
```
    Make sure to keep wiki field and map synchronized.
    
    Specified by:
    
    remove in interface Map<Object,Object>
    
    Overrides:
    
    remove in class Hashtable<Object,Object>
    
    See Also:
    
    Hashtable.remove(java.lang.Object)
  - getOriginalDatabase
```
@Deprecated
public String getOriginalDatabase()
```
    Deprecated.
    since 6.1M1, use getOriginalWikiId() instead
    
    Get the "original" wiki id. This will be the wiki id for the wiki which the user requested. If the wiki is switched to load some piece of data, this will remember what it should be switched back to.
    
    Returns:
    
    the wiki id originally requested by the user.
  - getOriginalWikiId
```
public String getOriginalWikiId()
```
    Get the "original" wiki id. This will be the wiki id for the wiki which the user requested. If the wiki is switched to load some piece of data, this will remember what it should be switched back to.
    
    Returns:
    
    the wiki id originally requested by the user.
    
    Since:
    
    6.1M1
  - setOriginalDatabase
```
@Deprecated
public void setOriginalDatabase(String wikiId)
```
    Deprecated.
    since 6.1M1, use setOriginalWikiId(String) instead
  - setOriginalWikiId
```
public void setOriginalWikiId(String wikiId)
```
    Set the "original" wiki id. This will be the wiki id for the wiki which the user requested. If the wiki is switched to load some piece of data, this will remember what it should be switched back to.
    
    Parameters:
    
    wikiId - the wiki id originally requested by the user
    
    Since:
    
    6.1M1
  - isMainWiki
```
public boolean isMainWiki()
```
    Returns:
    
    true it's main wiki's context, false otherwise.
  - isMainWiki
```
public boolean isMainWiki(String wikiName)
```
    Parameters:
    
    wikiName - the name of the wiki.
    
    Returns:
    
    true it's main wiki's context, false otherwise.
  - getDoc
```
public XWikiDocument getDoc()
```
    Returns:
    
    the current document handled in the context or null.
  - setDoc
```
public void setDoc(XWikiDocument doc)
```
  - getUserReference
```
public DocumentReference getUserReference()
```
  - setUserReference
```
public void setUserReference(DocumentReference userReference)
```
  - setUser
```
@Deprecated
public void setUser(String user)
```
    Deprecated.
    since 3.1M1 use setUserReference(DocumentReference) instead
  - getUser
```
@Deprecated
public String getUser()
```
    Deprecated.
    since 3.1M1 use getUserReference() instead
  - getLocalUser
```
@Deprecated
public String getLocalUser()
```
    Deprecated.
    since 3.1M1 use getUserReference() instead
  - getXWikiUser
```
@Deprecated
public XWikiUser getXWikiUser()
```
    Deprecated.
    since 3.1M1 use getUserReference() instead
  - getLanguage
```
@Deprecated
public String getLanguage()
```
    Deprecated.
    since 4.3M1 use getLocale() instead
  - setLanguage
```
@Deprecated
public void setLanguage(String language)
```
    Deprecated.
    since 4.3M1 use setLocale(Locale) instead
  - getLocale
```
public Locale getLocale()
```
    Returns:
    
    the current locale
    
    Since:
    
    4.3M1
  - setLocale
```
public void setLocale(Locale locale)
```
    Parameters:
    
    locale - the current locale
    
    Since:
    
    4.3M1
  - getInterfaceLanguage
```
@Deprecated
public String getInterfaceLanguage()
```
    Deprecated.
    since 6.0M1, use getInterfaceLocale() instead
  - getInterfaceLocale
```
public Locale getInterfaceLocale()
```
    Returns:
    
    the Locale to use to display the user interface
    
    Since:
    
    6.0M1
  - setInterfaceLocale
```
public void setInterfaceLocale(Locale interfaceLocale)
```
    Parameters:
    
    interfaceLocale - the Locale to use to display the content
    
    Since:
    
    6.0M1
  - getMode
```
public int getMode()
```
  - setMode
```
public void setMode(int mode)
```
  - getURL
```
public URL getURL()
```
  - setURL
```
public void setURL(URL url)
```
  - getURLFactory
```
public XWikiURLFactory getURLFactory()
```
  - setURLFactory
```
public void setURLFactory(XWikiURLFactory URLFactory)
```
  - getForm
```
public XWikiForm getForm()
```
  - setForm
```
public void setForm(XWikiForm form)
```
  - isFinished
```
public boolean isFinished()
```
    Define if a response has been already sent or not. Note that contrary to isResponseSent() this method will ensure that the template is executed even if the result of the execution is not sent. See Utils.parseTemplate(String, boolean, XWikiContext) for details.
    
    Returns:
    
    true if the response has been sent and no new reponse should be sent anymore.
  - setFinished
```
public void setFinished(boolean finished)
```
    See isFinished().
    
    Parameters:
    
    finished - Set to true if the response has been sent.
  - isResponseSent
```
@Unstable
public boolean isResponseSent()
```
    Define if a response has been already sent or not and if the template parsing should be done. Note that contrary to isFinished() this method will always prevent the execution of the template. See Utils.parseTemplate(String, boolean, XWikiContext) for details.
    
    Returns:
    
    true if the response has been sent, no new reponse should be sent anymore and the template should not be parsed.
    
    Since:
    
    13.3RC1
  - setResponseSent
```
public void setResponseSent(boolean responseSent)
```
    See isResponseSent().
    
    Parameters:
    
    responseSent - Set to true if the response has been sent and the template should not be executed.
  - getWikiServer
```
public XWikiDocument getWikiServer()
```
  - getCacheDuration
```
public int getCacheDuration()
```
  - setCacheDuration
```
public void setCacheDuration(int cacheDuration)
```
  - getMainXWiki
```
public String getMainXWiki()
```
  - setMainXWiki
```
public void setMainXWiki(String str)
```
  - addBaseClass
```
public void addBaseClass(BaseClass bclass)
```
  - getBaseClass
```
public BaseClass getBaseClass(DocumentReference classReference)
```
    Since:
    
    2.2M2
  - removeBaseClass
```
public void removeBaseClass(DocumentReference classReference)
```
    Parameters:
    
    classReference - the reference of the class
    
    Since:
    
    9.0RC1
  - flushClassCache
```
public void flushClassCache()
```
    Empty the class cache.
  - setLinksAction
```
public void setLinksAction(String action)
```
  - unsetLinksAction
```
public void unsetLinksAction()
```
  - getLinksAction
```
public String getLinksAction()
```
  - setLinksQueryString
```
public void setLinksQueryString(String value)
```
  - unsetLinksQueryString
```
public void unsetLinksQueryString()
```
  - getLinksQueryString
```
public String getLinksQueryString()
```
  - getMessageTool
```
@Deprecated
public XWikiMessageTool getMessageTool()
```
    Deprecated.
    since 4.3M2 use ContextualLocalizationManager component instead
  - getValidationStatus
```
public XWikiValidationStatus getValidationStatus()
```
  - setValidationStatus
```
public void setValidationStatus(XWikiValidationStatus status)
```
  - addDisplayedField
```
public void addDisplayedField(String fieldname)
```
  - getDisplayedFields
```
public List<String> getDisplayedFields()
```
  - getEditorWysiwyg
```
@Deprecated
public String getEditorWysiwyg()
```
    Deprecated.
    since 8.2RC1 when we started using the Edit Module to load the configured WYSIWYG editor
    
    Returns the list of TextArea fields that use the WYSIWYG editor. This list is automatically built when displaying TextArea properties.
    
    Returns:
    
    a string containing a comma-separated list of TextArea field names for which the WYSIWYG editor should be enabled
  - dropPermissions
```
public void dropPermissions()
```
    Drop permissions for the remainder of the request cycle.
    After this is called:
    
    1. Api.hasProgrammingRights() will always return false.
    
    2. XWiki.getDocumentAsAuthor(org.xwiki.model.reference.DocumentReference), XWiki.getDocumentAsAuthor(String), Document.saveAsAuthor(), Document.saveAsAuthor(String), Document.saveAsAuthor(String, boolean), and Document.deleteAsAuthor() will perform all of their actions as if the document's content author was the guest user (XWiki.XWikiGuest).
    
    In effect, no code requiring "programming right" will run, and if the document content author (see: Document.getContentAuthor()) is a user who has "programming right", there will be no way for code following this call to save another document as this user, blessing it too with programming right.
    Once dropped, permissions cannot be regained for the duration of the request.
    If you are interested in a more flexable sandboxing method which sandboxed code only for the remainder of the rendering cycle, consider using Document.dropPermissions().
    Since:
    
    3.0M3
  - hasDroppedPermissions
```
public boolean hasDroppedPermissions()
```
    Returns:
    
    true if dropPermissions() has been called on this context, or if the XWikiConstant.DROPPED_PERMISSIONS key has been set in the ExecutionContext for this thread. This is done by calling {Document#dropPermissions()}
  - clone
```
public XWikiContext clone()
```
    Overrides:
    
    clone in class Hashtable<Object,Object>
  - declareInExecutionContext
```
public void declareInExecutionContext(org.xwiki.context.ExecutionContext executionContext)
```
    There are several places where the XWiki context needs to be declared in the execution, so we add a common method here.
    
    Parameters:
    
    executionContext - The execution context.
  - getAuthorReference
```
public DocumentReference getAuthorReference()
```
    Returns:
    
    the reference of the user being used to check script and programming right (i.e. the author of the current script)
    
    Since:
    
    8.3M2

Class XWikiContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

TYPE_PROVIDER

MODE_SERVLET

MODE_PORTLET

MODE_XMLRPC

MODE_ATOM

MODE_PDF

MODE_GWT

MODE_GWT_DEBUG

EXECUTIONCONTEXT_KEY

KEY_LEGACY_VELOCITYCONTEXT

INACTIVE_USER_REFERENCE

LOGGER

Constructor Detail

XWikiContext

Method Detail

getWiki

getUtil

setWiki

getEngineContext

setEngineContext

getRequest

setRequest

getAction

setAction

getResponse

setResponse

getDatabase

getWikiId

getWikiReference

setDatabase

setWikiId

setWikiReference

get

put

remove

getOriginalDatabase

getOriginalWikiId

setOriginalDatabase

setOriginalWikiId

isMainWiki

isMainWiki

getDoc

setDoc

getUserReference

setUserReference

setUser

getUser

getLocalUser

getXWikiUser

getLanguage

setLanguage

getLocale

setLocale

getInterfaceLanguage

getInterfaceLocale

setInterfaceLocale

getMode

setMode

getURL

setURL

getURLFactory

setURLFactory

getForm

setForm

isFinished

setFinished

isResponseSent

setResponseSent

getWikiServer

getCacheDuration

setCacheDuration

getMainXWiki

setMainXWiki