Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.xpn.xwiki
Class XWiki

java.lang.Object
  extended by com.xpn.xwiki.XWiki
All Implemented Interfaces:
XWikiDocChangeNotificationInterface
public class XWiki
extends java.lang.Object
implements XWikiDocChangeNotificationInterface

Field Summary
static java.lang.String CFG_ENV_NAME
           
protected static org.apache.commons.logging.Log LOG
           
static java.lang.String MACROS_FILE
           
 
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()
          This provide a way to create an XWiki object without initializing the whole XWiki (including plugins, storage, etc.).
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
 java.lang.String addMandatory(XWikiContext context)
           
 java.lang.String addTooltip(java.lang.String html, java.lang.String message, java.lang.String params, XWikiContext context)
           
 java.lang.String addTooltip(java.lang.String html, java.lang.String message, XWikiContext context)
           
 java.lang.String addTooltipJS(XWikiContext context)
           
protected  void addUserToGroup(java.lang.String userName, java.lang.String groupName, XWikiContext context)
           
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(java.lang.String user, XWikiContext context)
           
 int checkActive(XWikiContext context)
           
 XWikiUser checkAuth(XWikiContext context)
           
 java.lang.String clearName(java.lang.String name, boolean stripDots, boolean ascii, XWikiContext context)
           
 java.lang.String clearName(java.lang.String name, XWikiContext context)
           
 java.lang.String convertUsername(java.lang.String username, XWikiContext context)
           
 boolean copyDocument(java.lang.String docname, java.lang.String targetdocname, boolean reset, 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, boolean force, boolean resetCreationData, 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, boolean force, 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, boolean clean, XWikiContext context)
           
 int copyWikiWeb(java.lang.String web, java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String wikilanguage, XWikiContext context)
           
protected  java.lang.Object createClassFromConfig(java.lang.String param, java.lang.String defClass, XWikiContext context)
           
 boolean createEmptyUser(java.lang.String xwikiname, java.lang.String userRights, XWikiContext context)
          Method allows to create an empty user with no password (he won't be able to login) This method is usefull for authentication like LDAP or App Server trusted
 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)
           
 XWikiQuery createQueryFromRequest(java.lang.String className, 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 deleteAllDocuments(XWikiDocument doc, boolean totrash, XWikiContext context)
           
 void deleteAllDocuments(XWikiDocument doc, XWikiContext context)
           
 void deleteDocument(XWikiDocument doc, boolean totrash, XWikiContext context)
           
 void deleteDocument(XWikiDocument doc, XWikiContext context)
           
 java.lang.String displaySearch(java.lang.String fieldname, java.lang.String className, java.lang.String prefix, XWikiCriteria criteria, XWikiContext context)
           
 java.lang.String displaySearch(java.lang.String fieldname, java.lang.String className, XWikiContext context)
           
 java.lang.String displaySearch(java.lang.String fieldname, java.lang.String className, XWikiCriteria criteria, XWikiContext context)
           
 java.lang.String displaySearchColumns(java.lang.String className, java.lang.String prefix, XWikiQuery query, XWikiContext context)
           
 java.lang.String displaySearchColumns(java.lang.String className, XWikiQuery query, XWikiContext context)
           
 java.lang.String displaySearchOrder(java.lang.String className, java.lang.String prefix, XWikiQuery query, XWikiContext context)
           
 java.lang.String displaySearchOrder(java.lang.String className, XWikiQuery query, XWikiContext context)
           
 boolean exists(java.lang.String fullname, XWikiContext context)
           
 void flushCache()
           
 void flushCache(XWikiContext context)
           
 java.lang.String formatDate(java.util.Date date, java.lang.String format, XWikiContext context)
           
 long freeMemory()
           
 void gc()
           
 java.lang.String generateRandomString(int size)
           
 java.lang.String generateValidationKey(int size)
           
 java.lang.String getAdClientId(XWikiContext context)
           
 java.lang.String getAdType(XWikiContext context)
           
 AttachmentRecycleBinStore getAttachmentRecycleBinStore()
           
 XWikiAttachmentStoreInterface getAttachmentStore()
           
 java.lang.String getAttachmentURL(java.lang.String fullname, java.lang.String filename, XWikiContext context)
           
 AttachmentVersioningStore getAttachmentVersioningStore()
           
 XWikiAuthService getAuthService()
           
 java.lang.String getBaseSkin(XWikiContext context)
           
 java.lang.String getBaseSkin(XWikiContext context, boolean fromRenderSkin)
           
 CacheFactory getCacheFactory()
          Deprecated. Since 1.7M1, use CacheManager component instead using Utils.getComponent(String).
 BaseClass getClass(java.lang.String fullName, XWikiContext context)
           
 java.util.List<java.lang.String> getClassList(XWikiContext context)
           
 BaseClass getCommentsClass(XWikiContext context)
           
 XWikiConfig getConfig()
           
static java.lang.String getConfigPath()
           
 java.util.List<java.lang.String> getConfiguredSyntaxes()
           
 java.lang.String getConvertingUserNameType(XWikiContext context)
           
 XWikiCriteriaService getCriteriaService(XWikiContext context)
           
 java.util.Date getCurrentDate()
           
 java.lang.String getDatabase()
           
 java.util.Date getDate(long time)
           
 java.lang.String getDefaultBaseSkin(XWikiContext context)
           
 java.lang.String getDefaultLanguage(XWikiContext context)
           
 java.lang.String getDefaultPage(XWikiContext context)
           
 java.lang.String getDefaultWeb(XWikiContext context)
           
 XWikiDeletedDocument getDeletedDocument(java.lang.String fullname, java.lang.String lang, int index, XWikiContext context)
           
 XWikiDeletedDocument[] getDeletedDocuments(java.lang.String fullname, java.lang.String lang, XWikiContext context)
           
 java.lang.String getDocLanguagePreference(XWikiContext context)
          Deprecated. use getLanguagePreference(XWikiContext) instead
 java.lang.String getDocLanguagePreferenceNew(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)
           
 XWikiDocument getDocumentFromPath(java.lang.String path, XWikiContext context)
           
 java.lang.String getDocumentName(XWikiRequest request, XWikiContext context)
           
 java.lang.String getDocumentNameFromPath(java.lang.String path, XWikiContext context)
           
 java.lang.String getEditorPreference(XWikiContext context)
           
 java.lang.String getEncoding()
           
 XWikiEngineContext getEngineContext()
           
 java.lang.Object getExoPortalService(java.lang.String className)
          Privileged API to access an eXo Platform Portal service from the Wiki Engine
 java.lang.Object getExoService(java.lang.String className)
          Privileged API to access an eXo Platform service from the Wiki Engine
 java.lang.String getExternalAttachmentURL(java.lang.String fullName, java.lang.String filename, XWikiContext context)
           
 java.lang.String getExternalURL(java.lang.String fullname, java.lang.String action, java.lang.String querystring, XWikiContext context)
           
 java.lang.String getExternalURL(java.lang.String fullname, java.lang.String action, XWikiContext context)
           
 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()
           
 java.lang.String getFullNameSQL(boolean newFullName)
           
 BaseClass getGlobalRightsClass(XWikiContext context)
           
 BaseClass getGroupClass(XWikiContext context)
           
 XWikiGroupService getGroupService(XWikiContext context)
           
 XWikiHibernateStore getHibernateStore()
           
 java.lang.String getHTMLArea(java.lang.String content, XWikiContext context)
           
static org.apache.commons.httpclient.HttpClient getHttpClient(int timeout, java.lang.String userAgent)
           
 int getHttpTimeout(XWikiContext context)
           
 java.lang.String getHttpUserAgent(XWikiContext context)
           
 java.util.List<java.lang.String> getIncludedMacros(java.lang.String defaultweb, java.lang.String content, XWikiContext context)
           
 java.lang.String getInterfaceLanguagePreference(XWikiContext context)
           
 java.lang.String getLanguagePreference(XWikiContext context)
          First try to find the current language in use from the XWiki context.
 CacheFactory getLocalCacheFactory()
          Deprecated. Since 1.7M1, use CacheManager component instead using Utils.getComponent(String).
 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)
           
 java.lang.String getMacroList(XWikiContext context)
           
