info.bliki.api

Class User

java.lang.Object

info.bliki.api.User

public class User
extends Object

Manages user data from the Wikimedia API. See also Mediawiki API:Login

Field Summary

Fields

Modifier and Type	Field and Description
protected Connector	connector
protected static String	NEED_TOKEN_ID
protected static String	SUCCESS_ID

Constructor Summary

Constructors

Constructor and Description
User(String name, String password, String mediawikiApiUrl) Create a User for a Mediawiki wiki
User(String name, String password, String mediawikiApiUrl, String domain) Create a User for a Mediawiki wiki

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getActionUrl() Get the Mediawiki API Url defined for this user(example: https://meta.wikimedia.org/w/api.php)
String	getDomain()
String	getNormalizedUsername()
String	getPassword()
String	getResult()
String	getToken()
String	getUserid()
String	getUsername()
int	hashCode()
boolean	isAuthenticated()
boolean	login() Complete the users login information.
List<Page>	queryCategories(List<String> listOfTitleStrings)
List<Page>	queryCategories(String... listOfTitleStrings)
List<Page>	queryContent(List<String> listOfTitleStrings) Get the content of Mediawiki wiki pages.
List<Page>	queryContent(String... listOfTitleStrings) Get the content of Mediawiki wiki pages.
List<Page>	queryImageinfo(List<String> listOfImageStrings)
List<Page>	queryImageinfo(List<String> listOfImageStrings, int imageWidth)
List<Page>	queryImageinfo(String... listOfImageStrings)
List<Page>	queryImageinfo(String[] listOfImageStrings, int imageWidth)
List<Page>	queryInfo(List<String> listOfTitleStrings)
List<Page>	queryInfo(String... listOfTitleStrings)
List<Page>	queryLinks(List<String> listOfTitleStrings)
List<Page>	queryLinks(String... listOfTitleStrings)
protected void	setNormalizedUsername(String normalizedUsername)
protected void	setResult(String result)
protected void	setToken(String token)
protected void	setUserid(String userid)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SUCCESS_ID

protected static final String SUCCESS_ID

See Also:

Constant Field Values

NEED_TOKEN_ID

protected static final String NEED_TOKEN_ID

See Also:

Constant Field Values

connector

protected Connector connector

Constructor Detail

User

public User(String name,
            String password,
            String mediawikiApiUrl)

Create a User for a Mediawiki wiki

Parameters:

name - User Name

password - Password

mediawikiApiUrl - A mediawiki API Url (example: https://meta.wikimedia.org/w/api.php

User

public User(String name,
            String password,
            String mediawikiApiUrl,
            String domain)

Create a User for a Mediawiki wiki

Parameters:

name - User Name

password - Password

mediawikiApiUrl - A mediawiki API Url (example: https://meta.wikimedia.org/w/api.php

domain - Domain (optional)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

login

public boolean login()

Complete the users login information. The user must contain a username, password and actionURL. See Mediawiki API:Login

Returns:

true if th login was successful; false otherwise.

See Also:

getActionUrl()

queryContent

public List<Page> queryContent(List<String> listOfTitleStrings)

Get the content of Mediawiki wiki pages.

Parameters:

listOfTitleStrings - a list of title Strings "ArticleA,ArticleB,..."

Returns:

a list of downloaded Mediawiki pages.

queryContent

public List<Page> queryContent(String... listOfTitleStrings)

Get the content of Mediawiki wiki pages.

Parameters:

listOfTitleStrings - a list of title Strings "ArticleA,ArticleB,..."

Returns:

a list of downloaded Mediawiki pages.

queryCategories

public List<Page> queryCategories(List<String> listOfTitleStrings)

queryCategories

public List<Page> queryCategories(String... listOfTitleStrings)

queryInfo

public List<Page> queryInfo(List<String> listOfTitleStrings)

queryInfo

public List<Page> queryInfo(String... listOfTitleStrings)

queryLinks

public List<Page> queryLinks(List<String> listOfTitleStrings)

queryLinks

public List<Page> queryLinks(String... listOfTitleStrings)

queryImageinfo

public List<Page> queryImageinfo(List<String> listOfImageStrings)

queryImageinfo

public List<Page> queryImageinfo(List<String> listOfImageStrings,
                                 int imageWidth)

queryImageinfo

public List<Page> queryImageinfo(String... listOfImageStrings)

queryImageinfo

public List<Page> queryImageinfo(String[] listOfImageStrings,
                                 int imageWidth)

getResult

public String getResult()

setResult

protected void setResult(String result)

getToken

public String getToken()

setToken

protected void setToken(String token)

getUserid

public String getUserid()

setUserid

protected void setUserid(String userid)

getUsername

public String getUsername()

getActionUrl

public String getActionUrl()

Get the Mediawiki API Url defined for this user(example: https://meta.wikimedia.org/w/api.php)

getDomain

public String getDomain()

getPassword

public String getPassword()

isAuthenticated

public boolean isAuthenticated()

toString

public String toString()

Overrides:

toString in class Object

getNormalizedUsername

public String getNormalizedUsername()

setNormalizedUsername

protected void setNormalizedUsername(String normalizedUsername)