Package | Description |
---|---|
dw.cli | |
dw.cli.commands | |
dw.xmlrpc | |
dw.xmlrpc.exception |
Modifier and Type | Method and Description |
---|---|
protected abstract Output |
Command.run(DokuJClient dokuClient) |
static Output |
Program.run(String[] args) |
Modifier and Type | Method and Description |
---|---|
protected List<MediaChange> |
RecentMediaChangesGetter.query(DokuJClient dokuClient) |
protected String |
TimeGetter.query(DokuJClient dokuClient) |
protected List<PageChange> |
RecentChangesGetter.query(DokuJClient dokuClient) |
protected List<Page> |
AllPageGetter.query(DokuJClient dokuClient) |
protected String |
VersionGetter.query(DokuJClient dokuClient) |
protected List<AttachmentDetails> |
AttachmentReader.query(DokuJClient dokuClient) |
protected String |
RPCVersionSupportedGetter.query(DokuJClient dokuClient) |
protected List<PageVersion> |
PageVersionsGetter.query(DokuJClient dokuClient) |
protected String |
TitleGetter.query(DokuJClient dokuClient) |
protected List<LinkInfo> |
LinksLister.query(DokuJClient dokuClient) |
protected List<SearchResult> |
Searcher.query(DokuJClient dokuClient) |
protected List<String> |
BackLinksGetter.query(DokuJClient dokuClient) |
protected List<PageDW> |
PageListGetter.query(DokuJClient dokuClient) |
protected abstract List<T> |
ItemListToStringCommand.query(DokuJClient dokuClient) |
protected String |
CliVersion.query(DokuJClient dokuClient) |
protected String |
XMLRPCAPIVersionGetter.query(DokuJClient dokuClient) |
protected abstract String |
SimpleCommand.query(DokuJClient dokuClient) |
protected Output |
HelpPrinter.run(DokuJClient dokuClient) |
protected Output |
AttachmentInfoGetter.run(DokuJClient dokuClient) |
protected Output |
PageGetter.run(DokuJClient dokuClient) |
protected Output |
AclChecker.run(DokuJClient dokuClient) |
protected Output |
PageInfoGetter.run(DokuJClient dokuClient) |
protected Output |
AttachmentGetter.run(DokuJClient dokuClient) |
protected Output |
AttachmentDeleter.run(DokuJClient dokuClient) |
protected Output |
AclChanger.run(DokuJClient dokuClient) |
protected Output |
PageVersionGetter.run(DokuJClient dokuClient) |
protected Output |
LocksSetter.run(DokuJClient dokuClient) |
protected Output |
ItemListToStringCommand.run(DokuJClient dokuClient) |
protected Output |
PageHtmlGetter.run(DokuJClient dokuClient) |
protected Output |
AttachmentPutter.run(DokuJClient dokuClient) |
protected Output |
PagePutter.run(DokuJClient dokuClient) |
protected Output |
SimpleCommand.run(DokuJClient dokuClient) |
Modifier and Type | Method and Description |
---|---|
Integer |
DokuJClient.aclCheck(String pageId)
Returns the permission of the given wikipage.
|
boolean |
DokuJClient.addAcl(String scope,
String username,
int permission)
Only available for dokuwiki-2013-12-08 (Binky) or newer
|
void |
DokuJClient.appendPage(String pageId,
String rawWikiText)
Appends text to a Wiki Page.
|
void |
DokuJClient.appendPage(String pageId,
String rawWikiText,
Map<String,Object> options)
Appends text to a Wiki Page.
|
void |
DokuJClient.appendPage(String pageId,
String rawWikiText,
String summary,
boolean minor)
Appends text to a Wiki Page.
|
boolean |
DokuJClient.delAcl(String scope,
String username)
Only available for dokuwiki-2013-12-08 (Binky) or newer
|
void |
DokuJClient.deleteAttachment(String fileId)
Deletes a file.
|
Object |
DokuJClient.genericQuery(String action)
Let execute any xmlrpc query without argument
|
Object |
DokuJClient.genericQuery(String action,
Object param)
Let execute any xmlrpc query with one argument
|
Object |
DokuJClient.genericQuery(String action,
Object[] params)
Let execute any xmlrpc query with an arbitrary number of arguments
|
List<Page> |
DokuJClient.getAllPages()
Returns a list of all Wiki pages in the remote Wiki
|
byte[] |
DokuJClient.getAttachment(String fileId)
Let download a file from the wiki
|
File |
DokuJClient.getAttachment(String fileId,
String localPath)
Let download a file from the wiki
|
AttachmentInfo |
DokuJClient.getAttachmentInfo(String fileId)
Returns information about a media file
|
List<AttachmentDetails> |
DokuJClient.getAttachments(String namespace)
Returns information about a list of media files in a given namespace
|
List<AttachmentDetails> |
DokuJClient.getAttachments(String namespace,
Map<String,Object> additionalParams)
Returns information about a list of media files in a given namespace
|
List<String> |
DokuJClient.getBackLinks(String pageId)
Returns a list of backlinks of a Wiki page
|
String |
DokuJClient.getPage(String pageId)
Returns the raw Wiki text for a page
|
String |
DokuJClient.getPageHTML(String pageId)
Returns the rendered XHTML body of a Wiki page
|
String |
DokuJClient.getPageHTMLVersion(String pageId,
Integer timestamp)
Returns the rendered HTML of a specific version of a Wiki page
|
PageInfo |
DokuJClient.getPageInfo(String pageId)
Returns information about a Wiki page
|
PageInfo |
DokuJClient.getPageInfoVersion(String pageId,
Integer timestamp)
Returns information about a specific version of a Wiki page
|
List<PageDW> |
DokuJClient.getPagelist(String namespace)
Lists all pages within a given namespace
|
List<PageDW> |
DokuJClient.getPagelist(String namespace,
Map<String,Object> options)
Lists all pages within a given namespace
|
String |
DokuJClient.getPageVersion(String pageId,
Integer timestamp)
Returns the raw Wiki text for a specific revision of a Wiki page.
|
List<PageVersion> |
DokuJClient.getPageVersions(String pageId)
Returns the available versions of a Wiki page.
|
List<PageVersion> |
DokuJClient.getPageVersions(String pageId,
Integer offset)
Returns the available versions of a Wiki page.
|
List<PageChange> |
DokuJClient.getRecentChanges(Date date)
Wrapper around
DokuJClient.getRecentChanges(Integer) |
List<PageChange> |
DokuJClient.getRecentChanges(Integer timestamp)
Returns a list of recent changes since a given timestamp
According to Dokuwiki documentation (https://www.dokuwiki.org/recent_changes):
* Only the most recent change for each page is listed, regardless of how many times that page was changed.
|
List<MediaChange> |
DokuJClient.getRecentMediaChanges(Date date)
Wrapper around
DokuJClient.getRecentMediaChanges(Integer) |
List<MediaChange> |
DokuJClient.getRecentMediaChanges(Integer timestamp)
Returns a list of recent changed media since given timestamp
|
Integer |
DokuJClient.getRPCVersionSupported()
Returns the supported RPC API version
cf http://www.jspwiki.org/wiki/WikiRPCInterface2 for more info
|
Integer |
DokuJClient.getTime()
Returns the current time at the remote wiki server as Unix timestamp
|
String |
DokuJClient.getTitle()
Returns the title of the wiki
|
String |
DokuJClient.getVersion()
Returns the DokuWiki version of the remote Wiki
|
Integer |
DokuJClient.getXMLRPCAPIVersion()
Returns the XML RPC interface version of the remote Wiki.
|
List<LinkInfo> |
DokuJClient.listLinks(String pageId)
Returns a list of all links contained in a Wiki page
|
boolean |
DokuJClient.lock(String pageId)
Lock a page
|
Boolean |
DokuJClient.login(String user,
String password) |
void |
DokuJClient.logoff()
Tries to logoff by expiring auth cookies and the associated PHP session
|
void |
DokuJClient.putAttachment(String attachmentId,
byte[] localFile,
boolean overwrite)
Uploads a file to the wiki
|
void |
DokuJClient.putAttachment(String attachmentId,
File localFile,
boolean overwrite)
Uploads a file to the wiki
|
void |
DokuJClient.putAttachment(String attachmentId,
String localPath,
boolean overwrite)
Uploads a file to the wiki
|
void |
DokuJClient.putPage(String pageId,
String rawWikiText)
Saves a Wiki Page
|
void |
DokuJClient.putPage(String pageId,
String rawWikiText,
Map<String,Object> options)
Saves a Wiki Page
|
void |
DokuJClient.putPage(String pageId,
String rawWikiText,
String summary,
boolean minor)
Saves a Wiki Page
|
List<SearchResult> |
DokuJClient.search(String pattern)
Performs a fulltext search
|
LockResult |
DokuJClient.setLocks(List<String> pagesToLock,
List<String> pagesToUnlock)
Allows to lock or unlock a whole bunch of pages at once.
|
boolean |
DokuJClient.unlock(String pageId)
Unlock a page
|
Constructor and Description |
---|
DokuJClient(DokuJClientConfig dokuConfig) |
DokuJClient(String url,
String user,
String password)
Instantiate a client for the given user on the given wiki
The wiki should be configured in a way to let this user access the
xmlrpc interface
|
Modifier and Type | Class and Description |
---|---|
class |
DokuAttachmentStillReferenced
Thrown when one tries to delete a distant media still referenced.
|
class |
DokuAttachmentUploadException |
class |
DokuBadUrlException
Thrown when a bad url has been provided
|
class |
DokuDeleteAttachmentException
Thrown when an attempt to delete a file on the wiki failed
|
class |
DokuDistantFileDoesntExistException
Thrown when one attemps to work on a file which doesn't exist on the wiki
|
class |
DokuEmptyNewPageException
Thrown by Dokuwiki when one try to use putPage with an empty page content
if the page doesn't exist yet (or has alreay been deleted)
|
class |
DokuIncompatibleVersionException |
class |
DokuInvalidTimeStampException
Thrown when an invalid timestamp is provided
|
class |
DokuMethodDoesNotExistsException |
class |
DokuMisConfiguredWikiException |
class |
DokuNoChangesException
Thrown when one looked out for changes when there are none
|
class |
DokuPageDoesNotExistException |
class |
DokuPageLockedException
Thrown when one tries to edit a page locked by someone else
|
class |
DokuTimeoutException
Thrown when a call timeout
|
class |
DokuUnauthorizedException
Thrown when a user attempts to make a query he isn't allowed to.
|
class |
DokuUnknownException
Thrown when an xmlrpc query failed for an unknown reason.
|
class |
DokuWordblockException
Thrown if a page can't be edited because of a wordblock.
|
Copyright © 2016. All rights reserved.