static XWiki getMainXWiki(XWikiContext context)
           
 int getMaxRecursiveSpaceChecks(XWikiContext context)
           
 java.lang.String getMessage(java.lang.String item, XWikiContext context)
           
 MetaClass getMetaclass()
           
 XWikiStoreInterface getNotCacheStore()
           
 XWikiNotificationManager getNotificationManager()
           
 BaseObject getObjectFromRequest(java.lang.String className, XWikiContext context)
           
 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)
          Deprecated. use getExoPortalService(String) instead
 BaseClass getPrefsClass(XWikiContext context)
          Verify if the XWiki.XWikiPreferences page exists and that it contains all the required configuration properties to make XWiki work properly.
static java.lang.Object getPrivateField(java.lang.Object obj, java.lang.String fieldName)
           
 PropertyClass getPropertyClassFromName(java.lang.String propPath, XWikiContext context)
           
 java.lang.String getRealPath(java.lang.String path)
           
 XWikiRecycleBinStoreInterface getRecycleBinStore()
           
 BaseClass getRedirectClass(XWikiContext context)
          Verify if the XWiki.GlobalRedirect page exists and that it contains all the required configuration properties to make the redirection feature work properly.
 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)
           
 byte[] getResourceContentAsBytes(java.lang.String name)
           
 java.util.Date getResourceLastModificationDate(java.lang.String name)
           
 BaseClass getRightsClass(java.lang.String pagename, XWikiContext context)
           
 BaseClass getRightsClass(XWikiContext context)
           
 XWikiRightService getRightService()
           
 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)
          Deprecated. use getExoService(String) instead
 java.lang.String getServletPath(java.lang.String wikiName, XWikiContext context)
           
 java.lang.String getSkin(XWikiContext context)
           
 BaseClass getSkinClass(XWikiContext context)
           
 java.lang.String getSkinFile(java.lang.String filename, boolean forceSkinAction, XWikiContext context)
           
 java.lang.String getSkinFile(java.lang.String filename, java.lang.String skin, boolean forceSkinAction, 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.lang.String getSkinPreference(java.lang.String prefname, java.lang.String default_value, XWikiContext context)
           
 java.lang.String getSkinPreference(java.lang.String prefname, XWikiContext context)
           
 java.util.List<java.lang.String> getSpaceDocsName(java.lang.String spaceName, XWikiContext context)
           
 java.util.List<java.lang.String> getSpaces(XWikiContext context)
           
 XWikiStatsService getStatsService(XWikiContext context)
           
 XWikiStoreInterface getStore()
           
 BaseClass getTagClass(XWikiContext context)
          Verify if the XWiki.TagClass page exists and that it contains all the required configuration properties to make the tag feature work properly.
 java.io.File getTempDirectory(XWikiContext context)
          Get the XWiki temporary filesystem directory (deleted on exit)
static java.lang.String getTextArea(java.lang.String content, XWikiContext context)
           
 int getTimeDelta(long time)
           
 java.lang.String getUniquePageName(java.lang.String space, java.lang.String name, XWikiContext context)
           
 java.lang.String getUniquePageName(java.lang.String space, XWikiContext context)
           
 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, int timeout, java.lang.String userAgent)
           
 java.lang.String getURLContent(java.lang.String surl, java.lang.String username, java.lang.String password, int timeout, java.lang.String userAgent)
           
 java.lang.String getURLContent(java.lang.String surl, java.lang.String username, java.lang.String password, XWikiContext context)
           
 java.lang.String getURLContent(java.lang.String surl, XWikiContext context)
           
 byte[] getURLContentAsBytes(java.lang.String surl, int timeout, java.lang.String userAgent)
           
 byte[] getURLContentAsBytes(java.lang.String surl, java.lang.String username, java.lang.String password, int timeout, java.lang.String userAgent)
           
 byte[] getURLContentAsBytes(java.lang.String surl, java.lang.String username, java.lang.String password, XWikiContext context)
           
 byte[] getURLContentAsBytes(java.lang.String surl, XWikiContext context)
           
 XWikiURLFactoryService getURLFactoryService()
           
 org.securityfilter.filter.URLPatternMatcher getUrlPatternMatcher()
           
 User getUser(java.lang.String username, XWikiContext context)
           
 User getUser(XWikiContext context)
           
 BaseClass getUserClass(XWikiContext context)
          Verify if the XWiki.XWikiUsers page exists and that it contains all the required configuration properties to make the user feature work properly.
 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 getUserTimeZone(XWikiContext context)
           
 java.lang.String getVersion()
           
 XWikiVersioningStoreInterface getVersioningStore()
           
 Cache<java.lang.String> getVirtualWikiCache()
           
 java.util.List<java.lang.String> getVirtualWikiList()
           
 java.util.List<java.lang.String> getVirtualWikisDatabaseNames(XWikiContext context)
           
 java.lang.String getWebAppPath(XWikiContext context)
           
 java.lang.String getWebCopyright(XWikiContext context)
           
 java.lang.String getWebPreference(java.lang.String prefname, java.lang.String space, java.lang.String default_value, 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)
           
 java.lang.String getWikiOwner(java.lang.String servername, XWikiContext context)
           
 java.io.File getWorkDirectory(XWikiContext context)
          Get the XWiki work directory
 java.io.File getWorkSubdirectory(java.lang.String subdir, XWikiContext context)
          Get a new directory in the xwiki work directory
 java.lang.String getWysiwygToolbars(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 fallback_param, java.lang.String default_value, XWikiContext context)
          Obtain a preference value for the wiki, looking up first in the XWiki.XWikiPreferences document, then fallbacking on a config parameter when the first lookup gives an empty string, then returning the default value if the config parameter returned itself an empty string.
 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, java.lang.String fallback_param, 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, java.lang.String fallback_param, long default_value, XWikiContext context)
           
 long getXWikiPreferenceAsLong(java.lang.String prefname, XWikiContext context)
           
 java.util.zip.ZipOutputStream getZipOutputStream(XWikiContext context)
           
 boolean hasAttachmentRecycleBin(XWikiContext context)
          Indicates whether deleted attachments are stored in a recycle bin or not.
 boolean hasAttachmentVersioning(XWikiContext context)
           
 boolean hasBacklinks(XWikiContext context)
           
 boolean hasCaptcha(XWikiContext context)
           
 boolean hasCentralizedAuthentication(XWikiContext context)
           
 boolean hasCustomMappings()
           
 boolean hasDynamicCustomMappings()
           
 boolean hasEditComment(XWikiContext context)
           
 boolean hasMinorEdit(XWikiContext context)
           
 boolean hasRecycleBin(XWikiContext context)
           
 boolean hasSectionEdit(XWikiContext context)
           
 boolean hasTags(XWikiContext context)
           
 boolean hasVersioning(java.lang.String fullName, XWikiContext context)
           
 java.lang.String include(java.lang.String topic, boolean isForm, XWikiContext context)
           
 java.lang.String include(java.lang.String topic, XWikiContext context, boolean isForm)
          Deprecated. replaced by include(String topic, boolean isForm, XWikiContext context)
 void initXWiki(XWikiConfig config, XWikiContext context, XWikiEngineContext engine_context, boolean noupdate)
          Initialize all xwiki subsystems.
 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 isEditCommentFieldHidden(XWikiContext context)
           
 boolean isEditCommentMandatory(XWikiContext context)
           
 boolean isEditCommentSuggested(XWikiContext context)
           
 boolean isExo()
           
 boolean isLDAP()
           
 boolean isMultiLingual(XWikiContext context)
           
 boolean isMySQL()
           
 boolean isReadOnly()
          accessor for the isReadOnly instance var.
 boolean isTest()
           
 boolean isVirtualMode()
           
 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.Object parseGroovyFromPage(java.lang.String fullName, java.lang.String jarWikiPage, XWikiContext context)
           
 java.lang.Object parseGroovyFromPage(java.lang.String fullname, XWikiContext context)
           
 java.lang.Object parseGroovyFromString(java.lang.String script, java.lang.String jarWikiPage, XWikiContext context)
          Privileged API to retrieve an object instantiated from groovy code in a String, using a classloader including all JAR files located in the passed page as attachments.
 java.lang.Object parseGroovyFromString(java.lang.String script, XWikiContext context)
          Privileged API to retrieve an object instantiated from groovy code in a String.
 java.lang.String parseMessage(java.lang.String id, XWikiContext context)
           
 java.lang.String parseMessage(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)
           
 void prepareResources(XWikiContext context)
          Prepares the localized resources, according to the selected language.
 java.lang.String printStrackTrace(java.lang.Throwable e)
           
 void protectUserPage(java.lang.String fullwikiname, java.lang.String userRights, XWikiDocument doc, XWikiContext context)
           
 void ProtectUserPage(XWikiContext context, java.lang.String fullwikiname, java.lang.String userRights, XWikiDocument doc)
          Deprecated. replaced by protectUserPage(String,String,XWikiDocument,XWikiContext)
 void refreshLinks(XWikiContext context)
           
 void renamePage(java.lang.String fullName, java.lang.String newFullName, XWikiContext context)
           
 XWikiDocument renamePage(XWikiDocument doc, java.lang.String newFullName, XWikiContext context)
          Deprecated. use XWikiDocument.rename(String, XWikiContext) instead
 XWikiDocument renamePage(XWikiDocument doc, XWikiContext context, java.lang.String newFullName)
          Deprecated. use XWikiDocument.rename(String, XWikiContext) instead
 java.lang.String renderTemplate(java.lang.String template, java.lang.String skin, XWikiContext context)
           
 java.lang.String renderTemplate(java.lang.String template, XWikiContext context)
           
 void resetRenderingEngine(XWikiContext context)
           
 boolean resourceExists(java.lang.String name)
           
 XWikiDocument rollback(XWikiDocument tdoc, java.lang.String rev, XWikiContext context)
           
 void saveDocument(XWikiDocument doc, java.lang.String comment, boolean isMinorEdit, XWikiContext context)
           
 void saveDocument(XWikiDocument doc, java.lang.String comment, XWikiContext context)
           
 void saveDocument(XWikiDocument doc, 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)
           
 java.util.List search(XWikiQuery query, XWikiContext context)
           
 java.lang.String searchAsTable(XWikiQuery query, XWikiContext context)
           
 void sendConfirmationEmail(java.lang.String xwikiname, java.lang.String password, java.lang.String email, java.lang.String message, java.lang.String contentfield, XWikiContext context)
           
 void sendMessage(java.lang.String sender, java.lang.String[] recipient, java.lang.String message, XWikiContext context)
          Deprecated. replaced by the Mail Sender Plugin
 void sendMessage(java.lang.String sender, java.lang.String recipient, java.lang.String message, XWikiContext context)
          Deprecated. replaced by the Mail Sender Plugin
 void sendValidationEmail(java.lang.String xwikiname, java.lang.String password, java.lang.String email, java.lang.String addfieldname, java.lang.String addfieldvalue, java.lang.String contentfield, 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 setAttachmentRecycleBinStore(AttachmentRecycleBinStore attachmentRecycleBinStore)
           
 void setAttachmentStore(XWikiAttachmentStoreInterface attachmentStore)
           
 void setAttachmentVersioningStore(AttachmentVersioningStore avStore)
           
 void setAuthService(XWikiAuthService authService)
           
 void setConfig(XWikiConfig config)
           
 void setCriteriaService(XWikiCriteriaService criteriaService)
           
 void setDatabase(java.lang.String database)
           
 void setEngineContext(XWikiEngineContext engine_context)
           
 void setGroupService(XWikiGroupService groupService)
           
 void setMetaclass(MetaClass metaclass)
           
 void setNotificationManager(XWikiNotificationManager notificationManager)
           
 void setPhonyDocument(java.lang.String docName, XWikiContext context, org.apache.velocity.VelocityContext vcontext)
           
 void setPluginManager(XWikiPluginManager pluginManager)
           
 void setReadOnly(boolean readOnly)
           
 void setRecycleBinStore(XWikiRecycleBinStoreInterface recycleBinStore)
           
 void setRenderingEngine(XWikiRenderingEngine renderingEngine)
           
 void setRightService(XWikiRightService rightService)
           
 void setStore(XWikiStoreInterface store)
           
 void setTest(boolean test)
           
 void setUrlPatternMatcher(org.securityfilter.filter.URLPatternMatcher urlPatternMatcher)
           
 void setUserDefaultGroup(java.lang.String fullwikiname, XWikiContext context)
           
 void SetUserDefaultGroup(XWikiContext context, java.lang.String fullwikiname)
          Deprecated. replaced by setUserDefaultGroup(String fullwikiname, XWikiContext context)
 void setVersion(java.lang.String version)
           
 void setVersioningStore(XWikiVersioningStoreInterface versioningStore)
           
 boolean showViewAction(XWikiContext context)
           
 java.lang.String[] split(java.lang.String str, java.lang.String sep)
           
 long totalMemory()
           
 void updateDatabase(java.lang.String appname, boolean force, boolean initClasses, XWikiContext context)
           
 void updateDatabase(java.lang.String appname, boolean force, XWikiContext context)
           
 void updateDatabase(java.lang.String appname, XWikiContext context)
           
 boolean useDefaultAction(XWikiContext context)
           
 boolean useDefaultWeb(XWikiContext context)
           
 boolean validateDocument(XWikiDocument doc, 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

protected static final org.apache.commons.logging.Log LOG

CFG_ENV_NAME

public static final java.lang.String CFG_ENV_NAME
See Also:
Constant Field Values

MACROS_FILE

public static final java.lang.String MACROS_FILE
See Also:
Constant Field Values
Constructor Detail

XWiki

public XWiki()
This provide a way to create an XWiki object without initializing the whole XWiki (including plugins, storage, etc.).

Needed for tools or tests which need XWiki because it is used everywhere in the API.

XWiki

public XWiki(XWikiConfig config,
             XWikiContext context)
      throws XWikiException
Throws:
XWikiException

XWiki

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

XWiki

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

Throws:
XWikiException

XWiki

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

Throws:
XWikiException

XWiki

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

Throws:
XWikiException
Method Detail

getConfigPath

public static java.lang.String getConfigPath()
                                      throws javax.naming.NamingException
Throws:
javax.naming.NamingException

getMainXWiki

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

getXWiki

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

getRequestURL

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

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)

getFormEncoded

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

getHttpClient

public static org.apache.commons.httpclient.HttpClient getHttpClient(int timeout,
                                                                     java.lang.String userAgent)

getPrivateField

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

getServerWikiPage

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

getXMLEncoded

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

getTextArea

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

initXWiki

public void initXWiki(XWikiConfig config,
                      XWikiContext context,
                      XWikiEngineContext engine_context,
                      boolean noupdate)
               throws XWikiException
Initialize all xwiki subsystems.

Throws:
XWikiException

getNotCacheStore

public XWikiStoreInterface getNotCacheStore()

getHibernateStore

public XWikiHibernateStore getHibernateStore()

updateDatabase

public void updateDatabase(java.lang.String appname,
                           XWikiContext context)
                    throws org.hibernate.HibernateException,
                           XWikiException
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

updateDatabase

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

getVirtualWikiList

public java.util.List<java.lang.String> getVirtualWikiList()
Returns:
a cached list of all active virtual wikis (i.e. wikis who have been hit by a user request). To get a full list of all virtual wikis database names use getVirtualWikisDatabaseNames(XWikiContext).

getVirtualWikisDatabaseNames

public java.util.List<java.lang.String> getVirtualWikisDatabaseNames(XWikiContext context)
                                                              throws XWikiException
Returns:
the full list of all database names of all defined virtual wikis. The database names are computed from the names of documents having a XWiki.XWikiServerClass object attached to them by removing the "XWiki.XWikiServer" prefix and making it lower case. For example a page named "XWiki.XWikiServerMyDatabase" would return "mydatabase" as the database name.
Throws:
XWikiException

getVirtualWikiCache

public Cache<java.lang.String> getVirtualWikiCache()
Returns:
the cache containing the names of the wikis already initialized.
Since:
1.5M2.

getWikiOwner

public java.lang.String getWikiOwner(java.lang.String servername,
                                     XWikiContext context)
                              throws XWikiException
Throws:
XWikiException

createClassFromConfig

protected java.lang.Object createClassFromConfig(java.lang.String param,
                                                 java.lang.String defClass,
                                                 XWikiContext context)
                                          throws XWikiException
Throws:
XWikiException

resetRenderingEngine

public void resetRenderingEngine(XWikiContext context)
                          throws XWikiException
Throws:
XWikiException

getVersion

public java.lang.String getVersion()
Returns:
the XWiki core version as specified in the VERSION_FILE file

getResource

public java.net.URL getResource(java.lang.String s)
                         throws java.net.MalformedURLException
Throws:
java.net.MalformedURLException

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String s)
                                        throws java.net.MalformedURLException
