com.xpn.xwiki
Class XWiki

java.lang.Object
  extended bycom.xpn.xwiki.XWiki
All Implemented Interfaces:
XWikiDocChangeNotificationInterface, XWikiInterface

public class XWiki
extends java.lang.Object
implements XWikiDocChangeNotificationInterface, XWikiInterface


Field Summary
private  XWikiAuthService authService
           
private  XWikiCacheService cacheService
           
private  XWikiConfig config
           
private  java.lang.String database
           
private  XWikiEngineContext engine_context
           
private  java.lang.String fullNameSQL
           
private  XWikiGroupService groupService
           
private  boolean isReadOnly
           
private static org.apache.commons.logging.Log log
           
private  MetaClass metaclass
           
private  XWikiNotificationManager notificationManager
           
private  XWikiPluginManager pluginManager
           
private  XWikiRenderingEngine renderingEngine
           
private  XWikiRightService rightService
           
private  XWikiStatsService statsService
           
private  XWikiStoreInterface store
           
private  boolean test
           
private static java.util.Map threadMap
           
private  org.securityfilter.filter.URLPatternMatcher urlPatternMatcher
           
private  java.lang.String version
           
private  java.util.List virtualWikiList
           
private static java.util.Map virtualWikiMap
           
 
Fields inherited from interface com.xpn.xwiki.notify.XWikiDocChangeNotificationInterface
EVENT_CHANGE, EVENT_DELETE, EVENT_NEW, EVENT_UPDATE_CLASS, EVENT_UPDATE_CONTENT, EVENT_UPDATE_OBJECT
 
Constructor Summary
XWiki(java.io.InputStream is, XWikiContext context, XWikiEngineContext engine_context)
          Deprecated. use XWiki(XWikiConfig, XWikiContext, XWikiEngineContext, boolean) instead
XWiki(java.lang.String xwikicfgpath, XWikiContext context)
          Deprecated. use XWiki(XWikiConfig, XWikiContext) instead
XWiki(java.lang.String xwikicfgpath, XWikiContext context, XWikiEngineContext engine_context, boolean noupdate)
          Deprecated. use XWiki(XWikiConfig, XWikiContext, XWikiEngineContext, boolean) instead
XWiki(XWikiConfig config, XWikiContext context)
           
XWiki(XWikiConfig config, XWikiContext context, XWikiEngineContext engine_context, boolean noupdate)
           
 
Method Summary
static java.lang.Object callPrivateMethod(java.lang.Object obj, java.lang.String methodName)
           
static java.lang.Object callPrivateMethod(java.lang.Object obj, java.lang.String methodName, java.lang.Class[] classes, java.lang.Object[] args)
           
 boolean checkAccess(java.lang.String action, XWikiDocument doc, XWikiContext context)
           
 int checkActive(XWikiContext context)
           
 XWikiUser checkAuth(XWikiContext context)
           
 boolean copyDocument(java.lang.String docname, java.lang.String targetdocname, java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String wikilanguage, boolean reset, XWikiContext context)
           
 boolean copyDocument(java.lang.String docname, java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String wikilanguage, XWikiContext context)
           
 boolean copyDocument(java.lang.String docname, java.lang.String targetdocname, java.lang.String wikilanguage, XWikiContext context)
           
 boolean copyDocument(java.lang.String docname, java.lang.String targetdocname, XWikiContext context)
           
 int copyWiki(java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String language, XWikiContext context)
           
 int copyWikiWeb(java.lang.String web, java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String wikilanguage, XWikiContext context)
           
 int createNewWiki(java.lang.String wikiName, java.lang.String wikiUrl, java.lang.String wikiAdmin, java.lang.String baseWikiName, java.lang.String description, java.lang.String wikilanguage, boolean failOnExist, XWikiContext context)
           
 int createUser(boolean withValidation, java.lang.String userRights, XWikiContext context)
           
 int createUser(java.lang.String xwikiname, java.util.Map map, java.lang.String parent, java.lang.String content, java.lang.String userRights, XWikiContext context)
           
 int createUser(XWikiContext context)
           
 void deleteDocument(XWikiDocument doc, XWikiContext context)
           
 boolean exists(java.lang.String fullname, XWikiContext context)
           
private static java.lang.String findWikiServer(java.lang.String host, XWikiContext context)
           
 void flushCache()
           
 java.lang.String formatDate(java.util.Date date, java.lang.String format, XWikiContext context)
           
 long freeMemory()
           
 void gc()
           
 java.lang.String generateValidationKey(int size)
           
 java.lang.String getAdClientId(XWikiContext context)
           
 java.lang.String getAdType(XWikiContext context)
           
 java.lang.String getAttachmentURL(java.lang.String fullname, java.lang.String filename, XWikiContext context)
           
 XWikiAuthService getAuthService()
           
 java.lang.String getBaseSkin(XWikiContext context)
           
 java.lang.String getBaseSkin(XWikiContext context, boolean fromRenderSkin)
           
 XWikiCacheService getCacheService()
           
 java.util.List getClassList(XWikiContext context)
           
 BaseClass getCommentsClass(XWikiContext context)
           
 XWikiConfig getConfig()
           
 java.util.Date getCurrentDate()
           
 java.lang.String getDatabase()
           
 java.util.Date getDate(long time)
           
 java.lang.String getDefaultBaseSkin(XWikiContext context)
           
 java.lang.String getDocName(java.lang.String docname)
           
 XWikiDocument getDocument(java.lang.String web, java.lang.String fullname, XWikiContext context)
           
 XWikiDocument getDocument(java.lang.String fullname, XWikiContext context)
           
 XWikiDocument getDocument(XWikiDocument doc, java.lang.String revision, XWikiContext context)
           
private  XWikiDocument getDocument(XWikiDocument doc, XWikiContext context)
           
 XWikiDocument getDocumentFromPath(java.lang.String path, XWikiContext context)
           
 java.lang.String getEncoding()
           
 XWikiEngineContext getEngineContext()
           
 java.lang.String getFlash(java.lang.String url, java.lang.String width, java.lang.String height, XWikiContext context)
           
