org.openstreetmap.josm.io

Class OsmServerReader

java.lang.Object

org.openstreetmap.josm.io.OsmConnection

org.openstreetmap.josm.io.OsmServerReader

Direct Known Subclasses:

BoundingBoxDownloader, MultiFetchServerObjectReader, MultiFetchServerObjectReader.Fetcher, OsmServerBackreferenceReader, OsmServerChangesetReader, OsmServerHistoryReader, OsmServerLocationReader, OsmServerObjectReader, OsmServerUserInfoReader

public abstract class OsmServerReader
extends OsmConnection

This DataReader reads directly from the REST API of the osm server. It supports plain text transfer as well as gzip or deflate encoded transfers; if compressed transfers are unwanted, set property osm-server.use-compression to false.

Field Summary

Fields

Modifier and Type	Field and Description
private OsmApi	api
private boolean	doAuthenticate
protected boolean	gpxParsedProperly

Fields inherited from class org.openstreetmap.josm.io.OsmConnection

activeConnection, cancel, oauthParameters

Constructor Summary

Constructors

Constructor and Description
OsmServerReader()

Method Summary

Modifier and Type	Method and Description
protected void	adaptRequest(HttpClient request) Allows subclasses to modify the request.
protected java.lang.String	getBaseUrl() Return the base URL for relative URL requests
protected java.io.InputStream	getInputStream(java.lang.String urlStr, ProgressMonitor progressMonitor) Open a connection to the given url and return a reader on the input stream from that connection.
protected java.io.InputStream	getInputStream(java.lang.String urlStr, ProgressMonitor progressMonitor, java.lang.String reason) Open a connection to the given url and return a reader on the input stream from that connection.
protected java.io.InputStream	getInputStreamRaw(java.lang.String urlStr, ProgressMonitor progressMonitor) Open a connection to the given url and return a reader on the input stream from that connection.
protected java.io.InputStream	getInputStreamRaw(java.lang.String urlStr, ProgressMonitor progressMonitor, java.lang.String reason) Open a connection to the given url and return a reader on the input stream from that connection.
protected java.io.InputStream	getInputStreamRaw(java.lang.String urlStr, ProgressMonitor progressMonitor, java.lang.String reason, boolean uncompressAccordingToContentDisposition) Open a connection to the given url and return a reader on the input stream from that connection.
boolean	isDoAuthenticate() Returns true if this reader is adding authentication credentials to the read request sent to the server.
boolean	isGpxParsedProperly() Determines if the GPX data has been parsed properly.
java.util.List<Note>	parseNotes(int noteLimit, int daysClosed, ProgressMonitor progressMonitor) Downloads notes from the API, given API limit parameters
abstract DataSet	parseOsm(ProgressMonitor progressMonitor) Download OSM files from somewhere
DataSet	parseOsmBzip2(ProgressMonitor progressMonitor) Download BZip2-compressed OSM files from somewhere
DataSet	parseOsmChange(ProgressMonitor progressMonitor) Download OSM Change files from somewhere
DataSet	parseOsmChangeBzip2(ProgressMonitor progressMonitor) Download BZip2-compressed OSM Change files from somewhere
DataSet	parseOsmChangeGzip(ProgressMonitor progressMonitor) Download GZip-compressed OSM Change files from somewhere
DataSet	parseOsmGzip(ProgressMonitor progressMonitor) Download GZip-compressed OSM files from somewhere
DataSet	parseOsmZip(ProgressMonitor progressMonitor) Download Zip-compressed OSM files from somewhere
GpxData	parseRawGps(ProgressMonitor progressMonitor) Retrieve raw gps waypoints from the server API.
GpxData	parseRawGpsBzip2(ProgressMonitor progressMonitor) Retrieve BZip2-compressed GPX files from somewhere.
java.util.List<Note>	parseRawNotes(ProgressMonitor progressMonitor) Downloads notes from a given raw URL.
java.util.List<Note>	parseRawNotesBzip2(ProgressMonitor progressMonitor) Download notes from a URL that contains a bzip2 compressed notes dump file
void	setDoAuthenticate(boolean doAuthenticate) Sets whether this reader adds authentication credentials to the read request sent to the server.