Throws:
java.net.MalformedURLException

getResourceContent

public java.lang.String getResourceContent(java.lang.String name)
                                    throws java.io.IOException
Throws:
java.io.IOException

getResourceLastModificationDate

public java.util.Date getResourceLastModificationDate(java.lang.String name)

getResourceContentAsBytes

public byte[] getResourceContentAsBytes(java.lang.String name)
                                 throws java.io.IOException
Throws:
java.io.IOException

resourceExists

public boolean resourceExists(java.lang.String name)

getConfig

public XWikiConfig getConfig()

getRealPath

public java.lang.String getRealPath(java.lang.String path)

Param

public java.lang.String Param(java.lang.String key)

ParamAsRealPath

public java.lang.String ParamAsRealPath(java.lang.String key)

ParamAsRealPath

public java.lang.String ParamAsRealPath(java.lang.String key,
                                        XWikiContext context)

ParamAsRealPathVerified

public java.lang.String ParamAsRealPathVerified(java.lang.String param)

Param

public java.lang.String Param(java.lang.String key,
                              java.lang.String default_value)

ParamAsLong

public long ParamAsLong(java.lang.String key)

ParamAsLong

public long ParamAsLong(java.lang.String key,
                        long default_value)

getStore

public XWikiStoreInterface getStore()

