Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> xpn >> xwiki >> [ api overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.xpn.xwiki.api.XWiki JAVADOC | Sourc code of com.xpn.xwiki.api.XWiki SOURCE | Download com.xpn.xwiki.api.XWiki DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.xpn.xwiki.api
Class XWiki  view XWiki download XWiki.java

java.lang.Object
  extended bycom.xpn.xwiki.api.Api
      extended bycom.xpn.xwiki.api.XWiki
public class XWiki
extends Api

Field Summary
private  com.xpn.xwiki.XWiki xwiki
           
 
Fields inherited from class com.xpn.xwiki.api.Api
context
 
Constructor Summary
XWiki(com.xpn.xwiki.XWiki xwiki, com.xpn.xwiki.XWikiContext context)
           
 
Method Summary
 boolean checkAccess(java.lang.String docname, java.lang.String right)
          Verify the rights the current user has on a document
 boolean copyDocument(java.lang.String docname, java.lang.String targetdocname)
           
 boolean copyDocument(java.lang.String docname, java.lang.String targetdocname, java.lang.String wikilanguage)
           
 boolean copyDocument(java.lang.String docname, java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String wikilanguage)
           
 boolean copyDocument(java.lang.String docname, java.lang.String targetdocname, java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String wikilanguage, boolean reset)
           
 int createNewWiki(java.lang.String wikiName, java.lang.String wikiUrl, java.lang.String wikiAdmin, java.lang.String baseWikiName, boolean failOnExist)
           
 int createNewWiki(java.lang.String wikiName, java.lang.String wikiUrl, java.lang.String wikiAdmin, java.lang.String baseWikiName, java.lang.String description, boolean failOnExist)
           
 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)
           
 int createUser()
           
 int createUser(boolean withValidation)
           
 int createUser(boolean withValidation, java.lang.String userRights)
           
 boolean exists(java.lang.String fullname)
          Returns wether a document exists or not
 void flushCache()
           
 java.lang.String formatDate(java.util.Date date)
           
 java.lang.String formatDate(java.util.Date date, java.lang.String format)
           
 Api get(java.lang.String name)
          Returns a plugin from the plugin API.
 java.lang.String getAdClientId()
          Returns the Advertisement client ID from the preferences
 java.lang.String getAdType()
          Returns the Advertisement system from the preferences
 java.util.List getArrayList()
           
 java.lang.String getAttachmentURL(java.lang.String fullname, java.lang.String filename)
           
 java.lang.String getBaseSkin()
           
 java.util.List getClassList()
          Get the list of available classes in the wiki
 java.util.Date getCurrentDate()
           
 com.xpn.xwiki.stats.impl.DocumentStats getCurrentMonthXWikiStats(java.lang.String action)
           
 java.util.Date getDate()
           
 java.util.Date getDate(long time)
           
 Document getDocument(Document doc, java.lang.String rev)
          Load a specific revision of a document
 Document getDocument(java.lang.String fullname)
          Loads an Document from the database.
 Document getDocument(java.lang.String web, java.lang.String fullname)
          Loads an Document from the database.
 java.lang.String getEncoding()
           
 java.lang.String getFormEncoded(java.lang.String content)
          Transform a text in a form compatible text
 java.lang.String getFullNameSQL()
           
 java.util.Map getHashMap()
           
 java.lang.String getHTMLArea(java.lang.String content)
          Output content in the edit content htmlarea
 java.util.List getIncludedMacros(java.lang.String defaultweb, java.lang.String content)
          Returns the list of Macros documents in the specified content
 java.lang.String getLanguagePreference()
           
 java.lang.String getLocalUserName(java.lang.String user)
           
 java.lang.String getLocalUserName(java.lang.String user, java.lang.String format)
           
 com.xpn.xwiki.objects.meta.MetaClass getMetaclass()
          Get the global MetaClass object
 java.lang.String getNl()
           
 Object getNull()
           
 Api getPlugin(java.lang.String name)
          Returns a plugin from the plugin API.
 java.lang.Object getPortalService(java.lang.String className)
           
 java.util.Collection getRecentActions(java.lang.String action, int size)
          Returns the recently visited pages for a specific action
 java.lang.String getRefererText(java.lang.String referer)
           
 java.lang.String getRequestURL()
           
 java.lang.Object getService(java.lang.String className)
           
 java.lang.String getShortRefererText(java.lang.String referer, int length)
           
 java.lang.String getSkin()
           
 java.lang.String getSkinFile(java.lang.String filename)
           
 java.util.List getSpaceDocsName(java.lang.String SpaceName)
           
 java.util.List getSpaces()
           
 java.lang.String getTextArea(java.lang.String content)
          Output content in the edit content textarea
 int getTimeDelta(long time)
           
 java.lang.String getURL(java.lang.String fullname, java.lang.String action)
           
 java.lang.String getURL(java.lang.String fullname, java.lang.String action, java.lang.String querystring)
           
 java.lang.String getURLContent(java.lang.String surl)
          Returns the content of an HTTP/HTTPS URL
 java.lang.String getURLContent(java.lang.String surl, java.lang.String username, java.lang.String password)
          Returns the content of an HTTP/HTTPS URL protected using Basic Authentication
 java.lang.String getURLEncoded(java.lang.String content)
          Transform a text in a URL compatible text
 java.lang.String getUserName(java.lang.String user)
           
 java.lang.String getUserName(java.lang.String user, java.lang.String format)
           
 java.lang.String getUserPreference(java.lang.String prefname)
           
 java.lang.String getUserPreferenceFromCookie(java.lang.String prefname)
           
 java.lang.String getVersion()
           
 java.lang.String getWebCopyright()
           
 java.lang.String getWebPreference(java.lang.String prefname)
           
 java.lang.String getWebPreference(java.lang.String prefname, java.lang.String default_value)
           
 int getWebPreferenceAsInt(java.lang.String prefname)
           
 int getWebPreferenceAsInt(java.lang.String prefname, int default_value)
           
 long getWebPreferenceAsLong(java.lang.String prefname)
           
 long getWebPreferenceAsLong(java.lang.String prefname, long default_value)
           
 java.lang.String getXMLEncoded(java.lang.String content)
          Transform a text in a XML compatible text
 com.xpn.xwiki.XWiki getXWiki()
           
 java.lang.String getXWikiPreference(java.lang.String prefname)
           
 java.lang.String getXWikiPreference(java.lang.String prefname, java.lang.String default_value)
           
 int getXWikiPreferenceAsInt(java.lang.String prefname)
           
 int getXWikiPreferenceAsInt(java.lang.String prefname, int default_value)
           
 long getXWikiPreferenceAsLong(java.lang.String prefname)
           
 long getXWikiPreferenceAsLong(java.lang.String prefname, long default_value)
           
 boolean hasAccessLevel(java.lang.String level)
           
 boolean hasAccessLevel(java.lang.String level, java.lang.String user, java.lang.String docname)
           
 java.lang.String includeForm(java.lang.String topic)
           
 java.lang.String includeForm(java.lang.String topic, boolean pre)
           
 java.lang.String includeTopic(java.lang.String topic)
           
 java.lang.String includeTopic(java.lang.String topic, boolean pre)
           
 java.lang.String invokeServletAndReturnAsString(java.lang.String url)
          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 isMultiLingual()
           
 boolean isReadOnly()
          returns true if xwiki.readonly is set in the configuration file
 boolean isVirtual()
           
 void outputImage(java.awt.image.BufferedImage image)
           
 java.lang.String parseContent(java.lang.String content)
           
 double parseDouble(java.lang.String str)
          Retrieves a double from a String
 float parseFloat(java.lang.String str)
          Retrieves a float from a String
 int parseInt(java.lang.String str)
          Retrieves a int from a String
 java.lang.Integer parseInteger(java.lang.String str)
          Retrieves a int from a String
 long parseLong(java.lang.String str)
          Retrieves a long from a String
 java.lang.String parseTemplate(java.lang.String template)
           
 java.lang.String printStrackTrace(java.lang.Throwable e)
           
 java.lang.String renderChunk(Chunk chunk, boolean source, Document doc)
           
 java.lang.String renderChunk(Chunk chunk, Document doc)
           
 java.lang.String renderText(java.lang.String text, Document doc)
           
 java.util.List search(java.lang.String wheresql)
           
 java.util.List search(java.lang.String wheresql, int nb, int start)
           
 java.util.List searchDocuments(java.lang.String wheresql)
           
 java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbylanguage)
           
 java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbylanguage, int nb, int start)
           
 java.util.List searchDocuments(java.lang.String wheresql, int nb, int start)
           
 java.util.List searchDocuments(java.lang.String wheresql, int nb, int start, java.lang.String selectColumns)
           
 void sendMessage(java.lang.String sender, java.lang.String[] recipient, java.lang.String message)
           
 void sendMessage(java.lang.String sender, java.lang.String recipient, java.lang.String message)
           
 void setReadOnly(boolean ro)
           
 java.lang.String[] split(java.lang.String str, java.lang.String sep)
           
 java.lang.String sqlfilter(java.lang.String text)
          Filters text to be include in = or like clause in SQL
 int validateUser(boolean withConfirmEmail)
           
 
