net.sourceforge.jwbf.mediawiki.actions.editing

Class PostDelete

java.lang.Object

net.sourceforge.jwbf.mediawiki.actions.util.MWAction

net.sourceforge.jwbf.mediawiki.actions.editing.PostDelete

All Implemented Interfaces:

ContentProcessable, ReturningText

public class PostDelete
extends MWAction

Action class using the MediaWiki-API's "action=delete".

To allow your bot to delete articles in your MediaWiki add the following line to your MediaWiki's LocalSettings.php:

 $wgEnableWriteAPI = true;
 $wgGroupPermissions['bot']['delete'] = true;
 

Delete an article with

 String name = ...
 MediaWikiBot bot = ...
 Siteinfo si = bot.getSiteinfo();
 Userinfo ui = bot.getUserinfo();
 bot.performAction(new PostDelete(name, si, ui));
 

Author:

Max Gensthaler

Constructor Summary

Constructors

Constructor and Description
PostDelete(MediaWikiBot bot, String title) Constructs a new PostDelete action.
PostDelete(MediaWikiBot bot, String title, String reason) Constructs a new PostDelete action.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.jdom.Element	getErrorElement(org.jdom.Element rootElement) Determines if the given XML Document contains an error message which then would printed by the logger.
HttpAction	getNextMessage()
String	processReturningText(String s, HttpAction hm) Deals with the MediaWiki API's response by parsing the provided text.

Methods inherited from class net.sourceforge.jwbf.mediawiki.actions.util.MWAction

createNsString, evaluateXpath, getRootElement, getRootElementWithError, hasMoreMessages, isSelfExecuter, processAllReturningText, setExceptionHandler, setHasMoreMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

PostDelete

public PostDelete(MediaWikiBot bot,
          String title)

Constructs a new PostDelete action.

PostDelete

public PostDelete(MediaWikiBot bot,
          String title,
          String reason)

Constructs a new PostDelete action.

Parameters:

bot - MediaWikiBot

title - the title of the page to delete

reason - reason for the deletion (may be null) in case of a precessing exception in case of an action exception

Method Detail

processReturningText

public String processReturningText(String s,
                          HttpAction hm)

Deals with the MediaWiki API's response by parsing the provided text.

Specified by:

processReturningText in interface ReturningText

Overrides:

processReturningText in class MWAction

Parameters:

s - the answer to the most recently generated MediaWiki API request

hm - the requestor message

Returns:

the returning text on processing problems

getErrorElement

protected org.jdom.Element getErrorElement(org.jdom.Element rootElement)

Determines if the given XML Document contains an error message which then would printed by the logger.

Overrides:

getErrorElement in class MWAction

Parameters:

rootElement - XML Document

Returns:

error element

getNextMessage

public HttpAction getNextMessage()

Returns:

the of messages in this action