static java.lang.String getFormEncoded(java.lang.String content)
           
 java.lang.String getFullNameSQL()
           
 BaseClass getGlobalRightsClass(XWikiContext context)
           
 BaseClass getGroupClass(XWikiContext context)
           
 XWikiGroupService getGroupService()
           
 XWikiHibernateStore getHibernateStore()
           
 java.lang.String getHTMLArea(java.lang.String content, XWikiContext context)
           
 java.util.List getIncludedMacros(java.lang.String defaultweb, java.lang.String content, XWikiContext context)
           
 java.lang.String getLanguagePreference(XWikiContext context)
           
 java.lang.String getLocalUserName(java.lang.String user, java.lang.String format, boolean link, XWikiContext context)
           
 java.lang.String getLocalUserName(java.lang.String user, java.lang.String format, XWikiContext context)
           
 java.lang.String getLocalUserName(java.lang.String user, XWikiContext context)
           
static XWiki getMainXWiki(XWikiContext context)
           
 MetaClass getMetaclass()
           
 XWikiNotificationManager getNotificationManager()
           
 XWikiPluginInterface getPlugin(java.lang.String name, XWikiContext context)
           
 Api getPluginApi(java.lang.String name, XWikiContext context)
           
 XWikiPluginManager getPluginManager()
           
 java.lang.Object getPortalService(java.lang.String className)
           
 BaseClass getPrefsClass(XWikiContext context)
           
static java.lang.Object getPrivateField(java.lang.Object obj, java.lang.String fieldName)
           
 java.lang.String getRealPath(java.lang.String path)
           
 java.lang.String getRefererText(java.lang.String referer, XWikiContext context)
           
 XWikiRenderingEngine getRenderingEngine()
           
static java.net.URL getRequestURL(XWikiRequest request)
           
 java.net.URL getResource(java.lang.String s)
           
 java.io.InputStream getResourceAsStream(java.lang.String s)
           
 java.lang.String getResourceContent(java.lang.String name)
           
 BaseClass getRightsClass(java.lang.String pagename, XWikiContext context)
           
 BaseClass getRightsClass(XWikiContext context)
           
 XWikiRightService getRightService()
           
private  java.util.Map getSearchEngineRules(XWikiContext context)
           
 java.net.URL getServerURL(java.lang.String database, XWikiContext context)
           
static java.lang.String getServerWikiPage(java.lang.String servername)
           
 java.lang.Object getService(java.lang.String className)
           
 java.lang.String getSkin(XWikiContext context)
           
 BaseClass getSkinClass(XWikiContext context)
           
 java.lang.String getSkinFile(java.lang.String filename, java.lang.String skin, XWikiContext context)
           
 java.lang.String getSkinFile(java.lang.String filename, XWikiContext context)
           
 java.util.List getSpaceDocsName(java.lang.String spaceName, XWikiContext context)
           
 java.util.List getSpaces(XWikiContext context)
           
 XWikiStatsService getStatsService(XWikiContext context)
           
 XWikiStoreInterface getStore()
           
static java.lang.String getTextArea(java.lang.String content, XWikiContext context)
           
static java.util.Map getThreadMap()
           
 int getTimeDelta(long time)
           
 java.lang.String getURL(java.lang.String fullname, java.lang.String action, java.lang.String querystring, XWikiContext context)
           
 java.lang.String getURL(java.lang.String fullname, java.lang.String action, XWikiContext context)
           
 java.lang.String getURLContent(java.lang.String surl)
           
 java.lang.String getURLContent(java.lang.String surl, java.lang.String username, java.lang.String password)
           
static java.lang.String getURLEncoded(java.lang.String content)
           
 org.securityfilter.filter.URLPatternMatcher getUrlPatternMatcher()
           
 User getUser(XWikiContext context)
           
 BaseClass getUserClass(XWikiContext context)
           
 java.lang.String getUserName(java.lang.String user, java.lang.String format, boolean link, XWikiContext context)
           
 java.lang.String getUserName(java.lang.String user, java.lang.String format, XWikiContext context)
           
 java.lang.String getUserName(java.lang.String user, XWikiContext context)
           
 java.lang.String getUserPreference(java.lang.String prefname, boolean useCookie, XWikiContext context)
           
 java.lang.String getUserPreference(java.lang.String prefname, XWikiContext context)
           
 int getUserPreferenceAsInt(java.lang.String prefname, XWikiContext context)
           
 long getUserPreferenceAsLong(java.lang.String prefname, XWikiContext context)
           
 java.lang.String getUserPreferenceFromCookie(java.lang.String prefname, XWikiContext context)
           
 java.lang.String getVersion()
           
 java.util.List getVirtualWikiList()
           
 java.lang.String getWebCopyright(XWikiContext context)
           
 java.lang.String getWebPreference(java.lang.String prefname, java.lang.String default_value, XWikiContext context)
           
 java.lang.String getWebPreference(java.lang.String prefname, XWikiContext context)
           
 int getWebPreferenceAsInt(java.lang.String prefname, int default_value, XWikiContext context)
           
 int getWebPreferenceAsInt(java.lang.String prefname, XWikiContext context)
           
 long getWebPreferenceAsLong(java.lang.String prefname, long default_value, XWikiContext context)
           
 long getWebPreferenceAsLong(java.lang.String prefname, XWikiContext context)
           
static java.lang.String getXMLEncoded(java.lang.String content)
           
