com.bitplan.mediawiki.japi

Interface MediawikiApi

All Known Implementing Classes:

Mediawiki, Mediawiki, MediaWikiApiImpl, SSLWiki

public interface MediawikiApi

Mediawiki API Interface see https://www.mediawiki.org/wiki/API:Main_page

Author:

wf

Method Summary

Modifier and Type	Method and Description
Edit	copyToWiki(MediawikiApi targetWiki, String pageTitle, String summary) copy the page for a given title from this wiki to the given target Wiki uses https://www.mediawiki.org/wiki/API:Edit FIXME - make this an API interface function FIXME - create a multi title version
Delete	delete(String title, String reason) delete the given page for the given reason
Edit	edit(String pagetitle, String text, String summary) Edits a page by setting its text to the supplied value.
Edit	edit(String pageTitle, String text, String summary, boolean minor, boolean bot, int sectionNumber, String sectionTitle, Calendar basetime) edit
List<Img>	getAllImagesByTimeStamp(String aistart, String aiend, int ailimit) get all Images by the given time stamps
List<P>	getAllPages(String apfrom, int aplimit) getAllPages
List<Bl>	getBacklinks(String pageTitle, String params, int limit) get the backlinks for the given pagetitle
Ii	getImageInfo(String pageTitle) get the Image Info for the given pageTitle
List<Ii>	getImageInfosForPage(String pageTitle, int limit) get the imageInfos for all images on the given page Title
List<Im>	getImagesOnPage(String pageTitle, int imLimit) get the Images on the given page
List<Iu>	getImageUsage(String imageTitle, String params, int limit) get the imageusage for the given imageTitle
String	getIsoTimeStamp() get an ISO time stamp (utility function) FIXME may have to move out of the main API
String	getPageContent(String pageTitle) get the page Content for the given page Title
String	getPageHtml(String pageTitle) get the html rendered version of a page
String	getScriptPath() get the script Path
List<S>	getSections(String pageTitle) get the sections for the given pageTitle
String	getSectionText(String pageTitle, int sectionNumber) get the content of the given section
SiteInfo	getSiteInfo() get the general siteinfo
String	getSiteurl()
String	getVersion() get the Version of this Mediawiki
void	init(String siteurl, String scriptPath) overrideable method to do pre setup stuff
boolean	isDebug() get the state of the debug mode
boolean	isLoggedIn() check whether there is a User logged In
boolean	isThrowExceptionOnError() are exceptions thrown when an api error code is received?
Login	login(String username, String password) login the given user with the given password See API:Login
void	logout() Log the current user out See API:Logout
String	normalizeTitle(String title) normalize the given page title
void	setDebug(boolean pDebug) set the debug mode
void	setProtectionMarker(String protectionMarker) set the given protectionMarker for this wiki if a page has this protectionMarker and edit will not be done
void	setScriptPath(String scriptPath) set the scriptPath of this Wiki
void	setSiteurl(String siteurl) set the siteurl
void	setThrowExceptionOnError(boolean throwExceptionOnError) set to true if exceptions should be thrown when api error codes are received default is true
void	upload(File file, String filename, String pageContent, String comment) Uploads an image.
void	upload(Ii ii, String fileName, String pageContent) upload the image described in the given imageinfo

Method Detail

getSiteurl

String getSiteurl()

Returns:

the siteurl

setSiteurl

void setSiteurl(String siteurl)
         throws Exception

set the siteurl

Parameters:

siteurl -

Throws:

Exception - - if the url is not o.k.

setScriptPath

void setScriptPath(String scriptPath)

set the scriptPath of this Wiki

Parameters:

scriptPath - - the scriptPath to set

getScriptPath

String getScriptPath()

get the script Path

Returns:

getVersion

String getVersion()
           throws Exception

get the Version of this Mediawiki

Returns:

the the version string

Throws:

Exception

getSiteInfo

SiteInfo getSiteInfo()
              throws Exception

get the general siteinfo

Returns:

the siteinfo

Throws:

Exception

getImageInfo

Ii getImageInfo(String pageTitle)
         throws Exception

get the Image Info for the given pageTitle

Parameters:

pageTitle - - the pageTitle to get the ImageInfo for

Returns:

- the Image Info

Throws:

Exception

init

void init(String siteurl,
          String scriptPath)
   throws Exception

overrideable method to do pre setup stuff

Parameters:

siteurl - - the url to use

scriptPath - - the script path to use

Throws:

Exception

login

Login login(String username,
            String password)
     throws Exception

login the given user with the given password See API:Login

Parameters:

username -

password -

Returns:

the Login information as returned by the API

Throws:

Exception

Since:

0.0.1

isLoggedIn

boolean isLoggedIn()

check whether there is a User logged In

Returns:

logout

void logout()
     throws Exception

Log the current user out See API:Logout

Throws:

Exception

Since:

0.0.1

getPageContent

String getPageContent(String pageTitle)
               throws Exception

get the page Content for the given page Title

Parameters:

pageTitle -

Returns:

the content of the page

Throws:

Exception

Since:

0.0.1

getPageHtml

String getPageHtml(String pageTitle)
            throws Exception

get the html rendered version of a page

Parameters:

pageTitle -

Returns:

the html for a page

Throws:

Exception

Since:

0.0.15

getImagesOnPage

List<Im> getImagesOnPage(String pageTitle,
                         int imLimit)
                  throws Exception

get the Images on the given page

Parameters:

pageTitle -

imLimit -

