com.xpn.xwiki.api
Class XWiki
java.lang.Object
com.xpn.xwiki.api.Api
com.xpn.xwiki.api.XWiki
- public class XWiki
- extends Api
Fields inherited from class com.xpn.xwiki.api.Api |
context |
Method Summary |
boolean |
checkAccess(java.lang.String docname,
java.lang.String right)
|
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)
|
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)
|
java.lang.String |
getAdClientId()
|
java.lang.String |
getAdType()
|
java.util.List |
getArrayList()
|
java.lang.String |
getAttachmentURL(java.lang.String fullname,
java.lang.String filename)
|
java.lang.String |
getBaseSkin()
|
java.util.List |
getClassList()
|
java.util.Date |
getCurrentDate()
|
DocumentStats |
getCurrentMonthXWikiStats(java.lang.String action)
|
java.util.Date |
getDate()
|
java.util.Date |
getDate(long time)
|
Document |
getDocument(Document doc,
java.lang.String rev)
|
Document |
getDocument(java.lang.String fullname)
|
Document |
getDocument(java.lang.String web,
java.lang.String fullname)
|
java.lang.String |
getEncoding()
|
java.lang.String |
getFormEncoded(java.lang.String content)
|
java.lang.String |
getFullNameSQL()
|
java.util.Map |
getHashMap()
|
java.lang.String |
getHTMLArea(java.lang.String 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)
|
MetaClass |
getMetaclass()
|
java.lang.String |
getNl()
|
Object |
getNull()
|
Api |
getPlugin(java.lang.String name)
|
java.lang.Object |
getPortalService(java.lang.String className)
|
java.util.Collection |
getRecentActions(java.lang.String action,
int size)
|
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.lang.String |
getTextArea(java.lang.String content)
|
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)
|
java.lang.String |
getURLContent(java.lang.String surl,
java.lang.String username,
java.lang.String password)
|
java.lang.String |
getURLEncoded(java.lang.String content)
|
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)
|
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)
|
boolean |
isMultiLingual()
|
boolean |
isVirtual()
|
void |
outputImage(java.awt.image.BufferedImage image)
|
java.lang.String |
parseContent(java.lang.String content)
|
double |
parseDouble(java.lang.String str)
|
float |
parseFloat(java.lang.String str)
|
int |
parseInt(java.lang.String str)
|
java.lang.Integer |
parseInteger(java.lang.String str)
|
long |
parseLong(java.lang.String str)
|
java.lang.String |
parseTemplate(java.lang.String template)
|
java.lang.String |
printStrackTrace(java.lang.Throwable e)
|
java.lang.String |
renderChunk(org.apache.commons.jrcs.diff.Chunk chunk,
boolean source,
Document doc)
|
java.lang.String |
renderChunk(org.apache.commons.jrcs.diff.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)
|
java.lang.String[] |
split(java.lang.String str,
java.lang.String sep)
|
java.lang.String |
sqlfilter(java.lang.String text)
|
int |
validateUser(boolean withConfirmEmail)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
xwiki
private XWiki xwiki
XWiki
public XWiki(XWiki xwiki,
XWikiContext context)
getXWiki
public XWiki getXWiki()
getVersion
public java.lang.String getVersion()
getRequestURL
public java.lang.String getRequestURL()
throws XWikiException
- Throws:
XWikiException
getDocument
public Document getDocument(java.lang.String fullname)
throws XWikiException
- Throws:
XWikiException
exists
public boolean exists(java.lang.String fullname)
throws XWikiException
- Throws:
XWikiException
checkAccess
public boolean checkAccess(java.lang.String docname,
java.lang.String right)
getDocument
public Document getDocument(java.lang.String web,
java.lang.String fullname)
throws XWikiException
- Throws:
XWikiException
getDocument
public Document getDocument(Document doc,
java.lang.String rev)
throws XWikiException
- Throws:
XWikiException
getFormEncoded
public java.lang.String getFormEncoded(java.lang.String content)
getURLEncoded
public java.lang.String getURLEncoded(java.lang.String content)
getXMLEncoded
public java.lang.String getXMLEncoded(java.lang.String content)
getTextArea
public java.lang.String getTextArea(java.lang.String content)
getHTMLArea
public java.lang.String getHTMLArea(java.lang.String content)
getClassList
public java.util.List getClassList()
throws XWikiException
- Throws:
XWikiException
getMetaclass
public MetaClass getMetaclass()
search
public java.util.List search(java.lang.String wheresql)
throws XWikiException
- Throws:
XWikiException
search
public java.util.List search(java.lang.String wheresql,
int nb,
int start)
throws XWikiException
- Throws:
XWikiException
searchDocuments
public java.util.List searchDocuments(java.lang.String wheresql)
throws XWikiException
- Throws:
XWikiException
searchDocuments
public java.util.List searchDocuments(java.lang.String wheresql,
int nb,
int start)
throws XWikiException
- Throws:
XWikiException
searchDocuments
public java.util.List searchDocuments(java.lang.String wheresql,
int nb,
int start,
java.lang.String selectColumns)
throws XWikiException
- Throws:
XWikiException
searchDocuments
public java.util.List searchDocuments(java.lang.String wheresql,
boolean distinctbylanguage)
throws XWikiException
- Throws:
XWikiException
searchDocuments
public java.util.List searchDocuments(java.lang.String wheresql,
boolean distinctbylanguage,
int nb,
int start)
throws XWikiException
- Throws:
XWikiException
parseContent
public java.lang.String parseContent(java.lang.String content)
parseTemplate
public java.lang.String parseTemplate(java.lang.String template)
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 XWikiException
- Throws:
XWikiException
createUser
public int createUser(boolean withValidation)
throws XWikiException
- Throws:
XWikiException
createUser
public int createUser(boolean withValidation,
java.lang.String userRights)
throws XWikiException
- Throws:
XWikiException
createNewWiki
public int createNewWiki(java.lang.String wikiName,
java.lang.String wikiUrl,
java.lang.String wikiAdmin,
java.lang.String baseWikiName,
boolean failOnExist)
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,
boolean failOnExist)
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)
throws XWikiException
- Throws:
XWikiException
validateUser
public int validateUser(boolean withConfirmEmail)
throws XWikiException
- Throws:
XWikiException
sendMessage
public void sendMessage(java.lang.String sender,
java.lang.String recipient,
java.lang.String message)
throws XWikiException
- Throws:
XWikiException
sendMessage
public void sendMessage(java.lang.String sender,
java.lang.String[] recipient,
java.lang.String message)
throws XWikiException
- Throws:
XWikiException
copyDocument
public boolean copyDocument(java.lang.String docname,
java.lang.String targetdocname)
throws XWikiException
- Throws:
XWikiException
copyDocument
public boolean copyDocument(java.lang.String docname,
java.lang.String targetdocname,
java.lang.String wikilanguage)
throws XWikiException
- Throws:
XWikiException
copyDocument
public boolean copyDocument(java.lang.String docname,
java.lang.String sourceWiki,
java.lang.String targetWiki,
java.lang.String wikilanguage)
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)
throws XWikiException
- Throws:
XWikiException
includeTopic
public java.lang.String includeTopic(java.lang.String topic)
throws XWikiException
- Throws:
XWikiException
includeForm
public java.lang.String includeForm(java.lang.String topic)
throws XWikiException
- Throws:
XWikiException
includeTopic
public java.lang.String includeTopic(java.lang.String topic,
boolean pre)
throws XWikiException
- Throws:
XWikiException
includeForm
public java.lang.String includeForm(java.lang.String topic,
boolean pre)
throws XWikiException
- Throws:
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(org.apache.commons.jrcs.diff.Chunk chunk,
Document doc)
renderChunk
public java.lang.String renderChunk(org.apache.commons.jrcs.diff.Chunk chunk,
boolean source,
Document doc)
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 XWikiException
- Throws:
XWikiException
getURL
public java.lang.String getURL(java.lang.String fullname,
java.lang.String action)
throws XWikiException
- Throws:
XWikiException
getURL
public java.lang.String getURL(java.lang.String fullname,
java.lang.String action,
java.lang.String querystring)
throws XWikiException
- Throws:
XWikiException
getService
public java.lang.Object getService(java.lang.String className)
throws XWikiException
- Throws:
XWikiException
getPortalService
public java.lang.Object getPortalService(java.lang.String className)
throws XWikiException
- Throws:
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
- Throws:
java.io.IOException
getCurrentMonthXWikiStats
public 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)
getPlugin
public Api getPlugin(java.lang.String name)
getRecentActions
public java.util.Collection getRecentActions(java.lang.String action,
int size)
getAdType
public java.lang.String getAdType()
getAdClientId
public java.lang.String getAdClientId()
parseInt
public int parseInt(java.lang.String str)
parseInteger
public java.lang.Integer parseInteger(java.lang.String str)
parseLong
public long parseLong(java.lang.String str)
parseFloat
public float parseFloat(java.lang.String str)
parseDouble
public double parseDouble(java.lang.String str)
getURLContent
public java.lang.String getURLContent(java.lang.String surl,
java.lang.String username,
java.lang.String password)
throws java.io.IOException
- Throws:
java.io.IOException
getURLContent
public java.lang.String getURLContent(java.lang.String surl)
throws java.io.IOException
- Throws:
java.io.IOException
sqlfilter
public java.lang.String sqlfilter(java.lang.String text)
Copyright 2003 Ludovic Dubost