net.sourceforge.jwbf.mediawiki.actions.editing

Class FileUpload

java.lang.Object

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

net.sourceforge.jwbf.mediawiki.actions.editing.FileUpload

All Implemented Interfaces:

ContentProcessable, ReturningText

public class FileUpload
extends MWAction

To allow your bot to upload media in your MediaWiki. Add at least the following line to your MediaWiki's LocalSettings.php:

 $wgEnableUploads = true;
 

For more details see also Upload Config

Author:

Justus Bisser, Thomas Stock

Constructor Summary

Constructors

Constructor and Description
FileUpload(MediaWikiBot bot, String filename)
FileUpload(SimpleFile simpleFile, MediaWikiBot bot)

Method Summary

Methods

Modifier and Type	Method and Description
HttpAction	getNextMessage()
boolean	hasMoreMessages()
String	processReturningText(String xml, 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, getErrorElement, getRootElement, getRootElementWithError, isSelfExecuter, processAllReturningText, setExceptionHandler, setHasMoreMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUpload

public FileUpload(SimpleFile simpleFile,
          MediaWikiBot bot)

FileUpload

public FileUpload(MediaWikiBot bot,
          String filename)

Method Detail

getNextMessage

public HttpAction getNextMessage()

Returns:

the of messages in this action

hasMoreMessages

public boolean hasMoreMessages()

Specified by:

hasMoreMessages in interface ContentProcessable

Overrides:

hasMoreMessages in class MWAction

Returns:

true if and changes state to false

processReturningText

public String processReturningText(String xml,
                          HttpAction hm)

Description copied from class: MWAction

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

Specified by:

processReturningText in interface ReturningText

Overrides:

processReturningText in class MWAction

Parameters:

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

hm - the requestor message

Returns:

the returning text on processing problems