Methods inherited from class com.xpn.xwiki.api.Api
checkProgrammingRights, hasAccessLevel, hasAdminRights, hasProgrammingRights
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

xwiki

private com.xpn.xwiki.XWiki xwiki
Constructor Detail

XWiki

public XWiki(com.xpn.xwiki.XWiki xwiki,
             com.xpn.xwiki.XWikiContext context)
Method Detail

getXWiki

public com.xpn.xwiki.XWiki getXWiki()

getVersion

public java.lang.String getVersion()

getRequestURL

public java.lang.String getRequestURL()
                               throws com.xpn.xwiki.XWikiException

getDocument

public Document getDocument(java.lang.String fullname)
                     throws com.xpn.xwiki.XWikiException
Loads an Document from the database. Rights are checked before sending back the document.

exists

public boolean exists(java.lang.String fullname)
               throws com.xpn.xwiki.XWikiException
Returns wether a document exists or not

checkAccess

public boolean checkAccess(java.lang.String docname,
                           java.lang.String right)
Verify the rights the current user has on a document

getDocument

public Document getDocument(java.lang.String web,
                            java.lang.String fullname)
                     throws com.xpn.xwiki.XWikiException
Loads an Document from the database. Rights are checked before sending back the document.

getDocument

public Document getDocument(Document doc,
                            java.lang.String rev)
                     throws com.xpn.xwiki.XWikiException