Methods inherited from class org.openstreetmap.josm.io.OsmConnection

addAuth, addBasicAuthorizationHeader, addOAuthAuthorizationHeader, cancel, isCanceled, obtainAccessToken

Methods inherited from class java.lang.Object

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

Field Detail

api

private final OsmApi api

doAuthenticate

private boolean doAuthenticate

gpxParsedProperly

protected boolean gpxParsedProperly

Constructor Detail

OsmServerReader

public OsmServerReader()

Method Detail

getInputStream

protected java.io.InputStream getInputStream(java.lang.String urlStr,
                                             ProgressMonitor progressMonitor)
                                      throws OsmTransferException

Open a connection to the given url and return a reader on the input stream from that connection. In case of user cancel, return null. Relative URL's are directed to API base URL.

Parameters:

urlStr - The url to connect to.

progressMonitor - progress monitoring and abort handler

Returns:

A reader reading the input stream (servers answer) or null.

Throws:

OsmTransferException - if data transfer errors occur

getInputStream

protected java.io.InputStream getInputStream(java.lang.String urlStr,
                                             ProgressMonitor progressMonitor,
                                             java.lang.String reason)
                                      throws OsmTransferException

Open a connection to the given url and return a reader on the input stream from that connection. In case of user cancel, return null. Relative URL's are directed to API base URL.

Parameters:

urlStr - The url to connect to.

progressMonitor - progress monitoring and abort handler

reason - The reason to show on console. Can be null if no reason is given

Returns:

A reader reading the input stream (servers answer) or null.

Throws:

OsmTransferException - if data transfer errors occur

getBaseUrl

protected java.lang.String getBaseUrl()

Return the base URL for relative URL requests

Returns:

base url of API

getInputStreamRaw

protected java.io.InputStream getInputStreamRaw(java.lang.String urlStr,
                                                ProgressMonitor progressMonitor)
                                         throws OsmTransferException

Open a connection to the given url and return a reader on the input stream from that connection. In case of user cancel, return null.

Parameters:

urlStr - The exact url to connect to.

progressMonitor - progress monitoring and abort handler

Returns:

An reader reading the input stream (servers answer) or null.

Throws:

OsmTransferException - if data transfer errors occur

getInputStreamRaw

protected java.io.InputStream getInputStreamRaw(java.lang.String urlStr,
                                                ProgressMonitor progressMonitor,
                                                java.lang.String reason)
                                         throws OsmTransferException

Open a connection to the given url and return a reader on the input stream from that connection. In case of user cancel, return null.

Parameters:

urlStr - The exact url to connect to.

progressMonitor - progress monitoring and abort handler

reason - The reason to show on console. Can be null if no reason is given

Returns:

An reader reading the input stream (servers answer) or null.

Throws:

OsmTransferException - if data transfer errors occur

getInputStreamRaw

protected java.io.InputStream getInputStreamRaw(java.lang.String urlStr,
                                                ProgressMonitor progressMonitor,
                                                java.lang.String reason,
                                                boolean uncompressAccordingToContentDisposition)
                                         throws OsmTransferException

Open a connection to the given url and return a reader on the input stream from that connection. In case of user cancel, return null.

Parameters:

urlStr - The exact url to connect to.

progressMonitor - progress monitoring and abort handler

reason - The reason to show on console. Can be null if no reason is given

uncompressAccordingToContentDisposition - Whether to inspect the HTTP header Content-Disposition for filename and uncompress a gzip/bzip2 stream.

Returns:

An reader reading the input stream (servers answer) or null.

Throws:

OsmTransferException - if data transfer errors occur

adaptRequest

protected void adaptRequest(HttpClient request)