getAttachmentStore

public XWikiAttachmentStoreInterface getAttachmentStore()

getAttachmentVersioningStore

public AttachmentVersioningStore getAttachmentVersioningStore()

getVersioningStore

public XWikiVersioningStoreInterface getVersioningStore()

getRecycleBinStore

public XWikiRecycleBinStoreInterface getRecycleBinStore()

getAttachmentRecycleBinStore

public AttachmentRecycleBinStore getAttachmentRecycleBinStore()

saveDocument

public void saveDocument(XWikiDocument doc,
                         XWikiContext context)
                  throws XWikiException
Throws:
XWikiException

saveDocument

public void saveDocument(XWikiDocument doc,
                         java.lang.String comment,
                         XWikiContext context)
                  throws XWikiException
Throws:
XWikiException

saveDocument

public void saveDocument(XWikiDocument doc,
                         java.lang.String comment,
                         boolean isMinorEdit,
                         XWikiContext context)
                  throws XWikiException
Throws:
XWikiException

getDocument

public XWikiDocument getDocument(XWikiDocument doc,
                                 java.lang.String revision,
                                 XWikiContext context)
                          throws XWikiException
Throws:
XWikiException

getDocument

public XWikiDocument getDocument(java.lang.String fullname,
                                 XWikiContext context)
                          throws XWikiException
Throws:
XWikiException

getDocument

public XWikiDocument getDocument(java.lang.String web,
                                 java.lang.String fullname,
                                 XWikiContext context)
                          throws XWikiException
Throws:
XWikiException

getDocumentFromPath

public XWikiDocument getDocumentFromPath(java.lang.String path,
                                         XWikiContext context)
                                  throws XWikiException
Throws:
XWikiException

getDocumentNameFromPath

public java.lang.String getDocumentNameFromPath(java.lang.String path,
                                                XWikiContext context)

getDeletedDocuments

public XWikiDeletedDocument[] getDeletedDocuments(java.lang.String fullname,
                                                  java.lang.String lang,
                                                  XWikiContext context)
                                           throws XWikiException
Throws:
XWikiException
See Also:
XWiki.getDeletedDocuments(String, String)

getDeletedDocument

public XWikiDeletedDocument getDeletedDocument(java.lang.String fullname,
                                               java.lang.String lang,
                                               int index,
                                               XWikiContext context)
                                        throws XWikiException
Throws:
XWikiException
See Also:
XWiki.getDeletedDocument(String, String, String)

getRenderingEngine

public XWikiRenderingEngine getRenderingEngine()

setRenderingEngine

public void setRenderingEngine(XWikiRenderingEngine renderingEngine)

getMetaclass

public MetaClass getMetaclass()

setMetaclass

public void setMetaclass(MetaClass metaclass)

getHTMLArea

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

getClassList

public java.util.List<java.lang.String> getClassList(XWikiContext context)
                                              throws XWikiException
Throws:
XWikiException

search

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

search

public java.util.List search(java.lang.String sql,
                             int nb,
                             int start,
                             XWikiContext context)
                      throws XWikiException
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()

setTest

public void setTest(boolean test)

parseContent

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

parseTemplate

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

parseTemplate

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

renderTemplate

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

renderTemplate

public java.lang.String renderTemplate(java.lang.String template,
                                       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)

getSkinFile

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

getSkinFile

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

getSkinFile

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

getSkin

