|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.api.Api
com.xpn.xwiki.api.XWiki
Field Summary | |
private XWiki |
xwiki
|
Fields inherited from class com.xpn.xwiki.api.Api |
context |
Constructor Summary | |
XWiki(XWiki 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()
|
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)
|
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 |
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(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)
|
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 |
private XWiki xwiki
Constructor Detail |
public XWiki(XWiki xwiki, XWikiContext context)
Method Detail |
public XWiki getXWiki()
public java.lang.String getVersion()
public java.lang.String getRequestURL() throws XWikiException
XWikiException
public Document getDocument(java.lang.String fullname) throws XWikiException
fullname
- Fullname of the XWiki document to be loaded
XWikiException
public boolean exists(java.lang.String fullname) throws XWikiException
fullname
- Fullname of the XWiki document to be loaded
XWikiException
public boolean checkAccess(java.lang.String docname, java.lang.String right)
docname
- fullname of the documentright
- right to check ("view", "edit", "admin", "delete")
public Document getDocument(java.lang.String web, java.lang.String fullname) throws XWikiException
web
- Space to use in case no space is defined in the fullnamefullname
- Fullname or relative name of the document to load
XWikiException
public Document getDocument(Document doc, java.lang.String rev) throws XWikiException
doc
- Document for which to load a specific revisionrev
- Revision number
XWikiException
public java.lang.String getFormEncoded(java.lang.String content)
content
- text to transform
public java.lang.String getURLEncoded(java.lang.String content)
content
- text to transform
public java.lang.String getXMLEncoded(java.lang.String content)
content
- text to transform
public java.lang.String getTextArea(java.lang.String content)
content
- content to output
public java.lang.String getHTMLArea(java.lang.String content)
content
- content to output
public java.util.List getClassList() throws XWikiException
XWikiException
public MetaClass getMetaclass()
public java.util.List search(java.lang.String wheresql) throws XWikiException
XWikiException
public java.util.List search(java.lang.String wheresql, int nb, int start) throws XWikiException
XWikiException
public java.util.List searchDocuments(java.lang.String wheresql) throws XWikiException
XWikiException
public java.util.List searchDocuments(java.lang.String wheresql, int nb, int start) throws XWikiException
XWikiException
public java.util.List searchDocuments(java.lang.String wheresql, int nb, int start, java.lang.String selectColumns) throws XWikiException
XWikiException
public java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbylanguage) throws XWikiException
XWikiException
public java.util.List searchDocuments(java.lang.String wheresql, boolean distinctbylanguage, int nb, int start) throws XWikiException
XWikiException
public java.lang.String parseContent(java.lang.String content)
public java.lang.String parseTemplate(java.lang.String template)
public java.lang.String invokeServletAndReturnAsString(java.lang.String url)
public java.lang.String getSkinFile(java.lang.String filename)
public java.lang.String getSkin()
public java.lang.String getBaseSkin()
public java.lang.String getWebCopyright()
public java.lang.String getXWikiPreference(java.lang.String prefname)
public java.lang.String getXWikiPreference(java.lang.String prefname, java.lang.String default_value)
public java.lang.String getWebPreference(java.lang.String prefname)
public java.lang.String getWebPreference(java.lang.String prefname, java.lang.String default_value)
public long getXWikiPreferenceAsLong(java.lang.String prefname, long default_value)
public long getXWikiPreferenceAsLong(java.lang.String prefname)
public long getWebPreferenceAsLong(java.lang.String prefname, long default_value)
public long getWebPreferenceAsLong(java.lang.String prefname)
public int getXWikiPreferenceAsInt(java.lang.String prefname, int default_value)
public int getXWikiPreferenceAsInt(java.lang.String prefname)
public int getWebPreferenceAsInt(java.lang.String prefname, int default_value)
public int getWebPreferenceAsInt(java.lang.String prefname)
public java.lang.String getUserPreference(java.lang.String prefname)
public java.lang.String getUserPreferenceFromCookie(java.lang.String prefname)
public java.lang.String getLanguagePreference()
public boolean isVirtual()
public boolean isMultiLingual()
public void flushCache()
public int createUser() throws XWikiException
XWikiException
public int createUser(boolean withValidation) throws XWikiException
XWikiException
public int createUser(boolean withValidation, java.lang.String userRights) throws XWikiException
XWikiException
public int createNewWiki(java.lang.String wikiName, java.lang.String wikiUrl, java.lang.String wikiAdmin, java.lang.String baseWikiName, boolean failOnExist) throws XWikiException
XWikiException
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
XWikiException
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
XWikiException
public int validateUser(boolean withConfirmEmail) throws XWikiException
XWikiException
public void sendMessage(java.lang.String sender, java.lang.String recipient, java.lang.String message) throws XWikiException
XWikiException
public void sendMessage(java.lang.String sender, java.lang.String[] recipient, java.lang.String message) throws XWikiException
XWikiException
public boolean copyDocument(java.lang.String docname, java.lang.String targetdocname) throws XWikiException
XWikiException
public boolean copyDocument(java.lang.String docname, java.lang.String targetdocname, java.lang.String wikilanguage) throws XWikiException
XWikiException
public boolean copyDocument(java.lang.String docname, java.lang.String sourceWiki, java.lang.String targetWiki, java.lang.String wikilanguage) throws XWikiException
XWikiException
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
XWikiException
public java.lang.String includeTopic(java.lang.String topic) throws XWikiException
XWikiException
public java.lang.String includeForm(java.lang.String topic) throws XWikiException
XWikiException
public java.lang.String includeTopic(java.lang.String topic, boolean pre) throws XWikiException
XWikiException
public java.lang.String includeForm(java.lang.String topic, boolean pre) throws XWikiException
XWikiException
public boolean hasAccessLevel(java.lang.String level)
public boolean hasAccessLevel(java.lang.String level, java.lang.String user, java.lang.String docname)
public java.lang.String renderText(java.lang.String text, Document doc)
public java.lang.String renderChunk(org.apache.commons.jrcs.diff.Chunk chunk, Document doc)
public java.lang.String renderChunk(org.apache.commons.jrcs.diff.Chunk chunk, boolean source, Document doc)
public java.util.List getSpaces() throws XWikiException
XWikiException
public java.util.List getSpaceDocsName(java.lang.String SpaceName) throws XWikiException
XWikiException
public java.util.Date getCurrentDate()
public java.util.Date getDate()
public int getTimeDelta(long time)
public java.util.Date getDate(long time)
public java.lang.String[] split(java.lang.String str, java.lang.String sep)
public java.lang.String printStrackTrace(java.lang.Throwable e)
public java.lang.String getEncoding()
public Object getNull()
public java.lang.String getNl()
public java.lang.String getAttachmentURL(java.lang.String fullname, java.lang.String filename) throws XWikiException
XWikiException
public java.lang.String getURL(java.lang.String fullname, java.lang.String action) throws XWikiException
XWikiException
public java.lang.String getURL(java.lang.String fullname, java.lang.String action, java.lang.String querystring) throws XWikiException
XWikiException
public java.lang.Object getService(java.lang.String className) throws XWikiException
XWikiException
public java.lang.Object getPortalService(java.lang.String className) throws XWikiException
XWikiException
public java.util.List getArrayList()
public java.util.Map getHashMap()
public void outputImage(java.awt.image.BufferedImage image) throws java.io.IOException
java.io.IOException
public DocumentStats getCurrentMonthXWikiStats(java.lang.String action)
public java.lang.String getRefererText(java.lang.String referer)
public java.lang.String getShortRefererText(java.lang.String referer, int length)
public java.lang.String getFullNameSQL()
public java.lang.String getUserName(java.lang.String user)
public java.lang.String getUserName(java.lang.String user, java.lang.String format)
public java.lang.String getLocalUserName(java.lang.String user)
public java.lang.String getLocalUserName(java.lang.String user, java.lang.String format)
public java.lang.String formatDate(java.util.Date date)
public java.lang.String formatDate(java.util.Date date, java.lang.String format)
public Api get(java.lang.String name)
name
- Name of the plugin to retrieve (either short of full class name)
public Api getPlugin(java.lang.String name)
name
- Name of the plugin to retrieve (either short of full class name)
public java.util.Collection getRecentActions(java.lang.String action, int size)
action
- ("view" or "edit")size
- how many recent actions to retrieve
public java.lang.String getAdType()
public java.lang.String getAdClientId()
public int parseInt(java.lang.String str)
str
- String to convert to int
public java.lang.Integer parseInteger(java.lang.String str)
str
- String to convert to int
public long parseLong(java.lang.String str)
str
- String to convert to long
public float parseFloat(java.lang.String str)
str
- String to convert to float
public double parseDouble(java.lang.String str)
str
- String to convert to double
public java.lang.String getURLContent(java.lang.String surl, java.lang.String username, java.lang.String password) throws java.io.IOException
surl
- url to retrieveusername
- username for the basic authenticationpassword
- password for the basic authentication
java.io.IOException
public java.lang.String getURLContent(java.lang.String surl) throws java.io.IOException
surl
- url to retrieve
java.io.IOException
public java.lang.String sqlfilter(java.lang.String text)
text
- text to filter
public java.util.List getIncludedMacros(java.lang.String defaultweb, java.lang.String content)
defaultweb
- Default Web to use for relative path namescontent
- Content to parse
public boolean isReadOnly()
#com.xpn.xwiki.XWiki
public void setReadOnly(boolean ro)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |