com.xpn.xwiki
Class XWikiContext

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class XWikiContext
extends java.util.Hashtable<java.lang.Object,java.lang.Object>

See Also:

Serialized Form

Field Summary

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

Constructor Summary

XWikiContext()

Method Summary

void	addBaseClass(BaseClass bclass)
void	addDisplayedField(java.lang.String fieldname)
void	addDocumentArchive(java.lang.String key, XWikiDocumentArchive obj)
java.lang.String	getAction()
BaseClass	getBaseClass(java.lang.String name)
int	getCacheDuration()
java.lang.String	getDatabase()
java.util.List<java.lang.String>	getDisplayedFields()
XWikiDocument	getDoc()
XWikiDocumentArchive	getDocumentArchive(java.lang.String key)
java.lang.String	getEditorWysiwyg()
XWikiEngineContext	getEngineContext()
XWikiForm	getForm()
java.lang.String	getInterfaceLanguage()
java.lang.String	getLanguage()
java.lang.String	getLinksAction()
java.lang.String	getLinksQueryString()
java.lang.String	getLocalUser()
java.lang.String	getMainXWiki()
XWikiMessageTool	getMessageTool()
int	getMode()
java.lang.String	getOriginalDatabase()
XWikiRequest	getRequest()
XWikiResponse	getResponse()
java.net.URL	getURL()
XWikiURLFactory	getURLFactory()
java.lang.String	getUser()
Util	getUtil()
XWikiValidationStatus	getValidationStatus()
XWiki	getWiki()
java.lang.String	getWikiOwner()
XWikiDocument	getWikiServer()
org.apache.xmlrpc.server.XmlRpcServer	getXMLRPCServer()
XWikiUser	getXWikiUser()
boolean	isFinished()
boolean	isMainWiki()
boolean	isMainWiki(java.lang.String wikiName)
void	setAction(java.lang.String action)
void	setCacheDuration(int cacheDuration)
void	setDatabase(java.lang.String database)
void	setDoc(XWikiDocument doc)
void	setEngineContext(XWikiEngineContext engine_context)
void	setFinished(boolean finished)
void	setForm(XWikiForm form)
void	setInterfaceLanguage(java.lang.String interfaceLanguage)
void	setLanguage(java.lang.String language)
void	setLinksAction(java.lang.String action)
void	setLinksQueryString(java.lang.String value)
void	setMainXWiki(java.lang.String str)
void	setMode(int mode)
void	setOriginalDatabase(java.lang.String database)
void	setRequest(XWikiRequest request)
void	setResponse(XWikiResponse response)
void	setURL(java.net.URL url)
void	setURLFactory(XWikiURLFactory URLFactory)
void	setUser(java.lang.String user)
void	setUser(java.lang.String user, boolean main)
void	setValidationStatus(XWikiValidationStatus status)
void	setWiki(XWiki wiki)
void	setWikiOwner(java.lang.String wikiOwner)
void	setWikiServer(XWikiDocument doc)
void	setXMLRPCServer(org.apache.xmlrpc.server.XmlRpcServer xmlRpcServer)
void	unsetLinksAction()
void	unsetLinksQueryString()

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

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

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 java.lang.String getAction()

setAction

public void setAction(java.lang.String action)

getResponse

public XWikiResponse getResponse()

setResponse

public void setResponse(XWikiResponse response)

getDatabase

public java.lang.String getDatabase()

setDatabase

public void setDatabase(java.lang.String database)

getOriginalDatabase

public java.lang.String getOriginalDatabase()

setOriginalDatabase

public void setOriginalDatabase(java.lang.String database)

isMainWiki

public boolean isMainWiki()

Returns:

true it's main wiki's context, false otherwise.

isMainWiki

public boolean isMainWiki(java.lang.String wikiName)

Parameters:

wikiName - the name of the wiki.

Returns:

true it's main wiki's context, false otherwise.

getDoc

public XWikiDocument getDoc()

setDoc

public void setDoc(XWikiDocument doc)

setUser

public void setUser(java.lang.String user,
                    boolean main)

setUser

public void setUser(java.lang.String user)

getUser

public java.lang.String getUser()

getLocalUser

public java.lang.String getLocalUser()

getXWikiUser

public XWikiUser getXWikiUser()

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

getInterfaceLanguage

public java.lang.String getInterfaceLanguage()

setInterfaceLanguage

public void setInterfaceLanguage(java.lang.String interfaceLanguage)

getMode

public int getMode()

setMode

public void setMode(int mode)

getURL

public java.net.URL getURL()

setURL

public void setURL(java.net.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()

setFinished

public void setFinished(boolean finished)

getXMLRPCServer

public org.apache.xmlrpc.server.XmlRpcServer getXMLRPCServer()

setXMLRPCServer

public void setXMLRPCServer(org.apache.xmlrpc.server.XmlRpcServer xmlRpcServer)

setWikiOwner

public void setWikiOwner(java.lang.String wikiOwner)

getWikiOwner

public java.lang.String getWikiOwner()

setWikiServer

public void setWikiServer(XWikiDocument doc)

getWikiServer

public XWikiDocument getWikiServer()

getCacheDuration

public int getCacheDuration()

setCacheDuration

public void setCacheDuration(int cacheDuration)

getMainXWiki

public java.lang.String getMainXWiki()

setMainXWiki

public void setMainXWiki(java.lang.String str)

addBaseClass

public void addBaseClass(BaseClass bclass)

getBaseClass

public BaseClass getBaseClass(java.lang.String name)

addDocumentArchive

public void addDocumentArchive(java.lang.String key,
                               XWikiDocumentArchive obj)

getDocumentArchive

public XWikiDocumentArchive getDocumentArchive(java.lang.String key)

setLinksAction

public void setLinksAction(java.lang.String action)

unsetLinksAction

public void unsetLinksAction()

getLinksAction

public java.lang.String getLinksAction()

setLinksQueryString

public void setLinksQueryString(java.lang.String value)

unsetLinksQueryString

public void unsetLinksQueryString()

getLinksQueryString

public java.lang.String getLinksQueryString()

getMessageTool

public XWikiMessageTool getMessageTool()

getValidationStatus

public XWikiValidationStatus getValidationStatus()

setValidationStatus

public void setValidationStatus(XWikiValidationStatus status)

addDisplayedField

public void addDisplayedField(java.lang.String fieldname)

getDisplayedFields

public java.util.List<java.lang.String> getDisplayedFields()

getEditorWysiwyg

public java.lang.String getEditorWysiwyg()