public java.lang.String getSkin(XWikiContext context)

getSkinPreference

public java.lang.String getSkinPreference(java.lang.String prefname,
                                          XWikiContext context)

getSkinPreference

public java.lang.String getSkinPreference(java.lang.String prefname,
                                          java.lang.String default_value,
                                          XWikiContext context)

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)

getXWikiPreference

public java.lang.String getXWikiPreference(java.lang.String prefname,
                                           XWikiContext context)

getXWikiPreference

public java.lang.String getXWikiPreference(java.lang.String prefname,
                                           java.lang.String fallback_param,
                                           java.lang.String default_value,
                                           XWikiContext context)
Obtain a preference value for the wiki, looking up first in the XWiki.XWikiPreferences document, then fallbacking on a config parameter when the first lookup gives an empty string, then returning the default value if the config parameter returned itself an empty string.

Parameters:
prefname - the parameter to look for in the XWiki.XWikiPreferences object corresponding to the context's language in the XWiki.XWikiPreferences document of the wiki (or the first XWiki.XWikiPreferences object contained, if the one for the context'ds language could not be found).
fallback_param - the parameter in xwiki.cfg to fallback on, in case the XWiki.XWikiPreferences object gave no result
default_value - the default value to fallback on, in case both XWiki.XWikiPreferences and the fallback xwiki.cfg parameter gave no result

getXWikiPreference

public java.lang.String getXWikiPreference(java.lang.String prefname,
                                           java.lang.String default_value,
                                           XWikiContext context)

getWebPreference

public java.lang.String getWebPreference(java.lang.String prefname,
                                         XWikiContext context)

getWebPreference

public java.lang.String getWebPreference(java.lang.String prefname,
                                         java.lang.String default_value,
                                         XWikiContext context)

getWebPreference

public java.lang.String getWebPreference(java.lang.String prefname,
                                         java.lang.String space,
                                         java.lang.String default_value,
                                         XWikiContext context)

getUserPreference

public java.lang.String getUserPreference(java.lang.String prefname,
                                          XWikiContext context)

getUserPreferenceFromCookie

public java.lang.String getUserPreferenceFromCookie(java.lang.String prefname,
                                                    XWikiContext context)

getUserPreference

public java.lang.String getUserPreference(java.lang.String prefname,
                                          boolean useCookie,
                                          XWikiContext context)

getDocLanguagePreference

@Deprecated
public java.lang.String getDocLanguagePreference(XWikiContext context)
Deprecated. use getLanguagePreference(XWikiContext) instead

getLanguagePreference

public java.lang.String getLanguagePreference(XWikiContext context)
First try to find the current language in use from the XWiki context. If none is used and if the wiki is not multilingual use the default language defined in the XWiki preferences. If the wiki is multilingual try to get the language passed in the request. If none was passed try to get it from a cookie. If no language cookie exists then use the user default language and barring that use the browser's "Accept-Language" header sent in HTTP request. If none is defined use the default language.

Returns:
the language to use

getDefaultLanguage

public java.lang.String getDefaultLanguage(XWikiContext context)

getDocLanguagePreferenceNew

public java.lang.String getDocLanguagePreferenceNew(XWikiContext context)

getInterfaceLanguagePreference

public java.lang.String getInterfaceLanguagePreference(XWikiContext context)

getXWikiPreferenceAsLong

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

getWebPreferenceAsLong

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

getXWikiPreferenceAsLong

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

getXWikiPreferenceAsLong

public long getXWikiPreferenceAsLong(java.lang.String prefname,
                                     java.lang.String fallback_param,
                                     long default_value,
                                     XWikiContext context)

getWebPreferenceAsLong

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

getUserPreferenceAsLong

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

getXWikiPreferenceAsInt

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

getWebPreferenceAsInt

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

getXWikiPreferenceAsInt

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

getXWikiPreferenceAsInt

public int getXWikiPreferenceAsInt(java.lang.String prefname,
                                   java.lang.String fallback_param,
                                   int default_value,
                                   XWikiContext context)

getWebPreferenceAsInt

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

getUserPreferenceAsInt

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

flushCache

public void flushCache()

flushCache

public void flushCache(XWikiContext context)

getPluginManager

public XWikiPluginManager getPluginManager()

setPluginManager

public void setPluginManager(XWikiPluginManager pluginManager)

setConfig

public void setConfig(XWikiConfig config)

setStore

public void setStore(XWikiStoreInterface store)

setAttachmentStore

public void setAttachmentStore(XWikiAttachmentStoreInterface attachmentStore)

setAttachmentVersioningStore

public void setAttachmentVersioningStore(AttachmentVersioningStore avStore)

setVersioningStore

public void setVersioningStore(XWikiVersioningStoreInterface versioningStore)

setRecycleBinStore

public void setRecycleBinStore(XWikiRecycleBinStoreInterface recycleBinStore)

setAttachmentRecycleBinStore

public void setAttachmentRecycleBinStore(AttachmentRecycleBinStore attachmentRecycleBinStore)

setCriteriaService

public void setCriteriaService(XWikiCriteriaService criteriaService)

setVersion

public void setVersion(java.lang.String version)

getNotificationManager

public XWikiNotificationManager getNotificationManager()

setNotificationManager

public void setNotificationManager(XWikiNotificationManager notificationManager)

notify

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

getTagClass

public BaseClass getTagClass(XWikiContext context)
                      throws XWikiException
Verify if the XWiki.TagClass page exists and that it contains all the required configuration properties to make the tag feature work properly. If some properties are missing they are created and saved in the database.

Parameters:
context - the XWiki Context
Returns:
the TagClass Base Class object containing the properties
Throws:
XWikiException - if an error happens during the save to the datavase

getUserClass

public BaseClass getUserClass(XWikiContext context)
                       throws XWikiException
Verify if the XWiki.XWikiUsers page exists and that it contains all the required configuration properties to make the user feature work properly. If some properties are missing they are created and saved in the database.

Parameters:
context - the XWiki Context
Returns:
the XWikiUsers Base Class object containing the properties
Throws:
XWikiException - if an error happens during the save to the datavase

getRedirectClass

public BaseClass getRedirectClass(XWikiContext context)
                           throws XWikiException
Verify if the XWiki.GlobalRedirect page exists and that it contains all the required configuration properties to make the redirection feature work properly. If some properties are missing they are created and saved in the database.

Parameters:
context - the XWiki Context
Returns:
the GlobalRedirect Base Class object containing the properties
Throws:
XWikiException - if an error happens during the save to the datavase

getPrefsClass

public BaseClass getPrefsClass(XWikiContext context)
                        throws XWikiException
Verify if the XWiki.XWikiPreferences page exists and that it contains all the required configuration properties to make XWiki work properly. If some properties are missing they are created and saved in the database.

Parameters:
context - the XWiki Context
Returns:
the XWiki Base Class object containing the properties
Throws:
XWikiException - if an error happens during the save to the datavase

getGroupClass

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

getRightsClass

public BaseClass getRightsClass(java.lang.String pagename,
                                XWikiContext context)
                         throws XWikiException
Throws:
XWikiException

getRightsClass

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

getGlobalRightsClass

public BaseClass getGlobalRightsClass(XWikiContext context)
                               throws XWikiException
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
Throws:
XWikiException

validateUser

public int validateUser(boolean withConfirmEmail,
                        XWikiContext context)
                 throws XWikiException
Throws:
XWikiException

createUser

public int createUser(boolean withValidation,
                      java.lang.String userRights,
                      XWikiContext context)
               throws XWikiException
