de.westnordost.osmapi

Class OsmConnection

java.lang.Object

de.westnordost.osmapi.OsmConnection

public class OsmConnection
extends java.lang.Object

Talks with the OpenStreetMap API 0.6, acts as a basis for data access objects for openstreetmap data accessible through the API.

Requests made through this object can generally throw three two kinds of unchecked exceptions:

• OsmConnectionException: if an error occurs while communicating with the server that is independent of the actual request made. Usually this is a wrapped IOException and similar.
• OsmApiReadResponseException: an error while parsing the server's response; any exception thrown by a response handler will be wrapped in this exception. It is up to the handler to decide which Exceptions it throws, but if it is thrown during parsing, this hints to a programming error (in the parser).
• OsmApiException: if there is something wrong with the user's request, i.e. the request itself was invalid, likely a programming error.

So, if there were checked exceptions in this library, then OsmConnectionException would be the checked one because it is a fault in the environment.

A OsmConnection is reusable and thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHARSET charset we use for everything (UTF-8)

Constructor Summary

Constructors

Constructor and Description
OsmConnection(java.lang.String apiUrl, java.lang.String userAgent)
OsmConnection(java.lang.String apiUrl, java.lang.String userAgent, oauth.signpost.OAuthConsumer oauth)
OsmConnection(java.lang.String apiUrl, java.lang.String userAgent, oauth.signpost.OAuthConsumer oauth, java.lang.Integer timeout) Create a new OsmConnection with the given preferences

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiUrl()
oauth.signpost.OAuthConsumer	getOAuth()
int	getTimeout()
java.lang.String	getUserAgent()
void	makeAuthenticatedRequest(java.lang.String call, java.lang.String method)
void	makeAuthenticatedRequest(java.lang.String call, java.lang.String method, ApiRequestWriter writer)
<T> T	makeAuthenticatedRequest(java.lang.String call, java.lang.String method, ApiRequestWriter writer, ApiResponseReader<T> reader)
<T> T	makeAuthenticatedRequest(java.lang.String call, java.lang.String method, ApiResponseReader<T> reader)
<T> T	makeRequest(java.lang.String call, ApiResponseReader<T> reader)
<T> T	makeRequest(java.lang.String call, boolean authenticate, ApiResponseReader<T> reader)
<T> T	makeRequest(java.lang.String call, java.lang.String method, boolean authenticate, ApiRequestWriter writer, ApiResponseReader<T> reader) Make a request to the Http Osm Api
void	setApiUrl(java.lang.String apiUrl)
void	setOAuth(oauth.signpost.OAuthConsumer oauth)
void	setTimeout(int timeout)
void	setUserAgent(java.lang.String userAgent)

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET

public static final java.lang.String CHARSET

charset we use for everything (UTF-8)

See Also:

Constant Field Values

Constructor Detail

OsmConnection

public OsmConnection(java.lang.String apiUrl,
                     java.lang.String userAgent,
                     oauth.signpost.OAuthConsumer oauth,
                     java.lang.Integer timeout)

Create a new OsmConnection with the given preferences

Parameters:

apiUrl - the URL to the API

userAgent - the user agent this application should identify as

oauth - oauth consumer to use to authenticate this app. If this is null, any attempt to make an API call that requires authorization will throw an OsmAuthorizationException

timeout - for the server connection. Defaults to 45 seconds.

OsmConnection

public OsmConnection(java.lang.String apiUrl,
                     java.lang.String userAgent,
                     oauth.signpost.OAuthConsumer oauth)

See Also:

OsmConnection(String, String, OAuthConsumer, Integer)

OsmConnection

public OsmConnection(java.lang.String apiUrl,
                     java.lang.String userAgent)

See Also:

OsmConnection(String, String, OAuthConsumer, Integer)

Method Detail

setTimeout

public void setTimeout(int timeout)

setOAuth

public void setOAuth(oauth.signpost.OAuthConsumer oauth)

setApiUrl

public void setApiUrl(java.lang.String apiUrl)

setUserAgent

public void setUserAgent(java.lang.String userAgent)

getUserAgent

public java.lang.String getUserAgent()

getApiUrl

public java.lang.String getApiUrl()

getOAuth

public oauth.signpost.OAuthConsumer getOAuth()

getTimeout

public int getTimeout()

makeRequest

public <T> T makeRequest(java.lang.String call,
                         ApiResponseReader<T> reader)

See Also:

makeRequest(String, String, boolean, ApiRequestWriter, ApiResponseReader)

makeRequest

public <T> T makeRequest(java.lang.String call,
                         boolean authenticate,
                         ApiResponseReader<T> reader)

See Also:

makeRequest(String, String, boolean, ApiRequestWriter, ApiResponseReader)

makeAuthenticatedRequest

public <T> T makeAuthenticatedRequest(java.lang.String call,
                                      java.lang.String method,
                                      ApiResponseReader<T> reader)

See Also:

makeRequest(String, String, boolean, ApiRequestWriter, ApiResponseReader)

makeAuthenticatedRequest

public <T> T makeAuthenticatedRequest(java.lang.String call,
                                      java.lang.String method,
                                      ApiRequestWriter writer,
                                      ApiResponseReader<T> reader)

See Also:

makeRequest(String, String, boolean, ApiRequestWriter, ApiResponseReader)

makeAuthenticatedRequest

public void makeAuthenticatedRequest(java.lang.String call,
                                     java.lang.String method)

See Also:

makeRequest(String, String, boolean, ApiRequestWriter, ApiResponseReader)

makeAuthenticatedRequest

public void makeAuthenticatedRequest(java.lang.String call,
                                     java.lang.String method,
                                     ApiRequestWriter writer)

See Also:

makeRequest(String, String, boolean, ApiRequestWriter, ApiResponseReader)

makeRequest

public <T> T makeRequest(java.lang.String call,
                         java.lang.String method,
                         boolean authenticate,
                         ApiRequestWriter writer,
                         ApiResponseReader<T> reader)

Make a request to the Http Osm Api

Parameters:

call - HTTP path and URL parameters (if any)

method - HTTP method. Defaults to "GET"

authenticate - whether to make this request as a logged in user

writer - the writer to send the request payload to the server. If null, no payload is sent

reader - the reader to parse the server's response and return an instance of T. If null, the server's response is ignored

Returns:

an instance of T