Allows subclasses to modify the request.

Parameters:

request - the prepared request

Since:

9308

parseOsm

public abstract DataSet parseOsm(ProgressMonitor progressMonitor)
                          throws OsmTransferException

Download OSM files from somewhere

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs

parseOsmChange

public DataSet parseOsmChange(ProgressMonitor progressMonitor)
                       throws OsmTransferException

Download OSM Change files from somewhere

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs

parseOsmChangeBzip2

public DataSet parseOsmChangeBzip2(ProgressMonitor progressMonitor)
                            throws OsmTransferException

Download BZip2-compressed OSM Change files from somewhere

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs

parseOsmChangeGzip

public DataSet parseOsmChangeGzip(ProgressMonitor progressMonitor)
                           throws OsmTransferException

Download GZip-compressed OSM Change files from somewhere

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs

parseRawGps

public GpxData parseRawGps(ProgressMonitor progressMonitor)
                    throws OsmTransferException

Retrieve raw gps waypoints from the server API.

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding GPX tracks

Throws:

OsmTransferException - if any error occurs

parseRawGpsBzip2

public GpxData parseRawGpsBzip2(ProgressMonitor progressMonitor)
                         throws OsmTransferException

Retrieve BZip2-compressed GPX files from somewhere.

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding GPX tracks

Throws:

OsmTransferException - if any error occurs

Since:

6244

parseOsmBzip2

public DataSet parseOsmBzip2(ProgressMonitor progressMonitor)
                      throws OsmTransferException

Download BZip2-compressed OSM files from somewhere

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs

parseOsmGzip

public DataSet parseOsmGzip(ProgressMonitor progressMonitor)
                     throws OsmTransferException

Download GZip-compressed OSM files from somewhere

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs

parseOsmZip

public DataSet parseOsmZip(ProgressMonitor progressMonitor)
                    throws OsmTransferException

Download Zip-compressed OSM files from somewhere

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs

Since:

6882

isDoAuthenticate

public boolean isDoAuthenticate()

Returns true if this reader is adding authentication credentials to the read request sent to the server.

Returns:

true if this reader is adding authentication credentials to the read request sent to the server

setDoAuthenticate

public void setDoAuthenticate(boolean doAuthenticate)

Sets whether this reader adds authentication credentials to the read request sent to the server.

Parameters:

doAuthenticate - true if this reader adds authentication credentials to the read request sent to the server

isGpxParsedProperly

public final boolean isGpxParsedProperly()

Determines if the GPX data has been parsed properly.

Returns:

true if the GPX data has been parsed properly, false otherwise

See Also:

GpxReader.parse(boolean)

parseNotes

public java.util.List<Note> parseNotes(int noteLimit,
                                       int daysClosed,
                                       ProgressMonitor progressMonitor)
                                throws OsmTransferException

Downloads notes from the API, given API limit parameters

Parameters:

noteLimit - How many notes to download.

daysClosed - Return notes closed this many days in the past. -1 means all notes, ever. 0 means only unresolved notes.

progressMonitor - Progress monitor for user feedback

Returns:

List of notes returned by the API

Throws:

OsmTransferException - if any errors happen

parseRawNotes

public java.util.List<Note> parseRawNotes(ProgressMonitor progressMonitor)
                                   throws OsmTransferException

Downloads notes from a given raw URL. The URL is assumed to be complete and no API limits are added

Parameters:

progressMonitor - progress monitor

Returns:

A list of notes parsed from the URL

Throws:

OsmTransferException - if any error occurs during dialog with OSM API

parseRawNotesBzip2

public java.util.List<Note> parseRawNotesBzip2(ProgressMonitor progressMonitor)
                                        throws OsmTransferException

Download notes from a URL that contains a bzip2 compressed notes dump file

Parameters:

progressMonitor - progress monitor

Returns:

A list of notes parsed from the URL

Throws:

OsmTransferException - if any error occurs during dialog with OSM API