info.bliki.api
Class Connector

java.lang.Object
  extended by info.bliki.api.Connector

public class Connector
extends java.lang.Object

Manages the queries for the Wikimedia API


Field Summary
static java.lang.String PARAM_ACTION
           
static java.lang.String PARAM_FORMAT
           
static java.lang.String PARAM_LOGIN_TOKEN
           
static java.lang.String PARAM_LOGIN_USERID
           
static java.lang.String PARAM_LOGIN_USERNAME
           
static java.lang.String PARAM_PAGE
           
static java.lang.String PARAM_TITLES
           
static java.lang.String USER_AGENT
           
static java.lang.String UTF8_CHARSET
           
 
Constructor Summary
Connector()
           
 
Method Summary
 void edit(User user, Edit editQuery)
           
static java.lang.String getAsXmlString(org.apache.commons.httpclient.HttpMethod method)
          Format the response body as XML String.
 org.apache.commons.httpclient.HttpClient getClient()
          Get the HttpClient.
 org.apache.commons.httpclient.MultiThreadedHttpConnectionManager getManager()
          Get the HttpConnection manager.
 User login(User user)
          Complete the users login information.
 ParseData parse(User user, RequestBuilder requestBuilder)
           
 java.util.List<Page> query(User user, java.util.List<java.lang.String> listOfTitleStrings, java.lang.String[] valuePairs)
          Query the Mediawiki API for some wiki pages.
 java.util.List<Page> query(User user, Query query)
          Query the Mediawiki API for some wiki pages.
 java.util.List<Page> queryCategories(User user, java.util.List<java.lang.String> listOfTitleStrings)
          List all categories the page(s) belong to.
 java.util.List<Page> queryContent(User user, java.util.List<java.lang.String> listOfTitleStrings)
          Get the content of Mediawiki wiki pages.
 java.util.List<Page> queryImageinfo(User user, java.util.List<java.lang.String> listOfImageStrings)
          Returns image information and upload history.
 java.util.List<Page> queryImageinfo(User user, java.util.List<java.lang.String> listOfImageStrings, int imageWidth)
          Returns image information and upload history
 java.util.List<Page> queryInfo(User user, java.util.List<java.lang.String> listOfTitleStrings)
          Get basic page information such as namespace, title, last touched date, ..
 java.util.List<Page> queryLinks(User user, java.util.List<java.lang.String> listOfTitleStrings)
          Returns all links from the given page(s).
 java.lang.String queryXML(User user, java.util.List<java.lang.String> listOfTitleStrings, java.lang.String[] valuePairs)
          Get the raw XML result from the Mediawiki API
 java.lang.String queryXML(User user, java.lang.String[] valuePairs)
          Get the raw XML result from the Mediawiki API
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

USER_AGENT

public static final java.lang.String USER_AGENT
See Also:
Constant Field Values

UTF8_CHARSET

public static final java.lang.String UTF8_CHARSET
See Also:
Constant Field Values

PARAM_LOGIN_USERNAME

public static final java.lang.String PARAM_LOGIN_USERNAME
See Also:
Constant Field Values

PARAM_LOGIN_USERID

public static final java.lang.String PARAM_LOGIN_USERID
See Also:
Constant Field Values

PARAM_LOGIN_TOKEN

public static final java.lang.String PARAM_LOGIN_TOKEN
See Also:
Constant Field Values

PARAM_FORMAT

public static final java.lang.String PARAM_FORMAT
See Also:
Constant Field Values

PARAM_ACTION

public static final java.lang.String PARAM_ACTION
See Also:
Constant Field Values

PARAM_TITLES

public static final java.lang.String PARAM_TITLES
See Also:
Constant Field Values

PARAM_PAGE

public static final java.lang.String PARAM_PAGE
See Also:
Constant Field Values
Constructor Detail

Connector

public Connector()
Method Detail

getAsXmlString

public static java.lang.String getAsXmlString(org.apache.commons.httpclient.HttpMethod method)
                                       throws java.io.IOException
Format the response body as XML String. Especially for some obscure byte order mark cases. See Issue #33

Parameters:
method -
Returns:
Throws:
java.io.IOException

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

getClient

public org.apache.commons.httpclient.HttpClient getClient()
Get the HttpClient.

Returns:

getManager

public org.apache.commons.httpclient.MultiThreadedHttpConnectionManager getManager()
Get the HttpConnection manager.

Returns:

queryContent

public java.util.List<Page> queryContent(User user,
                                         java.util.List<java.lang.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 java.util.List<Page> queryCategories(User user,
                                            java.util.List<java.lang.String> listOfTitleStrings)
List all categories the page(s) belong to.

Parameters:
user - user login data
listOfTitleStrings - a list of title Strings "ArticleA,ArticleB,..."
Returns:

queryInfo

public java.util.List<Page> queryInfo(User user,
                                      java.util.List<java.lang.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:

queryLinks

public java.util.List<Page> queryLinks(User user,
                                       java.util.List<java.lang.String> listOfTitleStrings)
Returns all links from the given page(s).

Parameters:
user - user login data
listOfTitleStrings - a list of title Strings "ArticleA,ArticleB,..."
Returns:

queryImageinfo

public java.util.List<Page> queryImageinfo(User user,
                                           java.util.List<java.lang.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:

queryImageinfo

public java.util.List<Page> queryImageinfo(User user,
                                           java.util.List<java.lang.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:

query

public java.util.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:

query

public java.util.List<Page> query(User user,
                                  java.util.List<java.lang.String> listOfTitleStrings,
                                  java.lang.String[] valuePairs)
Query the Mediawiki API for some wiki pages.

Parameters:
user - user login data
listOfTitleStrings - a list of title Strings "ArticleA,ArticleB,..."
valuePairs - pairs of query strings which should be appended to the Mediawiki API URL
Returns:

queryXML

public java.lang.String queryXML(User user,
                                 java.lang.String[] valuePairs)
Get the raw XML result from the Mediawiki API

Parameters:
user - user login data
valuePairs - pairs of query strings which should be appended to the Mediawiki API URL
Returns:
the raw XML string produced by the query; null otherwise

queryXML

public java.lang.String queryXML(User user,
                                 java.util.List<java.lang.String> listOfTitleStrings,
                                 java.lang.String[] valuePairs)
Get the raw XML result from the Mediawiki API

Parameters:
user - user login data
listOfTitleStrings - a list of possibly empty title Strings "ArticleA,ArticleB,..."
valuePairs - pairs of query strings which should be appended to the Mediawiki API URL
Returns:
the raw XML string produced by the query; null otherwise

parse

public ParseData parse(User user,
                       RequestBuilder requestBuilder)

edit

public void edit(User user,
                 Edit editQuery)
          throws UnexpectedAnswerException
Throws:
UnexpectedAnswerException


Copyright © 2012 Java Wikipedia API (Bliki engine). All Rights Reserved.