Throws:
XWikiException

createEmptyUser

public boolean createEmptyUser(java.lang.String xwikiname,
                               java.lang.String userRights,
                               XWikiContext context)
                        throws XWikiException
Method allows to create an empty user with no password (he won't be able to login) This method is usefull for authentication like LDAP or App Server trusted

Parameters:
xwikiname -
userRights -
context -
Returns:
true if success
Throws:
XWikiException

sendConfirmationEmail

public void sendConfirmationEmail(java.lang.String xwikiname,
                                  java.lang.String password,
                                  java.lang.String email,
                                  java.lang.String message,
                                  java.lang.String contentfield,
                                  XWikiContext context)
                           throws XWikiException
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
Throws:
XWikiException

sendValidationEmail

public void sendValidationEmail(java.lang.String xwikiname,
                                java.lang.String password,
                                java.lang.String email,
                                java.lang.String addfieldname,
                                java.lang.String addfieldvalue,
                                java.lang.String contentfield,
                                XWikiContext context)
                         throws XWikiException
Throws:
XWikiException

sendMessage

@Deprecated
public void sendMessage(java.lang.String sender,
                                   java.lang.String[] recipient,
                                   java.lang.String message,
                                   XWikiContext context)
                 throws XWikiException
Deprecated. replaced by the Mail Sender Plugin

Throws:
XWikiException

sendMessage

@Deprecated
public void sendMessage(java.lang.String sender,
                                   java.lang.String recipient,
                                   java.lang.String message,
                                   XWikiContext context)
                 throws XWikiException
Deprecated. replaced by the Mail Sender Plugin

Throws:
XWikiException

generateRandomString

public java.lang.String generateRandomString(int size)

generateValidationKey

public java.lang.String generateValidationKey(int size)

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
Throws:
XWikiException

setUserDefaultGroup

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

addUserToGroup

protected void addUserToGroup(java.lang.String userName,
                              java.lang.String groupName,
                              XWikiContext context)
                       throws XWikiException
Throws:
XWikiException

SetUserDefaultGroup

@Deprecated
public void SetUserDefaultGroup(XWikiContext context,
                                           java.lang.String fullwikiname)
                         throws XWikiException
Deprecated. replaced by setUserDefaultGroup(String fullwikiname, XWikiContext context)

Parameters:
context -
fullwikiname -
Throws:
XWikiException

protectUserPage

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

ProtectUserPage

@Deprecated
public void ProtectUserPage(XWikiContext context,
                                       java.lang.String fullwikiname,
                                       java.lang.String userRights,
                                       XWikiDocument doc)
                     throws XWikiException
Deprecated. replaced by protectUserPage(String,String,XWikiDocument,XWikiContext)

Parameters:
context -
fullwikiname -
userRights -
doc -
Throws:
XWikiException

getUser

public User getUser(XWikiContext context)

getUser

public User getUser(java.lang.String username,
                    XWikiContext context)

prepareResources

public void prepareResources(XWikiContext context)
Prepares the localized resources, according to the selected language. From any point in the code (java, velocity or groovy) the "msg" parameter holds an instance of the localized resource bundle, and the "locale" parameter holds the current locale settings.

Parameters:
context - The request context.

checkAuth

public XWikiUser checkAuth(XWikiContext context)
                    throws XWikiException
Throws:
XWikiException

checkAccess

public boolean checkAccess(java.lang.String action,
                           XWikiDocument doc,
                           XWikiContext context)
                    throws XWikiException
Throws:
XWikiException

include

@Deprecated
public java.lang.String include(java.lang.String topic,
                                           XWikiContext context,
                                           boolean isForm)
                         throws XWikiException
Deprecated. replaced by include(String topic, boolean isForm, XWikiContext context)

Parameters:
topic -
context -
isForm -
Returns:
Throws:
XWikiException

include

public java.lang.String include(java.lang.String topic,
                                boolean isForm,
                                XWikiContext context)
                         throws XWikiException
Throws:
XWikiException

deleteDocument

public void deleteDocument(XWikiDocument doc,
                           XWikiContext context)
                    throws XWikiException
Throws:
XWikiException

deleteDocument

public void deleteDocument(XWikiDocument doc,
                           boolean totrash,
                           XWikiContext context)
                    throws XWikiException
Throws:
XWikiException

getDatabase

public java.lang.String getDatabase()

setDatabase

public void setDatabase(java.lang.String database)

gc

public void gc()

freeMemory

public long freeMemory()

totalMemory

public long totalMemory()

maxMemory

public long maxMemory()

split

public java.lang.String[] split(java.lang.String str,
                                java.lang.String sep)

printStrackTrace

public java.lang.String printStrackTrace(java.lang.Throwable e)

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,
                            boolean reset,
                            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
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

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,
                            boolean force,
                            XWikiContext context)
                     throws XWikiException
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,
                            boolean force,
                            boolean resetCreationData,
                            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
Throws:
XWikiException

copyWikiWeb

public int copyWikiWeb(java.lang.String web,
                       java.lang.String sourceWiki,
                       java.lang.String targetWiki,
                       java.lang.String wikilanguage,
                       boolean clean,
                       XWikiContext context)
                throws XWikiException
Throws:
XWikiException

copyWiki

public int copyWiki(java.lang.String sourceWiki,
                    java.lang.String targetWiki,
                    java.lang.String language,
                    XWikiContext context)
             throws XWikiException
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
Throws:
XWikiException

getEncoding

public java.lang.String getEncoding()

getServerURL

public java.net.URL getServerURL(java.lang.String database,
                                 XWikiContext context)
                          throws java.net.MalformedURLException
Throws:
java.net.MalformedURLException

getServletPath

public java.lang.String getServletPath(java.lang.String wikiName,
                                       XWikiContext context)

getWebAppPath

public java.lang.String getWebAppPath(XWikiContext context)

getURL

public java.lang.String getURL(java.lang.String fullname,
                               java.lang.String action,
                               XWikiContext context)
                        throws XWikiException
Throws:
XWikiException

getExternalURL

public java.lang.String getExternalURL(java.lang.String fullname,
                                       java.lang.String action,
                                       XWikiContext context)
                                throws XWikiException
Throws:
XWikiException

getExternalURL

public java.lang.String getExternalURL(java.lang.String fullname,
                                       java.lang.String action,
                                       java.lang.String querystring,
                                       XWikiContext context)
                                throws XWikiException
Throws:
XWikiException

getURL

public java.lang.String getURL(java.lang.String fullname,
                               java.lang.String action,
                               java.lang.String querystring,
                               XWikiContext context)
                        throws XWikiException
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()

getTimeDelta

public int getTimeDelta(long time)

getDate

public java.util.Date getDate(long time)

isMultiLingual

public boolean isMultiLingual(XWikiContext context)

isVirtualMode

public boolean isVirtualMode()
Returns:
true for multi-wiki/false for mono-wiki

isExo

public boolean isExo()

isLDAP

public boolean isLDAP()

checkActive

public int checkActive(XWikiContext context)
                throws XWikiException
Throws:
XWikiException

checkActive

public int checkActive(java.lang.String user,
                       XWikiContext context)
                throws XWikiException
Throws:
XWikiException

getDocumentName

public java.lang.String getDocumentName(XWikiRequest request,
                                        XWikiContext context)

prepareDocuments

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

setPhonyDocument

public void setPhonyDocument(java.lang.String docName,
                             XWikiContext context,
                             org.apache.velocity.VelocityContext vcontext)

