com.xpn.xwiki
Interface XWikiInterface

All Known Implementing Classes:
XWiki

public interface XWikiInterface


Method Summary
 boolean checkAccess(java.lang.String action, XWikiDocument doc, XWikiContext context)
           
 int checkActive(XWikiContext context)
           
 XWikiUser checkAuth(XWikiContext context)
           
 boolean copyDocument(java.lang.String docname, java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String language, 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 language, XWikiContext context)
           
 int createNewWiki(java.lang.String wikiName, java.lang.String wikiUrl, java.lang.String wikiAdmin, java.lang.String baseWikiName, java.lang.String description, java.lang.String language, boolean failOnExist, XWikiContext context)
           
 int createUser(boolean withValidation, java.lang.String userRights, XWikiContext context)
           
 int createUser(java.lang.String xwikiname, java.util.Map map, java.lang.String parent, java.lang.String content, java.lang.String userRights, XWikiContext context)
           
 int createUser(XWikiContext context)
           
 void deleteDocument(XWikiDocument doc, XWikiContext context)
           
 void flushCache()
           
 long freeMemory()
           
 void gc()
           
 java.lang.String generateValidationKey(int size)
           
 XWikiAuthService getAuthService()
           
 java.util.List getClassList(XWikiContext context)
           
 XWikiConfig getConfig()
           
 java.util.Date getCurrentDate()
           
 java.lang.String getDatabase()
           
 java.util.Date getDate(long time)
           
 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 getEncoding()
           
 XWikiEngineContext getEngineContext()
           
 BaseClass getGlobalRightsClass(XWikiContext context)
           
 BaseClass getGroupClass(XWikiContext context)
           
 XWikiGroupService getGroupService()
           
 java.lang.String getLanguagePreference(XWikiContext context)
           
 MetaClass getMetaclass()
           
 XWikiNotificationManager getNotificationManager()
           
 XWikiPluginManager getPluginManager()
           
 java.lang.String getRealPath(java.lang.String path)
           
 XWikiRenderingEngine getRenderingEngine()
           
 java.net.URL getResource(java.lang.String s)
           
 java.io.InputStream getResourceAsStream(java.lang.String s)
           
 java.lang.String getResourceContent(java.lang.String name)
           
 BaseClass getRightsClass(java.lang.String pagename, XWikiContext context)
           
 BaseClass getRightsClass(XWikiContext context)
           
 XWikiRightService getRightService()
           
 java.net.URL getServerURL(java.lang.String database, XWikiContext context)
           
 java.lang.Object getService(java.lang.String className)
           
 java.lang.String getSkin(XWikiContext context)
           
 java.lang.String getSkinFile(java.lang.String filename, XWikiContext context)
           
 XWikiStoreInterface getStore()
           
 int getTimeDelta(long time)
           
 java.lang.String getURL(java.lang.String fullname, java.lang.String action, java.lang.String querystring, XWikiContext context)
           
 java.lang.String getURL(java.lang.String fullname, java.lang.String action, XWikiContext context)
           
 org.securityfilter.filter.URLPatternMatcher getUrlPatternMatcher()
           
 User getUser(XWikiContext context)
           
 BaseClass getUserClass(XWikiContext context)
           
 java.lang.String getUserName(java.lang.String user, java.lang.String format, 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)
           
 java.lang.String getUserPreferenceFromCookie(java.lang.String prefname, XWikiContext context)
           
 java.lang.String getVersion()
           
 java.util.List getVirtualWikiList()
           
 java.lang.String getWebCopyright(XWikiContext context)
           
 java.lang.String getWebPreference(java.lang.String prefname, java.lang.String default_value, XWikiContext context)
           
 java.lang.String getWebPreference(java.lang.String prefname, XWikiContext context)
           
 int getWebPreferenceAsInt(java.lang.String prefname, int default_value, XWikiContext context)
           
 int getWebPreferenceAsInt(java.lang.String prefname, XWikiContext context)
           
 long getWebPreferenceAsLong(java.lang.String prefname, long default_value, XWikiContext context)
           
 long getWebPreferenceAsLong(java.lang.String prefname, XWikiContext context)
           
 java.lang.String getXWikiPreference(java.lang.String prefname, java.lang.String default_value, XWikiContext context)
           
 java.lang.String getXWikiPreference(java.lang.String prefname, XWikiContext context)
           
 int getXWikiPreferenceAsInt(java.lang.String prefname, int default_value, XWikiContext context)
           
 int getXWikiPreferenceAsInt(java.lang.String prefname, XWikiContext context)
           
 long getXWikiPreferenceAsLong(java.lang.String prefname, long default_value, XWikiContext context)
           
 long getXWikiPreferenceAsLong(java.lang.String prefname, XWikiContext context)
           
 java.lang.String include(java.lang.String topic, XWikiContext context, boolean isForm)
           
 void initXWiki(XWikiConfig config, XWikiContext context, XWikiEngineContext engine_context, boolean noupdate)
           
 boolean isExo()
           
 boolean isMultiLingual(XWikiContext context)
           
 boolean isTest()
           
 boolean isVirtual()
           
 long maxMemory()
           
 void notify(XWikiNotificationRule rule, XWikiDocument newdoc, XWikiDocument olddoc, int event, XWikiContext context)
           
 java.lang.String Param(java.lang.String key)
           
 java.lang.String Param(java.lang.String key, java.lang.String default_value)
           
 long ParamAsLong(java.lang.String key)
           
 long ParamAsLong(java.lang.String key, long default_value)
           
 java.lang.String ParamAsRealPath(java.lang.String key)
           
 java.lang.String ParamAsRealPath(java.lang.String key, XWikiContext context)
           
 java.lang.String ParamAsRealPathVerified(java.lang.String param)
           
 java.lang.String parseContent(java.lang.String content, XWikiContext context)
           
 java.lang.String parseTemplate(java.lang.String template, XWikiContext context)
           
 boolean prepareDocuments(XWikiRequest request, XWikiContext context, org.apache.velocity.VelocityContext vcontext)
           
 void prepareResources(XWikiContext context)
           
 java.lang.String printStrackTrace(java.lang.Throwable e)
           
 boolean resourceExists(java.lang.String name)
           
 void saveDocument(XWikiDocument doc, XWikiContext context)
           
 void saveDocument(XWikiDocument doc, XWikiDocument olddoc, XWikiContext context)
           
 java.util.List search(java.lang.String wheresql, int nb, int start, XWikiContext context)
           
 java.util.List search(java.lang.String wheresql, XWikiContext context)
           
 void sendMessage(java.lang.String sender, java.lang.String[] recipient, java.lang.String message, XWikiContext context)
           
 void sendMessage(java.lang.String sender, java.lang.String recipient, java.lang.String message, XWikiContext context)
           
 void sendValidationEmail(java.lang.String xwikiname, java.lang.String password, java.lang.String email, java.lang.String validkey, java.lang.String contentfield, XWikiContext context)
           
 void setAuthService(XWikiAuthService authService)
           
 void setConfig(XWikiConfig config)
           
 void setDatabase(java.lang.String database)
           
 void setEngineContext(XWikiEngineContext engine_context)
           
 void setGroupService(XWikiGroupService groupService)
           
 void setMetaclass(MetaClass metaclass)
           
 void setNotificationManager(XWikiNotificationManager notificationManager)
           
 void setPluginManager(XWikiPluginManager pluginManager)
           
 void setRenderingEngine(XWikiRenderingEngine renderingEngine)
           
 void setRightService(XWikiRightService rightService)
           
 void setStore(XWikiStoreInterface store)
           
 void setTest(boolean test)
           
 void setUrlPatternMatcher(org.securityfilter.filter.URLPatternMatcher urlPatternMatcher)
           
 void setVersion(java.lang.String version)
           
 java.lang.String[] split(java.lang.String str, java.lang.String sep)
           
 long totalMemory()
           
 void updateDatabase(java.lang.String appname, XWikiContext context)
           
 int validateUser(boolean withConfirmEmail, XWikiContext context)
           
 

