org.wikipedia

Class Mediawiki

java.lang.Object

com.bitplan.mediawiki.japi.MediaWikiApiImpl

org.wikipedia.Mediawiki

All Implemented Interfaces:

MediawikiApi

public class Mediawiki
extends MediaWikiApiImpl
implements MediawikiApi

Mediawiki-Japi compatible Wrapper for Wiki.java

Author:

wf

Field Summary

Fields inherited from class com.bitplan.mediawiki.japi.MediaWikiApiImpl

LOGGER, protectionMarker, throwExceptionOnError

Constructor Summary

Constructors

Constructor and Description
Mediawiki()

Method Summary

Modifier and Type	Method and Description
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
General	getGeneral() get the siteinfo
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 wiki
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
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
void	setDebug(boolean pDebug) set the debug mode
void	setScriptPath(String scriptPath) set the scriptPath of this Wiki
void	setSiteurl(String siteurl) set the siteurl
void	upload(File file, String filename, String contents, String reason) Uploads an image.
void	upload(Ii ii, String fileName, String pageContent) upload the image described in the given imageinfo

Methods inherited from class com.bitplan.mediawiki.japi.MediaWikiApiImpl

copyToWiki, decode, encode, fromXML, getProtectionMarker, handleError, handleError, handleError, isThrowExceptionOnError, normalizeTitle, setProtectionMarker, setThrowExceptionOnError, setVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.bitplan.mediawiki.japi.MediawikiApi

copyToWiki, isThrowExceptionOnError, normalizeTitle, setProtectionMarker, setThrowExceptionOnError

Constructor Detail

Mediawiki

public Mediawiki()

Method Detail

getSiteurl

public String getSiteurl()

Specified by:

getSiteurl in interface MediawikiApi

Returns:

the siteurl

setSiteurl

public void setSiteurl(String siteurl)
                throws Exception

Description copied from interface: MediawikiApi

set the siteurl

Specified by:

setSiteurl in interface MediawikiApi

Throws:

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

getScriptPath

public String getScriptPath()

Description copied from interface: MediawikiApi

get the script Path

Specified by:

getScriptPath in interface MediawikiApi

Returns:

the scriptPath

setScriptPath

public void setScriptPath(String scriptPath)

Description copied from interface: MediawikiApi

set the scriptPath of this Wiki

Specified by:

setScriptPath in interface MediawikiApi

Parameters:

scriptPath - the scriptPath to set

init

public void init(String siteurl,
                 String scriptPath)
          throws Exception

Description copied from interface: MediawikiApi

overrideable method to do pre setup stuff

Specified by:

init in interface MediawikiApi

Parameters:

siteurl - - the url to use

scriptPath - - the script path to use

Throws:

Exception

getVersion

public String getVersion()
                  throws Exception

Description copied from class: MediaWikiApiImpl

get the Version of this wiki

Specified by:

getVersion in interface MediawikiApi

Overrides:

getVersion in class MediaWikiApiImpl

Returns:

the the version string

Throws:

Exception

getGeneral

public General getGeneral()
                   throws Exception

get the siteinfo

Returns:

Throws:

Exception

login

public Login login(String username,
                   String password)
            throws Exception

Description copied from interface: MediawikiApi

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

Specified by:

login in interface MediawikiApi

Returns:

the Login information as returned by the API

Throws:

Exception

isLoggedIn

public boolean isLoggedIn()

Description copied from interface: MediawikiApi

check whether there is a User logged In

Specified by:

isLoggedIn in interface MediawikiApi

Returns:

getPageContent

public String getPageContent(String pageTitle)
                      throws Exception

Description copied from interface: MediawikiApi

get the page Content for the given page Title

Specified by:

getPageContent in interface MediawikiApi

Returns:

the content of the page

Throws:

Exception

getPageHtml

public String getPageHtml(String pageTitle)
                   throws Exception

Description copied from interface: MediawikiApi

get the html rendered version of a page

Specified by:

getPageHtml in interface MediawikiApi

Returns:

the html for a page

Throws:

Exception

getSectionText

public String getSectionText(String pageTitle,
                             int sectionNumber)
                      throws Exception

Description copied from interface: MediawikiApi

get the content of the given section

Specified by:

