|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectinfo.bliki.api.Connector
public class Connector
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 |
---|
public static final java.lang.String USER_AGENT
public static final java.lang.String UTF8_CHARSET
public static final java.lang.String PARAM_LOGIN_USERNAME
public static final java.lang.String PARAM_LOGIN_USERID
public static final java.lang.String PARAM_LOGIN_TOKEN
public static final java.lang.String PARAM_FORMAT
public static final java.lang.String PARAM_ACTION
public static final java.lang.String PARAM_TITLES
public static final java.lang.String PARAM_PAGE
Constructor Detail |
---|
public Connector()
Method Detail |
---|
public static java.lang.String getAsXmlString(org.apache.commons.httpclient.HttpMethod method) throws java.io.IOException
method
-
java.io.IOException
public User login(User user)
user
- a user account from a Mediawiki installation with filled out user
name, password and the installations API url.
null
, if the login
failspublic org.apache.commons.httpclient.HttpClient getClient()
public org.apache.commons.httpclient.MultiThreadedHttpConnectionManager getManager()
public java.util.List<Page> queryContent(User user, java.util.List<java.lang.String> listOfTitleStrings)
user
- user login datalistOfTitleStrings
- a list of title Strings "ArticleA,ArticleB,..."
public java.util.List<Page> queryCategories(User user, java.util.List<java.lang.String> listOfTitleStrings)
user
- user login datalistOfTitleStrings
- a list of title Strings "ArticleA,ArticleB,..."
public java.util.List<Page> queryInfo(User user, java.util.List<java.lang.String> listOfTitleStrings)
user
- user login datalistOfTitleStrings
- a list of title Strings "ArticleA,ArticleB,..."
public java.util.List<Page> queryLinks(User user, java.util.List<java.lang.String> listOfTitleStrings)
user
- user login datalistOfTitleStrings
- a list of title Strings "ArticleA,ArticleB,..."
public java.util.List<Page> queryImageinfo(User user, java.util.List<java.lang.String> listOfImageStrings)
queryImageinfo(User, List, int)
if you need additional information
about the URL of the scaled image.
user
- user login datalistOfImageStrings
- a list of title Strings "ArticleA,ArticleB,..."
public java.util.List<Page> queryImageinfo(User user, java.util.List<java.lang.String> listOfImageStrings, int imageWidth)
user
- user login datalistOfImageStrings
- list of image title stringsimageWidth
- a URL to an image scaled to this width will be returned. Only the
current version of the image can be scaled.
public java.util.List<Page> query(User user, Query query)
user
- user login dataquery
- a user defined query
public java.util.List<Page> query(User user, java.util.List<java.lang.String> listOfTitleStrings, java.lang.String[] valuePairs)
user
- user login datalistOfTitleStrings
- a list of title Strings "ArticleA,ArticleB,..."valuePairs
- pairs of query strings which should be appended to the Mediawiki
API URL
public java.lang.String queryXML(User user, java.lang.String[] valuePairs)
user
- user login datavaluePairs
- pairs of query strings which should be appended to the Mediawiki
API URL
null
otherwisepublic java.lang.String queryXML(User user, java.util.List<java.lang.String> listOfTitleStrings, java.lang.String[] valuePairs)
user
- user login datalistOfTitleStrings
- a list of possibly empty title Strings "ArticleA,ArticleB,..."valuePairs
- pairs of query strings which should be appended to the Mediawiki
API URL
null
otherwisepublic ParseData parse(User user, RequestBuilder requestBuilder)
public void edit(User user, Edit editQuery) throws UnexpectedAnswerException
UnexpectedAnswerException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |