org.openstreetmap.josm.gui.oauth

Class TestAccessTokenTask

java.lang.Object

org.openstreetmap.josm.gui.PleaseWaitRunnable

org.openstreetmap.josm.gui.oauth.TestAccessTokenTask

All Implemented Interfaces:

Runnable, ProgressMonitor.CancelListener

public class TestAccessTokenTask
extends PleaseWaitRunnable

Checks whether an OSM API server can be accessed with a specific Access Token. It retrieves the user details for the user which is authorized to access the server with this token.

Field Summary

Fields

Modifier and Type	Field and Description
private String	apiUrl
private boolean	canceled
private HttpClient	connection
private OAuthParameters	oauthParameters
private Component	parent
private OAuthToken	token

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

progressMonitor

Constructor Summary

Constructors

Constructor and Description
TestAccessTokenTask(Component parent, String apiUrl, OAuthParameters parameters, OAuthToken accessToken) Create the task

Method Summary

Modifier and Type	Method and Description
protected void	alertFailedAuthentication()
protected void	alertFailedAuthorisation()
protected void	alertFailedConnection()
protected void	alertFailedSigning()
protected void	alertInternalError()
protected void	cancel() User pressed cancel button.
protected void	finish() Finish up the data work.
protected UserInfo	getUserDetails()
protected String	normalizeApiUrl(String url)
protected void	notifySuccess(UserInfo userInfo)
protected void	realRun() Called in the worker thread to do the actual work.
protected void	sign(HttpClient con)

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

token

private final OAuthToken token

oauthParameters

private final OAuthParameters oauthParameters

canceled

private boolean canceled

parent

private final Component parent

apiUrl

private final String apiUrl

connection

private HttpClient connection

Constructor Detail

TestAccessTokenTask

public TestAccessTokenTask(Component parent,
                           String apiUrl,
                           OAuthParameters parameters,
                           OAuthToken accessToken)

Create the task

Parameters:

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

apiUrl - the API URL. Must not be null.

parameters - the OAuth parameters. Must not be null.

accessToken - the Access Token. Must not be null.

Method Detail

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

sign

protected void sign(HttpClient con)
             throws oauth.signpost.exception.OAuthException

Throws:

oauth.signpost.exception.OAuthException

normalizeApiUrl

protected String normalizeApiUrl(String url)

getUserDetails

protected UserInfo getUserDetails()
                           throws OsmOAuthAuthorizationException,
                                  XmlParsingException,
                                  OsmTransferException

Throws:

OsmOAuthAuthorizationException

XmlParsingException

OsmTransferException

notifySuccess

protected void notifySuccess(UserInfo userInfo)

alertFailedAuthentication

protected void alertFailedAuthentication()

alertFailedAuthorisation

protected void alertFailedAuthorisation()

alertFailedConnection

protected void alertFailedConnection()

alertFailedSigning

protected void alertFailedSigning()

alertInternalError

protected void alertInternalError()

realRun

protected void realRun()
                throws SAXException,
                       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:

SAXException - if a SAX error occurs

IOException - if an I/O error occurs

OsmTransferException - if a communication error with the OSM server occurs