static XWiki getXWiki(XWikiContext context)
           
 java.lang.String getXWikiPreference(java.lang.String prefname, java.lang.String default_value, XWikiContext context)
           
 java.lang.String getXWikiPreference(java.lang.String prefname, XWikiContext context)
           
 int getXWikiPreferenceAsInt(java.lang.String prefname, int default_value, XWikiContext context)
           
 int getXWikiPreferenceAsInt(java.lang.String prefname, XWikiContext context)
           
 long getXWikiPreferenceAsLong(java.lang.String prefname, long default_value, XWikiContext context)
           
 long getXWikiPreferenceAsLong(java.lang.String prefname, XWikiContext context)
           
 java.util.zip.ZipOutputStream getZipOutputStream(XWikiContext context)
           
 java.lang.String include(java.lang.String topic, XWikiContext context, boolean isForm)
           
 void initXWiki(XWikiConfig config, XWikiContext context, XWikiEngineContext engine_context, boolean noupdate)
           
 java.lang.String invokeServletAndReturnAsString(java.lang.String url, XWikiContext xwikiContext)
          Designed to include dynamic content, such as Servlets or JSPs, inside Velocity templates; works by creating a RequestDispatcher, buffering the output, then returning it as a string.
 boolean isExo()
           
 boolean isLDAP()
           
 boolean isMultiLingual(XWikiContext context)
           
 boolean isMySQL()
           
 boolean isReadOnly()
          accessor for the isReadOnly instance var.
 boolean isTest()
           
 boolean isVirtual()
           
 long maxMemory()
           
 void notify(XWikiNotificationRule rule, XWikiDocument newdoc, XWikiDocument olddoc, int event, XWikiContext context)
           
 java.lang.String Param(java.lang.String key)
           
 java.lang.String Param(java.lang.String key, java.lang.String default_value)
           
 long ParamAsLong(java.lang.String key)
           
 long ParamAsLong(java.lang.String key, long default_value)
           
 java.lang.String ParamAsRealPath(java.lang.String key)
           
 java.lang.String ParamAsRealPath(java.lang.String key, XWikiContext context)
           
 java.lang.String ParamAsRealPathVerified(java.lang.String param)
           
 java.lang.String parseContent(java.lang.String content, XWikiContext context)
           
 java.lang.String parseTemplate(java.lang.String template, java.lang.String skin, XWikiContext context)
           
 java.lang.String parseTemplate(java.lang.String template, XWikiContext context)
           
 boolean prepareDocuments(XWikiRequest request, XWikiContext context, org.apache.velocity.VelocityContext vcontext)
           
private  void preparePlugins(XWikiContext context)
           
 void prepareResources(XWikiContext context)
           
 java.lang.String printStrackTrace(java.lang.Throwable e)
           
 void ProtectUserPage(XWikiContext context, java.lang.String fullwikiname, java.lang.String userRights, XWikiDocument doc)
           
 boolean resourceExists(java.lang.String name)
           
 void saveDocument(XWikiDocument doc, XWikiContext context)
           
 void saveDocument(XWikiDocument doc, XWikiDocument olddoc, XWikiContext context)
           
 java.util.List search(java.lang.String sql, int nb, int start, java.lang.Object[][] whereParams, XWikiContext context)
           
 java.util.List search(java.lang.String sql, int nb, int start, XWikiContext context)
           
 java.util.List search(java.lang.String sql, java.lang.Object[][] whereParams, XWikiContext context)
           
 java.util.List search(java.lang.String sql, XWikiContext context)
           
 void sendMessage(java.lang.String sender, java.lang.String[] recipient, java.lang.String message, XWikiContext context)
           
 void sendMessage(java.lang.String sender, java.lang.String recipient, java.lang.String message, XWikiContext context)
           
 void sendValidationEmail(java.lang.String xwikiname, java.lang.String password, java.lang.String email, java.lang.String validkey, java.lang.String contentfield, XWikiContext context)
           
 void setAuthService(XWikiAuthService authService)
           
 void setConfig(XWikiConfig config)
           
 void setDatabase(java.lang.String database)
           
 void setEngineContext(XWikiEngineContext engine_context)
           
 void setGroupService(XWikiGroupService groupService)
           
 void setMetaclass(MetaClass metaclass)
           
 void setNotificationManager(XWikiNotificationManager notificationManager)
           
 void setPluginManager(XWikiPluginManager pluginManager)
           
 void setReadOnly(boolean readOnly)
           
 void setRenderingEngine(XWikiRenderingEngine renderingEngine)
           
 void setRightService(XWikiRightService rightService)
           
 void setStore(XWikiStoreInterface store)
           
 void setTest(boolean test)
           
static void setThreadMap(java.util.Map threadMap)
           
 void setUrlPatternMatcher(org.securityfilter.filter.URLPatternMatcher urlPatternMatcher)
           
 void SetUserDefaultGroup(XWikiContext context, java.lang.String fullwikiname)
           
 void setVersion(java.lang.String version)
           
 java.lang.String[] split(java.lang.String str, java.lang.String sep)
           
 long totalMemory()
           
 void updateDatabase(java.lang.String appname, boolean force, XWikiContext context)
           
 void updateDatabase(java.lang.String appname, XWikiContext context)
           
 int validateUser(boolean withConfirmEmail, XWikiContext context)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static final org.apache.commons.logging.Log log

config

private XWikiConfig config

store

private XWikiStoreInterface store

renderingEngine

private XWikiRenderingEngine renderingEngine

pluginManager

private XWikiPluginManager pluginManager

notificationManager

private XWikiNotificationManager notificationManager

authService

private XWikiAuthService authService

rightService

private XWikiRightService rightService

groupService

private XWikiGroupService groupService

statsService

private XWikiStatsService statsService

cacheService

private XWikiCacheService cacheService

metaclass

private MetaClass metaclass

test

private boolean test

version

private java.lang.String version

engine_context

private XWikiEngineContext engine_context

database

private java.lang.String database

fullNameSQL

private java.lang.String fullNameSQL

urlPatternMatcher

private org.securityfilter.filter.URLPatternMatcher urlPatternMatcher

virtualWikiList

private java.util.List virtualWikiList

virtualWikiMap

private static java.util.Map virtualWikiMap

threadMap

private static java.util.Map threadMap

isReadOnly

private boolean isReadOnly
Constructor Detail

XWiki

public XWiki(XWikiConfig config,
             XWikiContext context)
      throws XWikiException

XWiki

public XWiki(XWikiConfig config,
             XWikiContext context,
             XWikiEngineContext engine_context,
             boolean noupdate)
      throws XWikiException

XWiki

public XWiki(java.lang.String xwikicfgpath,
             XWikiContext context)
      throws XWikiException
Deprecated. use XWiki(XWikiConfig, XWikiContext) instead


XWiki

public XWiki(java.lang.String xwikicfgpath,
             XWikiContext context,
             XWikiEngineContext engine_context,
             boolean noupdate)
      throws XWikiException
Deprecated. use XWiki(XWikiConfig, XWikiContext, XWikiEngineContext, boolean) instead


XWiki

public XWiki(java.io.InputStream is,
             XWikiContext context,
             XWikiEngineContext engine_context)
      throws XWikiException
Deprecated. use XWiki(XWikiConfig, XWikiContext, XWikiEngineContext, boolean) instead

Method Detail

getMainXWiki

public static XWiki getMainXWiki(XWikiContext context)
                          throws XWikiException
Throws:
XWikiException

getHibernateStore

public XWikiHibernateStore getHibernateStore()

updateDatabase

public void updateDatabase(java.lang.String appname,
                           XWikiContext context)
                    throws org.hibernate.HibernateException,
                           XWikiException
Specified by:
updateDatabase in interface XWikiInterface
Throws:
org.hibernate.HibernateException
XWikiException

updateDatabase

public void updateDatabase(java.lang.String appname,
                           boolean force,
                           XWikiContext context)
                    throws org.hibernate.HibernateException,
                           XWikiException
Throws:
org.hibernate.HibernateException
XWikiException

getVirtualWikiList

public java.util.List getVirtualWikiList()
Specified by:
getVirtualWikiList in interface XWikiInterface

getXWiki

public static XWiki getXWiki(XWikiContext context)
                      throws XWikiException
Throws:
XWikiException

getRequestURL

public static java.net.URL getRequestURL(XWikiRequest request)
                                  throws XWikiException
Throws:
XWikiException

findWikiServer

private static java.lang.String findWikiServer(java.lang.String host,
                                               XWikiContext context)

getServerWikiPage

public static java.lang.String getServerWikiPage(java.lang.String servername)

initXWiki

public void initXWiki(XWikiConfig config,
                      XWikiContext context,
                      XWikiEngineContext engine_context,
                      boolean noupdate)
               throws XWikiException
Specified by:
initXWiki in interface XWikiInterface
Throws:
XWikiException

preparePlugins

private void preparePlugins(XWikiContext context)

getVersion

public java.lang.String getVersion()
Specified by:
getVersion in interface XWikiInterface

getResource

public java.net.URL getResource(java.lang.String s)
                         throws java.net.MalformedURLException
Specified by:
getResource in interface XWikiInterface
Throws:
java.net.MalformedURLException

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String s)
                                        throws java.net.MalformedURLException
Specified by:
getResourceAsStream in interface XWikiInterface
Throws:
java.net.MalformedURLException

getResourceContent

public java.lang.String getResourceContent(java.lang.String name)
                                    throws java.io.IOException
Specified by:
getResourceContent in interface XWikiInterface
Throws:
java.io.IOException

resourceExists

public boolean resourceExists(java.lang.String name)
Specified by:
resourceExists in interface XWikiInterface

getConfig

public XWikiConfig getConfig()
Specified by:
getConfig in interface XWikiInterface

getRealPath

public java.lang.String getRealPath(java.lang.String path)
Specified by:
getRealPath in interface XWikiInterface

Param

public java.lang.String Param(java.lang.String key)
Specified by:
Param in interface XWikiInterface

ParamAsRealPath

public java.lang.String ParamAsRealPath(java.lang.String key)
Specified by:
ParamAsRealPath in interface XWikiInterface

ParamAsRealPath

public java.lang.String ParamAsRealPath(java.lang.String key,
                                        XWikiContext context)
Specified by:
ParamAsRealPath in interface XWikiInterface

ParamAsRealPathVerified

public java.lang.String ParamAsRealPathVerified(java.lang.String param)
Specified by:
ParamAsRealPathVerified in interface XWikiInterface

Param

public java.lang.String Param(java.lang.String key,
                              java.lang.String default_value)
Specified by:
Param in interface XWikiInterface

ParamAsLong

public long ParamAsLong(java.lang.String key)
Specified by:
ParamAsLong in interface XWikiInterface

ParamAsLong

public long ParamAsLong(java.lang.String key,
                        long default_value)
Specified by:
ParamAsLong in interface XWikiInterface

getStore

public XWikiStoreInterface getStore()
Specified by:
getStore in interface XWikiInterface

saveDocument

public void saveDocument(XWikiDocument doc,
                         XWikiContext context)
                  throws XWikiException
Specified by:
saveDocument in interface XWikiInterface
Throws:
XWikiException

saveDocument

public void saveDocument(XWikiDocument doc,
                         XWikiDocument olddoc,
                         XWikiContext context)
                  throws XWikiException
Specified by:
saveDocument in interface XWikiInterface
Throws:
XWikiException

getDocument

private XWikiDocument getDocument(XWikiDocument doc,
                                  XWikiContext context)
                           throws XWikiException
Throws:
XWikiException

getDocument

public XWikiDocument getDocument(XWikiDocument doc,
                                 java.lang.String revision,
                                 XWikiContext context)
                          throws XWikiException
Specified by:
getDocument in interface XWikiInterface
Throws:
XWikiException

getDocument

public XWikiDocument getDocument(java.lang.String fullname,
                                 XWikiContext context)
                          throws XWikiException
Specified by:
getDocument in interface XWikiInterface
Throws:
XWikiException

getDocument

public XWikiDocument getDocument(java.lang.String web,
                                 java.lang.String fullname,
                                 XWikiContext context)
                          throws XWikiException
Specified by:
getDocument in interface XWikiInterface
Throws:
XWikiException

getDocumentFromPath

public XWikiDocument getDocumentFromPath(java.lang.String path,
                                         XWikiContext context)
                                  throws XWikiException
Specified by:
getDocumentFromPath in interface XWikiInterface
Throws:
XWikiException

getRenderingEngine

public XWikiRenderingEngine getRenderingEngine()
Specified by:
getRenderingEngine in interface XWikiInterface

setRenderingEngine

public void setRenderingEngine(XWikiRenderingEngine renderingEngine)
Specified by:
setRenderingEngine in interface XWikiInterface

getMetaclass

public MetaClass getMetaclass()
Specified by:
getMetaclass in interface XWikiInterface

setMetaclass

public void setMetaclass(MetaClass metaclass)
Specified by:
setMetaclass in interface XWikiInterface

getFormEncoded

public static java.lang.String getFormEncoded(java.lang.String content)

getURLEncoded

public static java.lang.String getURLEncoded(java.lang.String content)

getXMLEncoded

public static java.lang.String getXMLEncoded(java.lang.String content)

getTextArea

public static java.lang.String getTextArea(java.lang.String content,
                                           XWikiContext context)

getHTMLArea

public java.lang.String getHTMLArea(java.lang.String content,
                                    XWikiContext context)

getClassList

public java.util.List getClassList(XWikiContext context)
                            throws XWikiException
Specified by:
getClassList in interface XWikiInterface
Throws:
XWikiException

search

public java.util.List search(java.lang.String sql,
                             XWikiContext context)
                      throws XWikiException
Specified by:
search in interface XWikiInterface
Throws:
XWikiException

search

public java.util.List search(java.lang.String sql,
                             int nb,
                             int start,
                             XWikiContext context)
                      throws XWikiException
Specified by:
search in interface XWikiInterface
Throws:
XWikiException

search

public java.util.List search(java.lang.String sql,
                             java.lang.Object[][] whereParams,
                             XWikiContext context)
                      throws XWikiException
Throws:
XWikiException

search

public java.util.List search(java.lang.String sql,
                             int nb,
                             int start,
                             java.lang.Object[][] whereParams,
                             XWikiContext context)
                      throws XWikiException
Throws:
XWikiException

isTest

public boolean isTest()
Specified by:
isTest in interface XWikiInterface

setTest

public void setTest(boolean test)
Specified by:
setTest in interface XWikiInterface

parseContent

public java.lang.String parseContent(java.lang.String content,
                                     XWikiContext context)
Specified by:
parseContent in interface XWikiInterface

parseTemplate

public java.lang.String parseTemplate(java.lang.String template,
                                      XWikiContext context)
Specified by:
parseTemplate in interface XWikiInterface

parseTemplate

public java.lang.String parseTemplate(java.lang.String template,
                                      java.lang.String skin,
                                      XWikiContext context)

invokeServletAndReturnAsString

public java.lang.String invokeServletAndReturnAsString(java.lang.String url,
                                                       XWikiContext xwikiContext)
Designed to include dynamic content, such as Servlets or JSPs, inside Velocity templates; works by creating a RequestDispatcher, buffering the output, then returning it as a string.


getSkinFile

public java.lang.String getSkinFile(java.lang.String filename,
                                    XWikiContext context)
Specified by:
getSkinFile in interface XWikiInterface

getSkinFile

public java.lang.String getSkinFile(java.lang.String filename,
                                    java.lang.String skin,
                                    XWikiContext context)

getSkin

public java.lang.String getSkin(XWikiContext context)
Specified by:
getSkin in interface XWikiInterface

getDefaultBaseSkin

public java.lang.String getDefaultBaseSkin(XWikiContext context)

getBaseSkin

public java.lang.String getBaseSkin(XWikiContext context)

getBaseSkin

public java.lang.String getBaseSkin(XWikiContext context,
                                    boolean fromRenderSkin)

getWebCopyright

public java.lang.String getWebCopyright(XWikiContext context)
Specified by:
getWebCopyright in interface XWikiInterface

getXWikiPreference

public java.lang.String getXWikiPreference(java.lang.String prefname,
                                           XWikiContext context)
Specified by:
getXWikiPreference in interface XWikiInterface

getXWikiPreference

public java.lang.String getXWikiPreference(java.lang.String prefname,
                                           java.lang.String default_value,
                                           XWikiContext context)
Specified by:
getXWikiPreference in interface XWikiInterface

getWebPreference

public java.lang.String getWebPreference(java.lang.String prefname,
                                         XWikiContext context)
Specified by:
getWebPreference in interface XWikiInterface

getWebPreference

public java.lang.String getWebPreference(java.lang.String prefname,
                                         java.lang.String default_value,
                                         XWikiContext context)
Specified by:
getWebPreference in interface XWikiInterface

getUserPreference

public java.lang.String getUserPreference(java.lang.String prefname,
                                          XWikiContext context)
Specified by:
getUserPreference in interface XWikiInterface

getUserPreferenceFromCookie

public java.lang.String getUserPreferenceFromCookie(java.lang.String prefname,
                                                    XWikiContext context)
Specified by:
getUserPreferenceFromCookie in interface XWikiInterface

getUserPreference

public java.lang.String getUserPreference(java.lang.String prefname,
                                          boolean useCookie,
                                          XWikiContext context)
Specified by:
getUserPreference in interface XWikiInterface

getLanguagePreference

public java.lang.String getLanguagePreference(XWikiContext context)
Specified by:
getLanguagePreference in interface XWikiInterface

getXWikiPreferenceAsLong

public long getXWikiPreferenceAsLong(java.lang.String prefname,
                                     XWikiContext context)
Specified by:
getXWikiPreferenceAsLong in interface XWikiInterface

getWebPreferenceAsLong

public long getWebPreferenceAsLong(java.lang.String prefname,
                                   XWikiContext context)
Specified by:
getWebPreferenceAsLong in interface XWikiInterface

getXWikiPreferenceAsLong

public long getXWikiPreferenceAsLong(java.lang.String prefname,
                                     long default_value,
                                     XWikiContext context)
Specified by:
getXWikiPreferenceAsLong in interface XWikiInterface

getWebPreferenceAsLong

public long getWebPreferenceAsLong(java.lang.String prefname,
                                   long default_value,
                                   XWikiContext context)
Specified by:
getWebPreferenceAsLong in interface XWikiInterface

getUserPreferenceAsLong

public long getUserPreferenceAsLong(java.lang.String prefname,
                                    XWikiContext context)

getXWikiPreferenceAsInt

public int getXWikiPreferenceAsInt(java.lang.String prefname,
                                   XWikiContext context)
Specified by:
getXWikiPreferenceAsInt in interface XWikiInterface

getWebPreferenceAsInt

public int getWebPreferenceAsInt(java.lang.String prefname,
                                 XWikiContext context)
Specified by:
getWebPreferenceAsInt in interface XWikiInterface

getXWikiPreferenceAsInt

public int getXWikiPreferenceAsInt(java.lang.String prefname,
                                   int default_value,
                                   XWikiContext context)
Specified by:
getXWikiPreferenceAsInt in interface XWikiInterface

getWebPreferenceAsInt

public int getWebPreferenceAsInt(java.lang.String prefname,
                                 int default_value,
                                 XWikiContext context)
Specified by:
getWebPreferenceAsInt in interface XWikiInterface

getUserPreferenceAsInt

public int getUserPreferenceAsInt(java.lang.String prefname,
                                  XWikiContext context)

flushCache

public void flushCache()
Specified by:
flushCache in interface XWikiInterface

getPluginManager

public XWikiPluginManager getPluginManager()
Specified by:
getPluginManager in interface XWikiInterface

setPluginManager

public void setPluginManager(XWikiPluginManager pluginManager)
Specified by:
setPluginManager in interface XWikiInterface

setConfig

public void setConfig(XWikiConfig config)
Specified by:
setConfig in interface XWikiInterface

setStore

public void setStore(XWikiStoreInterface store)
Specified by:
setStore in interface XWikiInterface

setVersion

public void setVersion(java.lang.String version)
Specified by:
setVersion in interface XWikiInterface

getNotificationManager

public XWikiNotificationManager getNotificationManager()
Specified by:
getNotificationManager in interface XWikiInterface

setNotificationManager

public void setNotificationManager(XWikiNotificationManager notificationManager)
Specified by:
setNotificationManager in interface XWikiInterface

notify

public void notify(XWikiNotificationRule rule,
                   XWikiDocument newdoc,
                   XWikiDocument olddoc,
                   int event,
                   XWikiContext context)
Specified by:
notify in interface XWikiDocChangeNotificationInterface

getUserClass

public BaseClass getUserClass(XWikiContext context)
                       throws XWikiException
Specified by:
getUserClass in interface XWikiInterface
Throws:
XWikiException

getPrefsClass

public BaseClass getPrefsClass(XWikiContext context)
                        throws XWikiException
Throws:
XWikiException

getGroupClass

public BaseClass getGroupClass(XWikiContext context)
                        throws XWikiException
Specified by:
getGroupClass in interface XWikiInterface
Throws:
XWikiException

getRightsClass

public BaseClass getRightsClass(java.lang.String pagename,
                                XWikiContext context)
                         throws XWikiException
Specified by:
getRightsClass in interface XWikiInterface
Throws:
XWikiException

getRightsClass

public BaseClass getRightsClass(XWikiContext context)
                         throws XWikiException
Specified by:
getRightsClass in interface XWikiInterface
Throws:
XWikiException

getGlobalRightsClass

public BaseClass getGlobalRightsClass(XWikiContext context)
                               throws XWikiException
Specified by:
getGlobalRightsClass in interface XWikiInterface
Throws:
XWikiException

getCommentsClass

public BaseClass getCommentsClass(XWikiContext context)
                           throws XWikiException
Throws:
XWikiException

getSkinClass

public BaseClass getSkinClass(XWikiContext context)
                       throws XWikiException
Throws:
XWikiException

createUser

public int createUser(XWikiContext context)
               throws XWikiException
Specified by:
createUser in interface XWikiInterface
Throws:
XWikiException

validateUser

public int validateUser(boolean withConfirmEmail,
                        XWikiContext context)
                 throws XWikiException
Specified by:
validateUser in interface XWikiInterface
Throws:
XWikiException

createUser

public int createUser(boolean withValidation,
                      java.lang.String userRights,
                      XWikiContext context)
               throws XWikiException
Specified by:
createUser in interface XWikiInterface
Throws:
XWikiException

sendValidationEmail

public void sendValidationEmail(java.lang.String xwikiname,
                                java.lang.String password,
                                java.lang.String email,
                                java.lang.String validkey,
                                java.lang.String contentfield,
                                XWikiContext context)
                         throws XWikiException
Specified by:
sendValidationEmail in interface XWikiInterface
Throws:
XWikiException

sendMessage

public void sendMessage(java.lang.String sender,
                        java.lang.String[] recipient,
                        java.lang.String message,
                        XWikiContext context)
                 throws XWikiException
Specified by:
sendMessage in interface XWikiInterface
Throws:
XWikiException

sendMessage

public void sendMessage(java.lang.String sender,
                        java.lang.String recipient,
                        java.lang.String message,
                        XWikiContext context)
                 throws XWikiException
Specified by:
sendMessage in interface XWikiInterface
Throws:
XWikiException

generateValidationKey

public java.lang.String generateValidationKey(int size)
Specified by:
generateValidationKey in interface XWikiInterface

createUser

public int createUser(java.lang.String xwikiname,
                      java.util.Map map,
                      java.lang.String parent,
                      java.lang.String content,
                      java.lang.String userRights,
                      XWikiContext context)
               throws XWikiException
Specified by:
createUser in interface XWikiInterface
Throws:
XWikiException

SetUserDefaultGroup

public void SetUserDefaultGroup(XWikiContext context,
                                java.lang.String fullwikiname)
                         throws XWikiException
Throws:
XWikiException

ProtectUserPage

public void ProtectUserPage(XWikiContext context,
                            java.lang.String fullwikiname,
                            java.lang.String userRights,
                            XWikiDocument doc)
                     throws XWikiException
Throws:
XWikiException

getUser

public User getUser(XWikiContext context)
Specified by:
getUser in interface XWikiInterface

prepareResources

public void prepareResources(XWikiContext context)
Specified by:
prepareResources in interface XWikiInterface

checkAuth

public XWikiUser checkAuth(XWikiContext context)
                    throws XWikiException
Specified by:
checkAuth in interface XWikiInterface
Throws:
XWikiException

checkAccess

public boolean checkAccess(java.lang.String action,
                           XWikiDocument doc,
                           XWikiContext context)
                    throws XWikiException
Specified by:
checkAccess in interface XWikiInterface
Throws:
XWikiException

include

public java.lang.String include(java.lang.String topic,
                                XWikiContext context,
                                boolean isForm)
                         throws XWikiException
Specified by:
include in interface XWikiInterface
Throws:
XWikiException

deleteDocument

public void deleteDocument(XWikiDocument doc,
                           XWikiContext context)
                    throws XWikiException
Specified by:
deleteDocument in interface XWikiInterface
Throws:
XWikiException

getDatabase

public java.lang.String getDatabase()
Specified by:
getDatabase in interface XWikiInterface

setDatabase

public void setDatabase(java.lang.String database)
Specified by:
setDatabase in interface XWikiInterface

gc

public void gc()
Specified by:
gc in interface XWikiInterface

freeMemory

public long freeMemory()
Specified by:
freeMemory in interface XWikiInterface

totalMemory

public long totalMemory()
Specified by:
totalMemory in interface XWikiInterface

maxMemory

public long maxMemory()
Specified by:
maxMemory in interface XWikiInterface

getPrivateField

public static java.lang.Object getPrivateField(java.lang.Object obj,
                                               java.lang.String fieldName)

callPrivateMethod

public static java.lang.Object callPrivateMethod(java.lang.Object obj,
                                                 java.lang.String methodName)

callPrivateMethod

public static java.lang.Object callPrivateMethod(java.lang.Object obj,
                                                 java.lang.String methodName,
                                                 java.lang.Class[] classes,
                                                 java.lang.Object[] args)

split

public java.lang.String[] split(java.lang.String str,
                                java.lang.String sep)
Specified by:
split in interface XWikiInterface

printStrackTrace

public java.lang.String printStrackTrace(java.lang.Throwable e)
Specified by:
printStrackTrace in interface XWikiInterface

copyDocument

public boolean copyDocument(java.lang.String docname,
                            java.lang.String targetdocname,
                            XWikiContext context)
                     throws XWikiException
Throws:
XWikiException

copyDocument

public boolean copyDocument(java.lang.String docname,
                            java.lang.String targetdocname,
                            java.lang.String wikilanguage,
                            XWikiContext context)
                     throws XWikiException
Throws:
XWikiException

copyDocument

public boolean copyDocument(java.lang.String docname,
                            java.lang.String sourceWiki,
                            java.lang.String targetWiki,
                            java.lang.String wikilanguage,
                            XWikiContext context)
                     throws XWikiException
Specified by:
copyDocument in interface XWikiInterface
Throws:
XWikiException

copyDocument

public boolean copyDocument(java.lang.String docname,
                            java.lang.String targetdocname,
                            java.lang.String sourceWiki,
                            java.lang.String targetWiki,
                            java.lang.String wikilanguage,
                            boolean reset,
                            XWikiContext context)
                     throws XWikiException
Throws:
XWikiException

copyWikiWeb

public int copyWikiWeb(java.lang.String web,
                       java.lang.String sourceWiki,
                       java.lang.String targetWiki,
                       java.lang.String wikilanguage,
                       XWikiContext context)
                throws XWikiException
Specified by:
copyWikiWeb in interface XWikiInterface
Throws:
XWikiException

copyWiki

public int copyWiki(java.lang.String sourceWiki,
                    java.lang.String targetWiki,
                    java.lang.String language,
                    XWikiContext context)
             throws XWikiException
Specified by:
copyWiki in interface XWikiInterface
Throws:
XWikiException

createNewWiki

public int createNewWiki(java.lang.String wikiName,
                         java.lang.String wikiUrl,
                         java.lang.String wikiAdmin,
                         java.lang.String baseWikiName,
                         java.lang.String description,
                         java.lang.String wikilanguage,
                         boolean failOnExist,
                         XWikiContext context)
                  throws XWikiException
Specified by:
createNewWiki in interface XWikiInterface
Throws:
XWikiException

getEncoding

public java.lang.String getEncoding()
Specified by:
getEncoding in interface XWikiInterface

getServerURL

public java.net.URL getServerURL(java.lang.String database,
                                 XWikiContext context)
                          throws java.net.MalformedURLException
Specified by:
getServerURL in interface XWikiInterface
Throws:
java.net.MalformedURLException

getURL

public java.lang.String getURL(java.lang.String fullname,
                               java.lang.String action,
                               XWikiContext context)
                        throws XWikiException
Specified by:
getURL in interface XWikiInterface
Throws:
XWikiException

getURL

public java.lang.String getURL(java.lang.String fullname,
                               java.lang.String action,
                               java.lang.String querystring,
                               XWikiContext context)
                        throws XWikiException
Specified by:
getURL in interface XWikiInterface
Throws:
XWikiException

getAttachmentURL

public java.lang.String getAttachmentURL(java.lang.String fullname,
                                         java.lang.String filename,
                                         XWikiContext context)
                                  throws XWikiException
Throws:
XWikiException

getCurrentDate

public java.util.Date getCurrentDate()
Specified by:
getCurrentDate in interface XWikiInterface

getTimeDelta

