net.sourceforge.jwbf.mediawiki.actions.editing

Class GetApiToken

java.lang.Object

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

net.sourceforge.jwbf.mediawiki.actions.editing.GetApiToken

All Implemented Interfaces:

ContentProcessable, ReturningText

public final class GetApiToken
extends MWAction

Action class using the MediaWiki-Editing-API.
Its job is to get the token for some actions like delete or edit.

Author:

Max Gensthaler, Thomas Stock

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetApiToken.Intoken Types that need a token.

Constructor Summary

Constructors

Constructor and Description
GetApiToken(GetApiToken.Intoken intoken, String title, MediaWiki.Version v, Userinfo ui) Constructs a new GetToken action.

Method Summary

Methods

Modifier and Type	Method and Description
HttpAction	getNextMessage()
protected String	getToken() Returns the requested token after parsing the result from MediaWiki.
boolean	hasMoreMessages()
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, 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

GetApiToken

public GetApiToken(GetApiToken.Intoken intoken,
           String title,
           MediaWiki.Version v,
           Userinfo ui)

Constructs a new GetToken action.

Parameters:

intoken - type to get the token for

title - title of the article to generate the token for

ui - user info object if this action is not supported of the MediaWiki version connected to

Method Detail

getToken

protected String getToken()

Returns the requested token after parsing the result from MediaWiki.

Returns:

the requested token

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

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