Load a specific revision of a document

getFormEncoded

public java.lang.String getFormEncoded(java.lang.String content)
Transform a text in a form compatible text

getURLEncoded

public java.lang.String getURLEncoded(java.lang.String content)
Transform a text in a URL compatible text

getXMLEncoded

public java.lang.String getXMLEncoded(java.lang.String content)
Transform a text in a XML compatible text

getTextArea

public java.lang.String getTextArea(java.lang.String content)
Output content in the edit content textarea

getHTMLArea

public java.lang.String getHTMLArea(java.lang.String content)
Output content in the edit content htmlarea

getClassList

public java.util.List getClassList()
                            throws com.xpn.xwiki.XWikiException
Get the list of available classes in the wiki

getMetaclass

public com.xpn.xwiki.objects.meta.MetaClass getMetaclass()
Get the global MetaClass object

search

public java.util.List search(java.lang.String wheresql)
                      throws com.xpn.xwiki.XWikiException

search

public java.util.List search(java.lang.String wheresql,
                             int nb,
                             int start)
                      throws com.xpn.xwiki.XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql)
                               throws com.xpn.xwiki.XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      int nb,
                                      int start)
                               throws com.xpn.xwiki.XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      int nb,
                                      int start,
                                      java.lang.String selectColumns)
                               throws com.xpn.xwiki.XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      boolean distinctbylanguage)
                               throws com.xpn.xwiki.XWikiException

searchDocuments

public java.util.List searchDocuments(java.lang.String wheresql,
                                      boolean distinctbylanguage,
                                      int nb,
                                      int start)
                               throws com.xpn.xwiki.XWikiException

parseContent

public java.lang.String parseContent(java.lang.String content)

parseTemplate

public java.lang.String parseTemplate(java.lang.String template)

invokeServletAndReturnAsString

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

getSkin

public java.lang.String getSkin()

getBaseSkin

public java.lang.String getBaseSkin()

getWebCopyright

public java.lang.String getWebCopyright()

getXWikiPreference

public java.lang.String getXWikiPreference(java.lang.String prefname)

getXWikiPreference

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

getWebPreference

public java.lang.String getWebPreference(java.lang.String prefname)

getWebPreference

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

getXWikiPreferenceAsLong

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

getXWikiPreferenceAsLong

public long getXWikiPreferenceAsLong(java.lang.String prefname)

getWebPreferenceAsLong

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

getWebPreferenceAsLong

public long getWebPreferenceAsLong(java.lang.String prefname)

getXWikiPreferenceAsInt

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

getXWikiPreferenceAsInt

public int getXWikiPreferenceAsInt(java.lang.String prefname)

getWebPreferenceAsInt

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

getWebPreferenceAsInt

public int getWebPreferenceAsInt(java.lang.String prefname)

getUserPreference

public java.lang.String getUserPreference(java.lang.String prefname)

getUserPreferenceFromCookie

public java.lang.String getUserPreferenceFromCookie(java.lang.String prefname)

getLanguagePreference

public java.lang.String getLanguagePreference()

isVirtual

public boolean isVirtual()

isMultiLingual

public boolean isMultiLingual()

flushCache

public void flushCache()

createUser

public int createUser()
               throws com.xpn.xwiki.XWikiException

createUser

public int createUser(boolean withValidation)
               throws com.xpn.xwiki.XWikiException

createUser

public int createUser(boolean withValidation,
                      java.lang.String userRights)
               throws com.xpn.xwiki.XWikiException

createNewWiki

public int createNewWiki(java.lang.String wikiName,
                         java.lang.String wikiUrl,
                         java.lang.String wikiAdmin,
                         java.lang.String baseWikiName,
                         boolean failOnExist)
                  throws com.xpn.xwiki.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,
                         boolean failOnExist)
                  throws com.xpn.xwiki.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)
                  throws com.xpn.xwiki.XWikiException

validateUser

public int validateUser(boolean withConfirmEmail)
                 throws com.xpn.xwiki.XWikiException

sendMessage

public void sendMessage(java.lang.String sender,
                        java.lang.String recipient,
                        java.lang.String message)
                 throws com.xpn.xwiki.XWikiException

sendMessage

public void sendMessage(java.lang.String sender,
                        java.lang.String[] recipient,
                        java.lang.String message)
                 throws com.xpn.xwiki.XWikiException

copyDocument

public boolean copyDocument(java.lang.String docname,
                            java.lang.String targetdocname)
                     throws com.xpn.xwiki.XWikiException

copyDocument

public boolean copyDocument(java.lang.String docname,
                            java.lang.String targetdocname,
                            java.lang.String wikilanguage)
                     throws com.xpn.xwiki.XWikiException

copyDocument

public boolean copyDocument(java.lang.String docname,
                            java.lang.String sourceWiki,
                            java.lang.String targetWiki,
                            java.lang.String wikilanguage)
                     throws com.xpn.xwiki.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)
                     throws com.xpn.xwiki.XWikiException

includeTopic

public java.lang.String includeTopic(java.lang.String topic)
                              throws com.xpn.xwiki.XWikiException

includeForm

public java.lang.String includeForm(java.lang.String topic)
                             throws com.xpn.xwiki.XWikiException

includeTopic

public java.lang.String includeTopic(java.lang.String topic,
                                     boolean pre)
                              throws com.xpn.xwiki.XWikiException

includeForm

public java.lang.String includeForm(java.lang.String topic,
                                    boolean pre)
                             throws com.xpn.xwiki.XWikiException

hasAccessLevel

public boolean hasAccessLevel(java.lang.String level)

hasAccessLevel

public boolean hasAccessLevel(java.lang.String level,
                              java.lang.String user,
                              java.lang.String docname)

renderText

public java.lang.String renderText(java.lang.String text,
                                   Document doc)

renderChunk

public java.lang.String renderChunk(Chunk chunk,
                                    Document doc)

renderChunk

public java.lang.String renderChunk(Chunk chunk,
                                    boolean source,
                                    Document doc)

getSpaces

public java.util.List getSpaces()
                         throws com.xpn.xwiki.XWikiException

