com.bitplan.mediawiki.japi

Class MediaWikiApiImpl

java.lang.Object

com.bitplan.mediawiki.japi.MediaWikiApiImpl

All Implemented Interfaces:

MediawikiApi

Direct Known Subclasses:

Mediawiki, Mediawiki

public abstract class MediaWikiApiImpl
extends Object
implements MediawikiApi

common implementation parts

Author:

wf

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER Logging may be enabled by setting debug to true
protected String	protectionMarker protection Marker - if this shows in page edits are suppressed and logged with a warning
protected boolean	throwExceptionOnError set to true if exceptions should be thrown on Error

Constructor Summary

Constructors

Constructor and Description
MediaWikiApiImpl()

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
protected String	decode(String html) decode the given html markup
protected String	encode(String param) request parameter encoding
Api	fromXML(String xml) return Api from the given xml
String	getProtectionMarker()
abstract SiteInfo	getSiteInfo() get the general siteinfo
String	getVersion() get the Version of this wiki
protected void	handleError(Api api)
protected void	handleError(Error error) handle the given api error
protected void	handleError(String errMsg) handle the given error Message according to the exception setting
boolean	isThrowExceptionOnError() are exceptions thrown when an api error code is received?
String	normalizeTitle(String title) normalize the given page title
void	setProtectionMarker(String protectionMarker) set the given protectionMarker for this wiki if a page has this protectionMarker and edit will not be done
void	setThrowExceptionOnError(boolean throwExceptionOnError) set to true if exceptions should be thrown when api error codes are received default is true
void	setVersion(String version) set the version via API

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

delete, edit, edit, getAllImagesByTimeStamp, getAllPages, getBacklinks, getImageInfo, getImageInfosForPage, getImagesOnPage, getImageUsage, getIsoTimeStamp, getPageContent, getPageHtml, getScriptPath, getSections, getSectionText, getSiteurl, init, isDebug, isLoggedIn, login, logout, setDebug, setScriptPath, setSiteurl, upload, upload

Field Detail

LOGGER

protected static Logger LOGGER

Logging may be enabled by setting debug to true

throwExceptionOnError

protected boolean throwExceptionOnError

set to true if exceptions should be thrown on Error

protectionMarker

protected String protectionMarker

protection Marker - if this shows in page edits are suppressed and logged with a warning

Constructor Detail

MediaWikiApiImpl

public MediaWikiApiImpl()

Method Detail

isThrowExceptionOnError

public boolean isThrowExceptionOnError()

Description copied from interface: MediawikiApi

are exceptions thrown when an api error code is received?

Specified by:

isThrowExceptionOnError in interface MediawikiApi

Returns:

the throwExceptionOnError

setThrowExceptionOnError

public void setThrowExceptionOnError(boolean throwExceptionOnError)

Description copied from interface: MediawikiApi

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

Specified by:

setThrowExceptionOnError in interface MediawikiApi

Parameters:

throwExceptionOnError - the throwExceptionOnError to set

getProtectionMarker

public String getProtectionMarker()

Returns:

the protectionMarker

setProtectionMarker

public void setProtectionMarker(String protectionMarker)

Description copied from interface: MediawikiApi

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

Specified by:

setProtectionMarker in interface MediawikiApi

Parameters:

protectionMarker - the protectionMarker to set

handleError

protected void handleError(String errMsg)
                    throws Exception

handle the given error Message according to the exception setting

Parameters:

errMsg -

Throws:

Exception

handleError

protected void handleError(Error error)
                    throws Exception

handle the given api error

Parameters:

error -

Throws:

Exception

handleError

protected void handleError(Api api)
                    throws Exception

Parameters:

api -

Throws:

Exception

fromXML

public Api fromXML(String xml)
            throws Exception

return Api from the given xml

Parameters:

xml - - the xml go unmarshal

Returns:

Throws:

Exception

getSiteInfo

public abstract SiteInfo getSiteInfo()
                              throws Exception

Description copied from interface: MediawikiApi

get the general siteinfo

Specified by:

getSiteInfo in interface MediawikiApi

Returns:

the siteinfo

Throws:

Exception

copyToWiki

public 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

Specified by:

copyToWiki in interface MediawikiApi

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

getVersion

public String getVersion()
                  throws Exception

get the Version of this wiki

Specified by:

getVersion in interface MediawikiApi

Returns:

the the version string

Throws:

Exception

setVersion

public void setVersion(String version)

set the version via API

Parameters:

version -

encode

protected String encode(String param)
                 throws Exception

request parameter encoding

Parameters:

param -

Returns:

an encoded url parameter

Throws:

Exception

decode

protected String decode(String html)
                 throws Exception

decode the given html markup

Parameters:

html -

Returns:

decoded html

Throws:

Exception

normalizeTitle

public String normalizeTitle(String title)
                      throws Exception

normalize the given page title

Specified by:

normalizeTitle in interface MediawikiApi

Parameters:

title -

Returns:

the normalized title e.g. replacing blanks FIXME encode is not good enough

Throws:

Exception