org.mediawiki.api.json

Class Api

java.lang.Object

org.mediawiki.api.json.Api

public class Api
extends java.lang.Object

Client wrapper for connecting to a MediaWiki installation's API. - It aims to be fully reentrant. - Uses JSON for everything

Field Summary

Fields

Modifier and Type	Field and Description
static int	METHOD_GET Parameter to setupRequest(int, RequestBuilder), performs GET request.
static int	METHOD_POST Parameter to setupRequest(int, RequestBuilder), performs POST request.

Constructor Summary

Constructors

Constructor and Description
Api(java.lang.String domain) Create an Api object with given only hostname.
Api(java.lang.String domain, boolean useSecure) Create an Api object with given only hostname and whether to use HTTPS or not.
Api(java.lang.String domain, boolean useSecure, java.lang.String endpointPath) Create an Api object with given only hostname, whether to use HTTPS or not, and endpoint path.
Api(java.lang.String domain, boolean useSecure, java.lang.String endpointPath, java.util.HashMap<java.lang.String,java.lang.String> customHeaders) Create an Api object
Api(java.lang.String domain, java.util.HashMap<java.lang.String,java.lang.String> customHeaders) Create an Api object with given only hostname and custom headers.
Api(java.lang.String domain, java.lang.String userAgent) Create an Api object with given only hostname and user agent.
Api(java.lang.String domain, java.lang.String userAgent, java.util.HashMap<java.lang.String,java.lang.String> customHeaders) Create an Api object with given only hostname, custom headers, and user agent.

Method Summary

Methods

Modifier and Type	Method and Description
RequestBuilder	action(java.lang.String action) Start building a request for a particular action.
java.net.URL	getApiUrl() Returns the full Url to which API requests are directed.
void	processHeaders(ApiResult result)
static void	setConnectionFactory(com.github.kevinsawicki.http.HttpRequest.ConnectionFactory factory) Set the connection factory used to construct connections.
void	setHeaderCheckListener(OnHeaderCheckListener listener)
ApiResult	setupRequest(int method, RequestBuilder requestBuilder) Sets up the HTTP request that needs to be made to produce results for this API query.

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_GET

public static final int METHOD_GET

Parameter to setupRequest(int, RequestBuilder), performs GET request.

See Also:

Constant Field Values

METHOD_POST

public static final int METHOD_POST

Parameter to setupRequest(int, RequestBuilder), performs POST request.

See Also:

Constant Field Values

Constructor Detail

Api

public Api(java.lang.String domain)

Create an Api object with given only hostname. Defaults to HTTPS No custom headers to send with each request Default endpoint (DEFAULT_ENDPOINT) will be used.

Parameters:

domain - Domain name of the MediaWiki API to connect to

Api

public Api(java.lang.String domain,
   java.lang.String userAgent)

Create an Api object with given only hostname and user agent. Defaults to HTTPS Default endpoint (DEFAULT_ENDPOINT) will be used

Parameters:

domain - Domain name of the MediaWiki API to connect to

userAgent - Custom User-Agent to simplify identification of consuming application

Api

public Api(java.lang.String domain,
   java.lang.String userAgent,
   java.util.HashMap<java.lang.String,java.lang.String> customHeaders)

Create an Api object with given only hostname, custom headers, and user agent. Defaults to HTTPS Default endpoint (DEFAULT_ENDPOINT) will be used

Parameters:

domain - Domain name of the MediaWiki API to connect to

userAgent - Custom User-Agent to simplify identification of consuming application

customHeaders - Any extra headers to send with each request, e.g. User-Agent.

Api

public Api(java.lang.String domain,
   java.util.HashMap<java.lang.String,java.lang.String> customHeaders)

Create an Api object with given only hostname and custom headers. Defaults to HTTPS Default endpoint (DEFAULT_ENDPOINT) will be used

Parameters:

domain - Domain name of the MediaWiki API to connect to

customHeaders - Any extra headers to send with each request, e.g. User-Agent.

Api

public Api(java.lang.String domain,
   boolean useSecure)

Create an Api object with given only hostname and whether to use HTTPS or not. No custom headers to send with each request Default endpoint (DEFAULT_ENDPOINT) will be used

Parameters:

domain - Domain name of the MediaWiki API to connect to

useSecure - true to use https, false to use http

Api

public Api(java.lang.String domain,
   boolean useSecure,
   java.lang.String endpointPath)

Create an Api object with given only hostname, whether to use HTTPS or not, and endpoint path. No custom headers to send with each request

Parameters:

domain - Domain name of the MediaWiki API to connect to

useSecure - true to use https, false to use http

endpointPath - Path to the api.php file. Require preceding slash.

Api

public Api(java.lang.String domain,
   boolean useSecure,
   java.lang.String endpointPath,
   java.util.HashMap<java.lang.String,java.lang.String> customHeaders)

Create an Api object

Parameters:

domain - Domain name of the MediaWiki API to connect to

useSecure - true to use https, false to use http

endpointPath - Path to the api.php file. Require preceding slash.

customHeaders - Any extra headers to send with each request, e.g. User-Agent.

Method Detail

getApiUrl

public java.net.URL getApiUrl()

Returns the full Url to which API requests are directed.

Returns:

Full URL to which requests are directed

action

public RequestBuilder action(java.lang.String action)

Start building a request for a particular action.

Parameters:

action - The action to start building a request for.

Returns:

A RequestBuilder instance that can be used to add parameters & execute the request.

setupRequest

public ApiResult setupRequest(int method,
                     RequestBuilder requestBuilder)
                       throws ApiException

Sets up the HTTP request that needs to be made to produce results for this API query. Use ApiResult.asArray() or ApiResult.asObject() to get the response. In the case of a GET request, the actual network transaction will only occur when you query the returned ApiResult object. However, for a POST request, the network transaction will occur immediately in this function, hence the possibility of an ApiException

Parameters:

method - HTTP method to use when performing the request

requestBuilder - The requestBuilder to use to construct the request

Returns:

An ApiResult object which can be used to get the result of this query.

Throws:

ApiException - Thrown in the case of a network error.

setConnectionFactory

public static void setConnectionFactory(com.github.kevinsawicki.http.HttpRequest.ConnectionFactory factory)

Set the connection factory used to construct connections.

Parameters:

factory - The factory used to construct HTTP connections

setHeaderCheckListener

public void setHeaderCheckListener(OnHeaderCheckListener listener)

processHeaders

public void processHeaders(ApiResult result)