getSpaceDocsName

public java.util.List getSpaceDocsName(java.lang.String SpaceName)
                                throws com.xpn.xwiki.XWikiException

getCurrentDate

public java.util.Date getCurrentDate()

getDate

public java.util.Date getDate()

getTimeDelta

public int getTimeDelta(long time)

getDate

public java.util.Date getDate(long time)

split

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

printStrackTrace

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

getEncoding

public java.lang.String getEncoding()

getNull

public Object getNull()

getNl

public java.lang.String getNl()

getAttachmentURL

public java.lang.String getAttachmentURL(java.lang.String fullname,
                                         java.lang.String filename)
                                  throws com.xpn.xwiki.XWikiException

getURL

public java.lang.String getURL(java.lang.String fullname,
                               java.lang.String action)
                        throws com.xpn.xwiki.XWikiException

getURL

public java.lang.String getURL(java.lang.String fullname,
                               java.lang.String action,
                               java.lang.String querystring)
                        throws com.xpn.xwiki.XWikiException

getService

public java.lang.Object getService(java.lang.String className)
                            throws com.xpn.xwiki.XWikiException

getPortalService

public java.lang.Object getPortalService(java.lang.String className)
                                  throws com.xpn.xwiki.XWikiException

getArrayList

public java.util.List getArrayList()

getHashMap

public java.util.Map getHashMap()

outputImage

public void outputImage(java.awt.image.BufferedImage image)
                 throws java.io.IOException

getCurrentMonthXWikiStats

public com.xpn.xwiki.stats.impl.DocumentStats getCurrentMonthXWikiStats(java.lang.String action)

getRefererText

public java.lang.String getRefererText(java.lang.String referer)

getShortRefererText

public java.lang.String getShortRefererText(java.lang.String referer,
                                            int length)

getFullNameSQL

public java.lang.String getFullNameSQL()

getUserName

public java.lang.String getUserName(java.lang.String user)

getUserName

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

getLocalUserName

public java.lang.String getLocalUserName(java.lang.String user)

getLocalUserName

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

formatDate

public java.lang.String formatDate(java.util.Date date)

formatDate

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

get

public Api get(java.lang.String name)
Returns a plugin from the plugin API. Plugin Rights can be verified.

getPlugin

public Api getPlugin(java.lang.String name)
Returns a plugin from the plugin API. Plugin Rights can be verified.

getRecentActions

public java.util.Collection getRecentActions(java.lang.String action,
                                             int size)
Returns the recently visited pages for a specific action

getAdType

public java.lang.String getAdType()
Returns the Advertisement system from the preferences

getAdClientId

public java.lang.String getAdClientId()
Returns the Advertisement client ID from the preferences

parseInt

public int parseInt(java.lang.String str)
Retrieves a int from a String

parseInteger

public java.lang.Integer parseInteger(java.lang.String str)
Retrieves a int from a String

parseLong

public long parseLong(java.lang.String str)
Retrieves a long from a String

parseFloat

public float parseFloat(java.lang.String str)
Retrieves a float from a String

parseDouble

public double parseDouble(java.lang.String str)
Retrieves a double from a String

getURLContent

public java.lang.String getURLContent(java.lang.String surl,
                                      java.lang.String username,
                                      java.lang.String password)
                               throws java.io.IOException
Returns the content of an HTTP/HTTPS URL protected using Basic Authentication

getURLContent

public java.lang.String getURLContent(java.lang.String surl)
                               throws java.io.IOException
Returns the content of an HTTP/HTTPS URL

sqlfilter

public java.lang.String sqlfilter(java.lang.String text)
Filters text to be include in = or like clause in SQL

getIncludedMacros

public java.util.List getIncludedMacros(java.lang.String defaultweb,
                                        java.lang.String content)
Returns the list of Macros documents in the specified content

isReadOnly

public boolean isReadOnly()
returns true if xwiki.readonly is set in the configuration file

setReadOnly

public void setReadOnly(boolean ro)
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> xpn >> xwiki >> [ api overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.xpn.xwiki.api.XWiki JAVADOC | Sourc code of com.xpn.xwiki.api.XWiki SOURCE | Download com.xpn.xwiki.api.XWiki DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD