Package org.openstreetmap.josm.gui.preferences.server

Class ApiUrlTestTask

java.lang.Object

org.openstreetmap.josm.gui.PleaseWaitRunnable

org.openstreetmap.josm.gui.preferences.server.ApiUrlTestTask

All Implemented Interfaces:

java.lang.Runnable, ProgressMonitor.CancelListener

public class ApiUrlTestTask
extends PleaseWaitRunnable

This is an asynchronous task for testing whether an URL points to an OSM API server. It tries to retrieve capabilities from the given URL. If it succeeds, the method isSuccess() replies true, otherwise false.

Since:

2745

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	canceled
private HttpClient	connection
private java.awt.Component	parent
private boolean	success
private java.lang.String	url

Fields inherited from class org.openstreetmap.josm.gui.PleaseWaitRunnable

progressMonitor

Constructor Summary

Constructors

Constructor	Description
ApiUrlTestTask(java.awt.Component parent, java.lang.String url)	Constructs a new ApiUrlTestTask.

Method Summary

Modifier and Type	Method	Description
protected void	alertConnectionFailed()
protected void	alertInvalidCapabilities()
protected void	alertInvalidCapabilitiesUrl(java.lang.String url)
protected void	alertInvalidServerResult(int retCode)
protected void	alertInvalidUrl(java.lang.String url)
protected void	cancel()	User pressed cancel button.
protected void	finish()	Finish up the data work.
protected java.lang.String	getNormalizedApiUrl()	Removes leading and trailing whitespace from the API URL and removes trailing '/'.
boolean	isCanceled()	Determines if the test has been canceled.
boolean	isSuccess()	Determines if the test has succeeded.
protected void	realRun()	Called in the worker thread to do the actual work.

Methods inherited from class org.openstreetmap.josm.gui.PleaseWaitRunnable

afterFinish, canRunInBackground, getProgressMonitor, operationCanceled, run

Methods inherited from class java.lang.Object

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

Field Detail

url

private final java.lang.String url

canceled

private boolean canceled

success

private boolean success

parent

private final java.awt.Component parent

connection

private HttpClient connection

Constructor Detail

ApiUrlTestTask

public ApiUrlTestTask(java.awt.Component parent,
                      java.lang.String url)

Constructs a new ApiUrlTestTask.

Parameters:

parent - the parent component relative to which the PleaseWaitRunnable-Dialog is displayed

url - the url. Must not be null.

Throws:

java.lang.IllegalArgumentException - if url is null.

Method Detail

alertInvalidUrl

protected void alertInvalidUrl(java.lang.String url)

alertInvalidCapabilitiesUrl

protected void alertInvalidCapabilitiesUrl(java.lang.String url)

alertConnectionFailed

protected void alertConnectionFailed()

alertInvalidServerResult

protected void alertInvalidServerResult(int retCode)

alertInvalidCapabilities

protected void alertInvalidCapabilities()

cancel

protected void cancel()

Description copied from class: PleaseWaitRunnable

User pressed cancel button.

Specified by:

cancel in class PleaseWaitRunnable

finish

protected void finish()

Description copied from class: PleaseWaitRunnable

Finish up the data work. Is guaranteed to be called if realRun is called. Finish is called in the gui thread just after the dialog disappeared.

Specified by:

finish in class PleaseWaitRunnable

getNormalizedApiUrl

protected java.lang.String getNormalizedApiUrl()

Removes leading and trailing whitespace from the API URL and removes trailing '/'.

Returns:

the normalized API URL

realRun

protected void realRun()
                throws org.xml.sax.SAXException,
                       java.io.IOException,
                       OsmTransferException

Description copied from class: PleaseWaitRunnable

Called in the worker thread to do the actual work. When any of the exception is thrown, a message box will be displayed and closeDialog is called. finish() is called in any case.

Specified by:

realRun in class PleaseWaitRunnable

Throws:

org.xml.sax.SAXException - if a SAX error occurs

java.io.IOException - if an I/O error occurs

OsmTransferException - if a communication error with the OSM server occurs

isCanceled

public boolean isCanceled()

Determines if the test has been canceled.

Returns:

true if canceled, false otherwise

isSuccess

public boolean isSuccess()

Determines if the test has succeeded.

Returns:

true if success, false otherwise