Method Detail

updateDatabase

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

getVirtualWikiList

public java.util.List getVirtualWikiList()

initXWiki

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

getVersion

public java.lang.String getVersion()

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

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()

saveDocument

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

saveDocument

public void saveDocument(XWikiDocument doc,
                         XWikiDocument olddoc,
                         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

getRenderingEngine

public XWikiRenderingEngine getRenderingEngine()

setRenderingEngine

public void setRenderingEngine(XWikiRenderingEngine renderingEngine)

getMetaclass

public MetaClass getMetaclass()

setMetaclass

public void setMetaclass(MetaClass metaclass)

getClassList

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

search

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

search

public java.util.List search(java.lang.String wheresql,
                             int nb,
                             int start,
                             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)

getSkinFile

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

getSkin

public java.lang.String getSkin(XWikiContext context)

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 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)

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)

getLanguagePreference

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

getWebPreferenceAsLong

public long getWebPreferenceAsLong(java.lang.String prefname,
                                   long default_value,
                                   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)

getWebPreferenceAsInt

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

flushCache

public void flushCache()

getPluginManager

public XWikiPluginManager getPluginManager()

setPluginManager

public void setPluginManager(XWikiPluginManager pluginManager)

setConfig

public void setConfig(XWikiConfig config)

setStore

public void setStore(XWikiStoreInterface store)

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)

getUserClass

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

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

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

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

sendMessage

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

sendMessage

public void sendMessage(java.lang.String sender,
                        java.lang.String recipient,
                        java.lang.String message,
                        XWikiContext context)
                 throws XWikiException
Throws:
XWikiException

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

getUser

public User getUser(XWikiContext context)

prepareResources

public void prepareResources(XWikiContext 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

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

deleteDocument

public void deleteDocument(XWikiDocument doc,
                           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 sourceWiki,
                            java.lang.String targetWiki,
                            java.lang.String language,
                            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 language,
                       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 language,
                         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

getURL

public java.lang.String getURL(java.lang.String fullname,
                               java.lang.String action,
                               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

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)

isVirtual

public boolean isVirtual()

isExo

public boolean isExo()

checkActive

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

prepareDocuments

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

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()

setGroupService

public void setGroupService(XWikiGroupService groupService)

getAuthService

public XWikiAuthService getAuthService()

getRightService

public XWikiRightService getRightService()

getService

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

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)


Copyright 2003 Ludovic Dubost