Returns:

Throws:

Exception

getSectionText

String getSectionText(String pageTitle,
                      int sectionNumber)
               throws Exception

get the content of the given section

Parameters:

pageTitle -

sectionNumber -

Returns:

the content of the section;

Throws:

Exception

delete

Delete delete(String title,
              String reason)
       throws Exception

delete the given page for the given reason

Parameters:

title -

reason -

Returns:

Throws:

Exception

Since:

0.0.1

edit

Edit edit(String pagetitle,
          String text,
          String summary)
   throws Exception

Edits a page by setting its text to the supplied value.

Parameters:

text - the text of the page

pagetitle - the title of the page

summary - the edit summary. Summaries longer than 200 characters are truncated server-side.

Returns:

the edit stage as a wrapped Edit API response

Throws:

Exception - - if the edit fails

Since:

0.0.1

See Also:

getPageContent(java.lang.String)

edit

Edit edit(String pageTitle,
          String text,
          String summary,
          boolean minor,
          boolean bot,
          int sectionNumber,
          String sectionTitle,
          Calendar basetime)
   throws Exception

edit

Parameters:

pageTitle -

text -

summary -

minor - - true if this is a minor edit

bot - whether to mark the edit as a bot edit (ignored if one does not have the necessary permissions)

sectionNumber - the section to edit. Use -1 to specify a new section and -2 to disable section editing.

sectionTitle - the title of a new section

basetime - the timestamp of the revision on which text is based, used to check for edit conflicts. null disables this.

Returns:

the edit stage as a wrapped Edit API response * @throws Exception - if the edit fails

Throws:

Exception

Since:

0.0.4

See Also:

getPageContent(java.lang.String)

upload

void upload(File file,
            String filename,
            String pageContent,
            String comment)
     throws Exception

Uploads an image. Equivalent to [[Special:Upload]].

Parameters:

file - the image file

filename - the target file name (may contain File)

pageContent - the contents of the image description page, set to "" if overwriting an existing file

comment - an upload summary (defaults to contents, use "" to not specify one)

Throws:

Exception - - if the upload fails

Since:

0.0.3

upload

void upload(Ii ii,
            String fileName,
            String pageContent)
     throws Exception

upload the image described in the given imageinfo

Parameters:

ii -

fileName -

pageContent - the contents of the image description page, set to "" if overwriting an existing file

Throws:

Exception

Since:

0.0.5

getAllPages

List<P> getAllPages(String apfrom,
                    int aplimit)
             throws Exception

getAllPages

Parameters:

apfrom - - may be null or empty

aplimit -

Returns:

Throws:

Exception

getAllImagesByTimeStamp

List<Img> getAllImagesByTimeStamp(String aistart,
                                  String aiend,
                                  int ailimit)
                           throws Exception

get all Images by the given time stamps

Parameters:

aistart - - start time stamp

aiend - - end time stamp

ailimit - - how many images to get

Throws:

Exception

getSections

List<S> getSections(String pageTitle)
             throws Exception

get the sections for the given pageTitle

Parameters:

pageTitle -

Returns:

Throws:

Exception

setProtectionMarker

void setProtectionMarker(String protectionMarker)

set the given protectionMarker for this wiki if a page has this protectionMarker and edit will not be done

Parameters:

protectionMarker -

copyToWiki

Edit copyToWiki(MediawikiApi targetWiki,
                String pageTitle,
                String summary)
         throws Exception

copy the page for a given title from this wiki to the given target Wiki uses https://www.mediawiki.org/wiki/API:Edit FIXME - make this an API interface function FIXME - create a multi title version

Parameters:

targetWiki - - the other wiki (could use a different API implementation ...)

pageTitle - - the title of the page to copy

summary - - the summary to use

Returns:

- the Edit result

Throws:

Exception

isThrowExceptionOnError

boolean isThrowExceptionOnError()

are exceptions thrown when an api error code is received?

Returns:

the throwExceptionOnError

setThrowExceptionOnError

void setThrowExceptionOnError(boolean throwExceptionOnError)

set to true if exceptions should be thrown when api error codes are received default is true

Parameters:

throwExceptionOnError - the throwExceptionOnError to set

getIsoTimeStamp

String getIsoTimeStamp()

get an ISO time stamp (utility function) FIXME may have to move out of the main API

Returns:

setDebug

void setDebug(boolean pDebug)

set the debug mode

Parameters:

pDebug -

isDebug

boolean isDebug()

get the state of the debug mode

Returns:

- true if debugging is activated

normalizeTitle

String normalizeTitle(String title)
               throws Exception

normalize the given page title

Parameters:

title - - a raw page title

Returns:

a valid page title see https://www.mediawiki.org/wiki/Manual:Page_title

Throws:

Exception

getBacklinks

List<Bl> getBacklinks(String pageTitle,
                      String params,
                      int limit)
               throws Exception

get the backlinks for the given pagetitle

Parameters:

pagetitle -

params - - extra params

Throws:

Exception

getImageUsage

List<Iu> getImageUsage(String imageTitle,
                       String params,
                       int limit)
                throws Exception

get the imageusage for the given imageTitle

Parameters:

imageTitle -

params - - extra params

Throws:

Exception

getImageInfosForPage

List<Ii> getImageInfosForPage(String pageTitle,
                              int limit)
                       throws Exception

get the imageInfos for all images on the given page Title

Parameters:

pageTitle -

Returns:

the list of ImageInfos

Throws:

Exception