getEngineContext

public XWikiEngineContext getEngineContext()

setEngineContext

public void setEngineContext(XWikiEngineContext engine_context)

getUrlPatternMatcher

public org.securityfilter.filter.URLPatternMatcher getUrlPatternMatcher()

setUrlPatternMatcher

public void setUrlPatternMatcher(org.securityfilter.filter.URLPatternMatcher urlPatternMatcher)

setAuthService

public void setAuthService(XWikiAuthService authService)

setRightService

public void setRightService(XWikiRightService rightService)

getGroupService

public XWikiGroupService getGroupService(XWikiContext context)
                                  throws XWikiException
Throws:
XWikiException

setGroupService

public void setGroupService(XWikiGroupService groupService)

getAuthService

public XWikiAuthService getAuthService()

getRightService

public XWikiRightService getRightService()

getStatsService

public XWikiStatsService getStatsService(XWikiContext context)

getURLFactoryService

public XWikiURLFactoryService getURLFactoryService()

getCriteriaService

public XWikiCriteriaService getCriteriaService(XWikiContext context)

getService

@Deprecated
public java.lang.Object getService(java.lang.String className)
                            throws XWikiException
Deprecated. use getExoService(String) instead

Throws:
XWikiException
See Also:
getExoService(String)

getExoService

public java.lang.Object getExoService(java.lang.String className)
                               throws XWikiException
Privileged API to access an eXo Platform service from the Wiki Engine

Parameters:
className - eXo classname to retrieve the service from
Returns:
A object representing the service
Throws:
XWikiException - if the service cannot be loaded
Since:
1.1 Beta 1

getPortalService

@Deprecated
public java.lang.Object getPortalService(java.lang.String className)
                                  throws XWikiException
Deprecated. use getExoPortalService(String) instead

Throws:
XWikiException
See Also:
getExoPortalService(String)

getExoPortalService

public java.lang.Object getExoPortalService(java.lang.String className)
                                     throws XWikiException
Privileged API to access an eXo Platform Portal service from the Wiki Engine

Parameters:
className - eXo classname to retrieve the service from
Returns:
A object representing the service
Throws:
XWikiException - if the service cannot be loaded
Since:
1.1 Beta 1

getZipOutputStream

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

getRefererText

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

isMySQL

public boolean isMySQL()

getFullNameSQL

public java.lang.String getFullNameSQL()

getFullNameSQL

public java.lang.String getFullNameSQL(boolean newFullName)

getDocName

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

getUserName

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

getUserName

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

getUserName

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

hasCentralizedAuthentication

public boolean hasCentralizedAuthentication(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)

getUserTimeZone

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

getCacheFactory

@Deprecated
public CacheFactory getCacheFactory()
Deprecated. Since 1.7M1, use CacheManager component instead using Utils.getComponent(String).

Returns:
the cache factory.
Since:
1.5M2.

getLocalCacheFactory

@Deprecated
public CacheFactory getLocalCacheFactory()
Deprecated. Since 1.7M1, use CacheManager component instead using Utils.getComponent(String).

Returns:
the cache factory creating local caches.
Since:
1.5M2.

getHttpTimeout

public int getHttpTimeout(XWikiContext context)

getHttpUserAgent

public java.lang.String getHttpUserAgent(XWikiContext context)

getURLContent

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

getURLContent

public java.lang.String getURLContent(java.lang.String surl,
                                      int timeout,
                                      java.lang.String userAgent)
                               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,
                                      XWikiContext context)
                               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,
                                      int timeout,
                                      java.lang.String userAgent)
                               throws java.io.IOException
Throws:
java.io.IOException

getURLContentAsBytes

public byte[] getURLContentAsBytes(java.lang.String surl,
                                   XWikiContext context)
                            throws java.io.IOException
Throws:
java.io.IOException

getURLContentAsBytes

public byte[] getURLContentAsBytes(java.lang.String surl,
                                   int timeout,
                                   java.lang.String userAgent)
                            throws java.io.IOException
Throws:
java.io.IOException

getURLContentAsBytes

public byte[] getURLContentAsBytes(java.lang.String surl,
                                   java.lang.String username,
                                   java.lang.String password,
                                   XWikiContext context)
                            throws java.io.IOException
Throws:
java.io.IOException

getURLContentAsBytes

public byte[] getURLContentAsBytes(java.lang.String surl,
                                   java.lang.String username,
                                   java.lang.String password,
                                   int timeout,
                                   java.lang.String userAgent)
                            throws java.io.IOException
Throws:
java.io.IOException

getSpaces

public java.util.List<java.lang.String> getSpaces(XWikiContext context)
                                           throws XWikiException
Throws:
XWikiException

getSpaceDocsName

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

getIncludedMacros

public java.util.List<java.lang.String> 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)

deleteAllDocuments

public void deleteAllDocuments(XWikiDocument doc,
                               XWikiContext context)
                        throws XWikiException
Throws:
XWikiException

deleteAllDocuments

public void deleteAllDocuments(XWikiDocument doc,
                               boolean totrash,
                               XWikiContext context)
                        throws XWikiException
Throws:
XWikiException

refreshLinks

public void refreshLinks(XWikiContext context)
                  throws XWikiException
Throws:
XWikiException

hasBacklinks

public boolean hasBacklinks(XWikiContext context)

hasTags

public boolean hasTags(XWikiContext context)

hasCustomMappings

public boolean hasCustomMappings()

hasDynamicCustomMappings

public boolean hasDynamicCustomMappings()

getDefaultWeb

public java.lang.String getDefaultWeb(XWikiContext context)

useDefaultWeb

public boolean useDefaultWeb(XWikiContext context)

showViewAction

public boolean showViewAction(XWikiContext context)

useDefaultAction

public boolean useDefaultAction(XWikiContext context)

getDefaultPage

public java.lang.String getDefaultPage(XWikiContext context)

hasEditComment

public boolean hasEditComment(XWikiContext context)

isEditCommentFieldHidden

public boolean isEditCommentFieldHidden(XWikiContext context)

isEditCommentSuggested

public boolean isEditCommentSuggested(XWikiContext context)

isEditCommentMandatory

public boolean isEditCommentMandatory(XWikiContext context)

hasMinorEdit

public boolean hasMinorEdit(XWikiContext context)
See Also:
XWiki.hasMinorEdit()

hasRecycleBin

public boolean hasRecycleBin(XWikiContext context)
Parameters:
context - maybe will be useful
See Also:
XWiki.hasRecycleBin()

hasAttachmentRecycleBin

public boolean hasAttachmentRecycleBin(XWikiContext context)
Indicates whether deleted attachments are stored in a recycle bin or not. This can be configured using the key storage.attachment.recyclebin.

Parameters:
context - The current context, maybe will be useful.
See Also:
com.xpn.xwiki.api.XWiki#hasAttachmentRecycleBin()

renamePage

@Deprecated
public XWikiDocument renamePage(XWikiDocument doc,
                                           java.lang.String newFullName,
                                           XWikiContext context)
                         throws XWikiException
Deprecated. use XWikiDocument.rename(String, XWikiContext) instead

Throws:
XWikiException

renamePage

@Deprecated
public XWikiDocument renamePage(XWikiDocument doc,
                                           XWikiContext context,
                                           java.lang.String newFullName)
                         throws XWikiException
Deprecated. use XWikiDocument.rename(String, XWikiContext) instead

Throws:
XWikiException

getClass