public int getTimeDelta(long time)
Specified by:
getTimeDelta in interface XWikiInterface

getDate

public java.util.Date getDate(long time)
Specified by:
getDate in interface XWikiInterface

isMultiLingual

public boolean isMultiLingual(XWikiContext context)
Specified by:
isMultiLingual in interface XWikiInterface

isVirtual

public boolean isVirtual()
Specified by:
isVirtual in interface XWikiInterface

isExo

public boolean isExo()
Specified by:
isExo in interface XWikiInterface

isLDAP

public boolean isLDAP()

checkActive

public int checkActive(XWikiContext context)
                throws XWikiException
Specified by:
checkActive in interface XWikiInterface
Throws:
XWikiException

prepareDocuments

public boolean prepareDocuments(XWikiRequest request,
                                XWikiContext context,
                                org.apache.velocity.VelocityContext vcontext)
                         throws XWikiException
Specified by:
prepareDocuments in interface XWikiInterface
Throws:
XWikiException

getEngineContext

public XWikiEngineContext getEngineContext()
Specified by:
getEngineContext in interface XWikiInterface

setEngineContext

public void setEngineContext(XWikiEngineContext engine_context)
Specified by:
setEngineContext in interface XWikiInterface

getUrlPatternMatcher

public org.securityfilter.filter.URLPatternMatcher getUrlPatternMatcher()
Specified by:
getUrlPatternMatcher in interface XWikiInterface

setUrlPatternMatcher

public void setUrlPatternMatcher(org.securityfilter.filter.URLPatternMatcher urlPatternMatcher)
Specified by:
setUrlPatternMatcher in interface XWikiInterface

setAuthService

public void setAuthService(XWikiAuthService authService)
Specified by:
setAuthService in interface XWikiInterface

setRightService

public void setRightService(XWikiRightService rightService)
Specified by:
setRightService in interface XWikiInterface

getGroupService

public XWikiGroupService getGroupService()
Specified by:
getGroupService in interface XWikiInterface

setGroupService

public void setGroupService(XWikiGroupService groupService)
Specified by:
setGroupService in interface XWikiInterface

getAuthService

public XWikiAuthService getAuthService()
Specified by:
getAuthService in interface XWikiInterface

getRightService

public XWikiRightService getRightService()
Specified by:
getRightService in interface XWikiInterface

getStatsService

public XWikiStatsService getStatsService(XWikiContext context)

getService

public java.lang.Object getService(java.lang.String className)
                            throws XWikiException
Specified by:
getService in interface XWikiInterface
Throws:
XWikiException

getPortalService

public java.lang.Object getPortalService(java.lang.String className)
                                  throws XWikiException
Throws:
XWikiException

getZipOutputStream

public java.util.zip.ZipOutputStream getZipOutputStream(XWikiContext context)
                                                 throws java.io.IOException
Throws:
java.io.IOException

getSearchEngineRules

private java.util.Map getSearchEngineRules(XWikiContext context)

getRefererText

public java.lang.String getRefererText(java.lang.String referer,
                                       XWikiContext context)

isMySQL

public boolean isMySQL()

getFullNameSQL

public java.lang.String getFullNameSQL()

getDocName

public java.lang.String getDocName(java.lang.String docname)

getUserName

public java.lang.String getUserName(java.lang.String user,
                                    XWikiContext context)
Specified by:
getUserName in interface XWikiInterface

getUserName

public java.lang.String getUserName(java.lang.String user,
                                    java.lang.String format,
                                    XWikiContext context)
Specified by:
getUserName in interface XWikiInterface

getUserName

public java.lang.String getUserName(java.lang.String user,
                                    java.lang.String format,
                                    boolean link,
                                    XWikiContext context)

getLocalUserName

public java.lang.String getLocalUserName(java.lang.String user,
                                         XWikiContext context)

getLocalUserName

public java.lang.String getLocalUserName(java.lang.String user,
                                         java.lang.String format,
                                         XWikiContext context)

getLocalUserName

public java.lang.String getLocalUserName(java.lang.String user,
                                         java.lang.String format,
                                         boolean link,
                                         XWikiContext context)

formatDate

public java.lang.String formatDate(java.util.Date date,
                                   java.lang.String format,
                                   XWikiContext context)

exists

public boolean exists(java.lang.String fullname,
                      XWikiContext context)

getAdType

public java.lang.String getAdType(XWikiContext context)

getAdClientId

public java.lang.String getAdClientId(XWikiContext context)

getPlugin

public XWikiPluginInterface getPlugin(java.lang.String name,
                                      XWikiContext context)

getPluginApi

public Api getPluginApi(java.lang.String name,
                        XWikiContext context)

getThreadMap

public static java.util.Map getThreadMap()

setThreadMap

public static void setThreadMap(java.util.Map threadMap)

getCacheService

public XWikiCacheService getCacheService()

getURLContent

public java.lang.String getURLContent(java.lang.String surl)
                               throws java.io.IOException
Throws:
java.io.IOException

getURLContent

public java.lang.String getURLContent(java.lang.String surl,
                                      java.lang.String username,
                                      java.lang.String password)
                               throws java.io.IOException
Throws:
java.io.IOException

getSpaces

public java.util.List getSpaces(XWikiContext context)
                         throws XWikiException
Throws:
XWikiException

getSpaceDocsName

public java.util.List getSpaceDocsName(java.lang.String spaceName,
                                       XWikiContext context)
                                throws XWikiException
Throws:
XWikiException

getIncludedMacros

public java.util.List getIncludedMacros(java.lang.String defaultweb,
                                        java.lang.String content,
                                        XWikiContext context)

getFlash

public java.lang.String getFlash(java.lang.String url,
                                 java.lang.String width,
                                 java.lang.String height,
                                 XWikiContext context)

isReadOnly

public boolean isReadOnly()
accessor for the isReadOnly instance var.

See Also:
isReadOnly

setReadOnly

public void setReadOnly(boolean readOnly)


Copyright 2003 Ludovic Dubost