getSectionText in interface MediawikiApi

Returns:

the content of the section;

Throws:

Exception

logout

public void logout()
            throws Exception

Description copied from interface: MediawikiApi

Log the current user out See API:Logout

Specified by:

logout in interface MediawikiApi

Throws:

Exception

edit

public Edit edit(String pageTitle,
                 String text,
                 String summary)
          throws Exception

Description copied from interface: MediawikiApi

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

Specified by:

edit in interface MediawikiApi

Parameters:

pageTitle - the title of the page

text - the text 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

See Also:

MediawikiApi.getPageContent(java.lang.String)

edit

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

Description copied from interface: MediawikiApi

edit

Specified by:

edit in interface MediawikiApi

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

See Also:

MediawikiApi.getPageContent(java.lang.String)

getIsoTimeStamp

public String getIsoTimeStamp()

Description copied from interface: MediawikiApi

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

Specified by:

getIsoTimeStamp in interface MediawikiApi

Returns:

setDebug

public void setDebug(boolean pDebug)

Description copied from interface: MediawikiApi

set the debug mode

Specified by:

setDebug in interface MediawikiApi

isDebug

public boolean isDebug()

Description copied from interface: MediawikiApi

get the state of the debug mode

Specified by:

isDebug in interface MediawikiApi

Returns:

- true if debugging is activated

upload

public void upload(File file,
                   String filename,
                   String contents,
                   String reason)
            throws Exception

Description copied from interface: MediawikiApi

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

Specified by:

upload in interface MediawikiApi

Parameters:

file - the image file

filename - the target file name (may contain File)

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

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

Throws:

Exception - - if the upload fails

getAllPages

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

Description copied from interface: MediawikiApi

getAllPages

Specified by:

getAllPages in interface MediawikiApi

Parameters:

apfrom - - may be null or empty

Returns:

Throws:

Exception

getSections

public List<S> getSections(String pageTitle)
                    throws Exception

Description copied from interface: MediawikiApi

get the sections for the given pageTitle

Specified by:

getSections in interface MediawikiApi

Returns:

Throws:

Exception

getImageInfo

public Ii getImageInfo(String pageTitle)
                throws Exception

Description copied from interface: MediawikiApi

get the Image Info for the given pageTitle

Specified by:

getImageInfo in interface MediawikiApi

Parameters:

pageTitle - - the pageTitle to get the ImageInfo for

Returns:

- the Image Info

Throws:

Exception

upload

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

Description copied from interface: MediawikiApi

upload the image described in the given imageinfo

Specified by:

upload in interface MediawikiApi

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

Throws:

Exception

getSiteInfo

public SiteInfo getSiteInfo()
                     throws Exception

Description copied from interface: MediawikiApi

get the general siteinfo

Specified by:

getSiteInfo in interface MediawikiApi

Specified by:

getSiteInfo in class MediaWikiApiImpl

Returns:

the siteinfo

Throws:

Exception

delete

public Delete delete(String title,
                     String reason)
              throws Exception

Description copied from interface: MediawikiApi

delete the given page for the given reason

Specified by:

delete in interface MediawikiApi

Returns:

Throws:

Exception

getAllImagesByTimeStamp

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

Description copied from interface: MediawikiApi

get all Images by the given time stamps

Specified by:

getAllImagesByTimeStamp in interface MediawikiApi

Parameters:

aistart - - start time stamp

aiend - - end time stamp

ailimit - - how many images to get

getBacklinks

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

Description copied from interface: MediawikiApi

get the backlinks for the given pagetitle

Specified by:

getBacklinks in interface MediawikiApi

params - - extra params

Throws:

Exception

getImageUsage

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

Description copied from interface: MediawikiApi

get the imageusage for the given imageTitle

Specified by:

getImageUsage in interface MediawikiApi

params - - extra params

Throws:

Exception

getImagesOnPage

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

Description copied from interface: MediawikiApi

get the Images on the given page

Specified by:

getImagesOnPage in interface MediawikiApi

Returns:

Throws:

Exception

getImageInfosForPage

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

Description copied from interface: MediawikiApi

get the imageInfos for all images on the given page Title

Specified by:

getImageInfosForPage in interface MediawikiApi

Returns:

the list of ImageInfos

Throws:

Exception