public BaseClass getClass(java.lang.String fullName,
                          XWikiContext context)
                   throws XWikiException
Throws:
XWikiException

getEditorPreference

public java.lang.String getEditorPreference(XWikiContext context)

parseGroovyFromString

public java.lang.Object parseGroovyFromString(java.lang.String script,
                                              XWikiContext context)
                                       throws XWikiException
Privileged API to retrieve an object instantiated from groovy code in a String. Note that Groovy scripts compilation is cached.

Parameters:
script - the Groovy class definition string (public class MyClass { ... })
Returns:
An object instantiating this class
Throws:
XWikiException

parseGroovyFromString

public java.lang.Object parseGroovyFromString(java.lang.String script,
                                              java.lang.String jarWikiPage,
                                              XWikiContext context)
                                       throws XWikiException
Privileged API to retrieve an object instantiated from groovy code in a String, using a classloader including all JAR files located in the passed page as attachments. Note that Groovy scripts compilation is cached

Parameters:
script - the Groovy class definition string (public class MyClass { ... })
Returns:
An object instantiating this class
Throws:
XWikiException

parseGroovyFromPage

public java.lang.Object parseGroovyFromPage(java.lang.String fullname,
                                            XWikiContext context)
                                     throws XWikiException
Throws:
XWikiException

parseGroovyFromPage

public java.lang.Object parseGroovyFromPage(java.lang.String fullName,
                                            java.lang.String jarWikiPage,
                                            XWikiContext context)
                                     throws XWikiException
Throws:
XWikiException

getMacroList

public java.lang.String getMacroList(XWikiContext context)

getObjectFromRequest

public BaseObject getObjectFromRequest(java.lang.String className,
                                       XWikiContext context)
                                throws XWikiException
Throws:
XWikiException

getConvertingUserNameType

public java.lang.String getConvertingUserNameType(XWikiContext context)

convertUsername

public java.lang.String convertUsername(java.lang.String username,
                                        XWikiContext context)

hasSectionEdit

public boolean hasSectionEdit(XWikiContext context)

hasCaptcha

public boolean hasCaptcha(XWikiContext context)

getWysiwygToolbars

public java.lang.String getWysiwygToolbars(XWikiContext context)

clearName

public java.lang.String clearName(java.lang.String name,
                                  XWikiContext context)

clearName

public java.lang.String clearName(java.lang.String name,
                                  boolean stripDots,
                                  boolean ascii,
                                  XWikiContext context)

getUniquePageName

public java.lang.String getUniquePageName(java.lang.String space,
                                          XWikiContext context)

getUniquePageName

public java.lang.String getUniquePageName(java.lang.String space,
                                          java.lang.String name,
                                          XWikiContext context)

displaySearch

public java.lang.String displaySearch(java.lang.String fieldname,
                                      java.lang.String className,
                                      XWikiCriteria criteria,
                                      XWikiContext context)
                               throws XWikiException
Throws:
XWikiException

displaySearch

public java.lang.String displaySearch(java.lang.String fieldname,
                                      java.lang.String className,
                                      XWikiContext context)
                               throws XWikiException
Throws:
XWikiException

displaySearch

public java.lang.String displaySearch(java.lang.String fieldname,
                                      java.lang.String className,
                                      java.lang.String prefix,
                                      XWikiCriteria criteria,
                                      XWikiContext context)
                               throws XWikiException
Throws:
XWikiException

displaySearchColumns

public java.lang.String displaySearchColumns(java.lang.String className,
                                             XWikiQuery query,
                                             XWikiContext context)
                                      throws XWikiException
Throws:
XWikiException

displaySearchColumns

public java.lang.String displaySearchColumns(java.lang.String className,
                                             java.lang.String prefix,
                                             XWikiQuery query,
                                             XWikiContext context)
                                      throws XWikiException
Throws:
XWikiException

displaySearchOrder

public java.lang.String displaySearchOrder(java.lang.String className,
                                           XWikiQuery query,
                                           XWikiContext context)
                                    throws XWikiException
Throws:
XWikiException

displaySearchOrder

public java.lang.String displaySearchOrder(java.lang.String className,
                                           java.lang.String prefix,
                                           XWikiQuery query,
                                           XWikiContext context)
                                    throws XWikiException
Throws:
XWikiException

search

public java.util.List search(XWikiQuery query,
                             XWikiContext context)
                      throws XWikiException
Throws:
XWikiException

createQueryFromRequest

public XWikiQuery createQueryFromRequest(java.lang.String className,
                                         XWikiContext context)
                                  throws XWikiException
Throws:
XWikiException

searchAsTable

public java.lang.String searchAsTable(XWikiQuery query,
                                      XWikiContext context)
                               throws XWikiException
Throws:
XWikiException

getPropertyClassFromName

public PropertyClass getPropertyClassFromName(java.lang.String propPath,
                                              XWikiContext context)

validateDocument

public boolean validateDocument(XWikiDocument doc,
                                XWikiContext context)
                         throws XWikiException
Throws:
XWikiException

getMessage

public java.lang.String getMessage(java.lang.String item,
                                   XWikiContext context)

parseMessage

public java.lang.String parseMessage(java.lang.String id,
                                     XWikiContext context)

parseMessage

public java.lang.String parseMessage(XWikiContext context)

addTooltip

public java.lang.String addTooltip(java.lang.String html,
                                   java.lang.String message,
                                   java.lang.String params,
                                   XWikiContext context)

addTooltipJS

public java.lang.String addTooltipJS(XWikiContext context)

addTooltip

public java.lang.String addTooltip(java.lang.String html,
                                   java.lang.String message,
                                   XWikiContext context)

renamePage

public void renamePage(java.lang.String fullName,
                       java.lang.String newFullName,
                       XWikiContext context)
                throws XWikiException
Throws:
XWikiException

addMandatory

public java.lang.String addMandatory(XWikiContext context)

hasVersioning

public boolean hasVersioning(java.lang.String fullName,
                             XWikiContext context)

hasAttachmentVersioning

public boolean hasAttachmentVersioning(XWikiContext context)

getExternalAttachmentURL

public java.lang.String getExternalAttachmentURL(java.lang.String fullName,
                                                 java.lang.String filename,
                                                 XWikiContext context)

getMaxRecursiveSpaceChecks

public int getMaxRecursiveSpaceChecks(XWikiContext context)

getTempDirectory

public java.io.File getTempDirectory(XWikiContext context)
Get the XWiki temporary filesystem directory (deleted on exit)

Parameters:
context -
Returns:
temporary directory
Since:
1.1 Milestone 4

getWorkSubdirectory

public java.io.File getWorkSubdirectory(java.lang.String subdir,
                                        XWikiContext context)
Get a new directory in the xwiki work directory

Parameters:
subdir - desired directory name
context -
Returns:
work subdirectory
Since:
1.1 Milestone 4

getWorkDirectory

public java.io.File getWorkDirectory(XWikiContext context)
Get the XWiki work directory

Parameters:
context -
Returns:
work directory
Since:
1.1 Milestone 4

rollback

public XWikiDocument rollback(XWikiDocument tdoc,
                              java.lang.String rev,
                              XWikiContext context)
                       throws XWikiException
Throws:
XWikiException

getConfiguredSyntaxes

public java.util.List<java.lang.String> getConfiguredSyntaxes()
Returns:
the ids of configured syntaxes for this wiki (eg "xwiki/1.0", "xwiki/2.0", "mediawiki/1.0", etc)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2004-2008 XWiki. All Rights Reserved.