info.bliki.api

Class Connector

java.lang.Object

info.bliki.api.Connector

public class Connector
extends Object

Manages the queries for the Wikimedia API. See the API Documentation. The queries set their own user-agent string. See User-Agent policy

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.http.impl.client.HttpClientBuilder	DEFAULT_HTTPCLIENT_BUILDER
protected static String	USER_AGENT

Constructor Summary

Constructors

Constructor and Description
Connector()
Connector(org.apache.http.impl.client.HttpClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
User	login(User user) Complete the users login information.
List<Page>	query(User user, Query query) Query the Mediawiki API for some wiki pages.
List<Page>	queryCategories(User user, List<String> listOfTitleStrings) List all categories the page(s) belong to.
List<Page>	queryContent(User user, List<String> listOfTitleStrings) Get the content of Mediawiki wiki pages.
List<Page>	queryImageinfo(User user, List<String> listOfImageStrings) Returns image information and upload history.
List<Page>	queryImageinfo(User user, List<String> listOfImageStrings, int imageWidth) Returns image information and upload history
List<Page>	queryInfo(User user, List<String> listOfTitleStrings) Get basic page information such as namespace, title, last touched date, ..
List<Page>	queryLinks(User user, List<String> listOfTitleStrings) Returns all links from the given page(s).
String	sendXML(User user, RequestBuilder requestBuilder)

Methods inherited from class java.lang.Object

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

Field Detail

USER_AGENT

protected static final String USER_AGENT

See Also:

Constant Field Values

DEFAULT_HTTPCLIENT_BUILDER

protected static org.apache.http.impl.client.HttpClientBuilder DEFAULT_HTTPCLIENT_BUILDER

Constructor Detail

Connector

public Connector()

Connector

public Connector(org.apache.http.impl.client.HttpClientBuilder builder)

Method Detail

login

public User login(User user)

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

Parameters:

user - a user account from a Mediawiki installation with filled out user name, password and the installations API url.

Returns:

the completed user information or null, if the login fails

queryContent

public List<Page> queryContent(User user,
                               List<String> listOfTitleStrings)

Get the content of Mediawiki wiki pages.

Parameters:

user - user login data

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

Returns:

a list of downloaded Mediawiki pages.

queryCategories

public List<Page> queryCategories(User user,
                                  List<String> listOfTitleStrings)

List all categories the page(s) belong to.

Parameters:

user - user login data

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

Returns:

page list

queryInfo

public List<Page> queryInfo(User user,
                            List<String> listOfTitleStrings)

Get basic page information such as namespace, title, last touched date, ..

Parameters:

user - user login data

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

Returns:

page list

queryLinks

public List<Page> queryLinks(User user,
                             List<String> listOfTitleStrings)

Returns all links from the given page(s).

Parameters:

user - user login data

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

Returns:

page list

queryImageinfo

public List<Page> queryImageinfo(User user,
                                 List<String> listOfImageStrings)

Returns image information and upload history. Only a URL to an unscaled image will be returned in the page data. Use queryImageinfo(User, List, int) if you need additional information about the URL of the scaled image.

Parameters:

user - user login data

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

Returns:

page list

queryImageinfo

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

Returns image information and upload history

Parameters:

user - user login data

listOfImageStrings - list of image title strings

imageWidth - a URL to an image scaled to this width will be returned. Only the current version of the image can be scaled.

Returns:

page list

query

public List<Page> query(User user,
                        Query query)

Query the Mediawiki API for some wiki pages.

Parameters:

user - user login data

query - a user defined query

Returns:

page list

sendXML

public String sendXML(User user,
                      RequestBuilder requestBuilder)