info.bliki.api
Class User

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

public class User
extends java.lang.Object

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


Field Summary
static java.lang.String ILLEGAL_ID
           
static java.lang.String NEED_TOKEN_ID
           
static java.lang.String SUCCESS_ID
           
 
Constructor Summary
User()
          Deprecated.  
User(java.lang.String lgname, java.lang.String lgpassword, java.lang.String mediawikiApiUrl)
          Create a User for a Mediawiki wiki
User(java.lang.String lgname, java.lang.String lgpassword, java.lang.String mediawikiApiUrl, java.lang.String lgdomain)
          Create a User for a Mediawiki wiki
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getActionUrl()
          Get the Mediawiki API Url defined for this user(example: http://meta.wikimedia.org/w/api.php)
 Connector getConnector()
           
 java.lang.String getDomain()
           
 java.lang.String getNormalizedUsername()
           
 java.lang.String getPassword()
          Get the password defined for this user.
 java.lang.String getResult()
           
 java.lang.String getToken()
           
 java.lang.String getUserid()
           
 java.lang.String getUsername()
          Get the user name defined for this user.
 int hashCode()
           
 boolean login()
          Complete the users login information.
 java.util.List<Page> queryCategories(java.util.List<java.lang.String> listOfTitleStrings)
           
 java.util.List<Page> queryCategories(java.lang.String[] listOfTitleStrings)
           
 java.util.List<Page> queryContent(java.util.List<java.lang.String> listOfTitleStrings)
          Get the content of Mediawiki wiki pages.
 java.util.List<Page> queryContent(java.lang.String[] listOfTitleStrings)
          Get the content of Mediawiki wiki pages.
 java.util.List<Page> queryImageinfo(java.util.List<java.lang.String> listOfImageStrings)
           
 java.util.List<Page> queryImageinfo(java.util.List<java.lang.String> listOfImageStrings, int imageWidth)
           
 java.util.List<Page> queryImageinfo(java.lang.String[] listOfImageStrings)
           
 java.util.List<Page> queryImageinfo(java.lang.String[] listOfImageStrings, int imageWidth)
           
 java.util.List<Page> queryInfo(java.util.List<java.lang.String> listOfTitleStrings)
           
 java.util.List<Page> queryInfo(java.lang.String[] listOfTitleStrings)
           
 java.util.List<Page> queryLinks(java.util.List<java.lang.String> listOfTitleStrings)
           
 java.util.List<Page> queryLinks(java.lang.String[] listOfTitleStrings)
           
 void setNormalizedUsername(java.lang.String normalizedUsername)
           
 void setResult(java.lang.String result)
           
 void setToken(java.lang.String token)
           
 void setUserid(java.lang.String userid)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SUCCESS_ID

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

NEED_TOKEN_ID

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

ILLEGAL_ID

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

User

public User()
Deprecated. 

A default "blank" user, not really useful. Will be removed in later releases.


User

public User(java.lang.String lgname,
            java.lang.String lgpassword,
            java.lang.String mediawikiApiUrl)
Create a User for a Mediawiki wiki

Parameters:
lgname - User Name
lgpassword - Password
mediawikiApiUrl - A mediawiki API Url (example: http://meta.wikimedia.org/w/api.php

User

public User(java.lang.String lgname,
            java.lang.String lgpassword,
            java.lang.String mediawikiApiUrl,
            java.lang.String lgdomain)
Create a User for a Mediawiki wiki

Parameters:
lgname - User Name
lgpassword - Password
mediawikiApiUrl - A mediawiki API Url (example: http://meta.wikimedia.org/w/api.php
lgdomain - Domain (optional)
Method Detail

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.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 java.util.List<Page> queryContent(java.util.List<java.lang.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 java.util.List<Page> queryContent(java.lang.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 java.util.List<Page> queryCategories(java.util.List<java.lang.String> listOfTitleStrings)

queryCategories

public java.util.List<Page> queryCategories(java.lang.String[] listOfTitleStrings)

queryInfo

public java.util.List<Page> queryInfo(java.util.List<java.lang.String> listOfTitleStrings)

queryInfo

public java.util.List<Page> queryInfo(java.lang.String[] listOfTitleStrings)

queryLinks

public java.util.List<Page> queryLinks(java.util.List<java.lang.String> listOfTitleStrings)

queryLinks

public java.util.List<Page> queryLinks(java.lang.String[] listOfTitleStrings)

queryImageinfo

public java.util.List<Page> queryImageinfo(java.util.List<java.lang.String> listOfImageStrings)

queryImageinfo

public java.util.List<Page> queryImageinfo(java.util.List<java.lang.String> listOfImageStrings,
                                           int imageWidth)

queryImageinfo

public java.util.List<Page> queryImageinfo(java.lang.String[] listOfImageStrings)

queryImageinfo

public java.util.List<Page> queryImageinfo(java.lang.String[] listOfImageStrings,
                                           int imageWidth)

getResult

public java.lang.String getResult()

setResult

public void setResult(java.lang.String result)

getToken

public java.lang.String getToken()

setToken

public void setToken(java.lang.String token)

getUserid

public java.lang.String getUserid()

setUserid

public void setUserid(java.lang.String userid)

getUsername

public java.lang.String getUsername()
Get the user name defined for this user.

Returns:

getActionUrl

public java.lang.String getActionUrl()
Get the Mediawiki API Url defined for this user(example: http://meta.wikimedia.org/w/api.php)


getDomain

public java.lang.String getDomain()

getPassword

public java.lang.String getPassword()
Get the password defined for this user.

Returns:

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getConnector

public Connector getConnector()

getNormalizedUsername

public java.lang.String getNormalizedUsername()

setNormalizedUsername

public void setNormalizedUsername(java.lang.String normalizedUsername)


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