org.openstreetmap.josm.io

Class OsmConnection

java.lang.Object

org.openstreetmap.josm.io.OsmConnection

Direct Known Subclasses:

OsmApi, OsmServerReader

public class OsmConnection
extends java.lang.Object

Base class that handles common things like authentication for the reader and writer to the osm server.

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpClient	activeConnection
protected boolean	cancel
protected OAuthParameters	oauthParameters

Constructor Summary

Constructors

Constructor and Description
OsmConnection()

Method Summary

Modifier and Type	Method and Description
protected void	addAuth(HttpClient connection)
protected void	addBasicAuthorizationHeader(HttpClient con) Adds an authentication header for basic authentication
protected void	addOAuthAuthorizationHeader(HttpClient connection) Signs the connection with an OAuth authentication header
void	cancel() Cancels the connection.
boolean	isCanceled() Replies true if this connection is canceled
protected void	obtainAccessToken(HttpClient connection) Obtains an OAuth access token for the connection.

Methods inherited from class java.lang.Object

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

Field Detail

cancel

protected boolean cancel

activeConnection

protected HttpClient activeConnection

oauthParameters

protected OAuthParameters oauthParameters

Constructor Detail

OsmConnection

public OsmConnection()

Method Detail

cancel

public void cancel()

Cancels the connection.

addBasicAuthorizationHeader

protected void addBasicAuthorizationHeader(HttpClient con)
                                    throws OsmTransferException

Adds an authentication header for basic authentication

Parameters:

con - the connection

Throws:

OsmTransferException - if something went wrong. Check for nested exceptions

addOAuthAuthorizationHeader

protected void addOAuthAuthorizationHeader(HttpClient connection)
                                    throws OsmTransferException

Signs the connection with an OAuth authentication header

Parameters:

connection - the connection

Throws:

OsmTransferException - if there is currently no OAuth Access Token configured

OsmTransferException - if signing fails

obtainAccessToken

protected void obtainAccessToken(HttpClient connection)
                          throws MissingOAuthAccessTokenException

Obtains an OAuth access token for the connection. Afterwards, the token is accessible via OAuthAccessTokenHolder.

Parameters:

connection - connection for which the access token should be obtained

Throws:

MissingOAuthAccessTokenException - if the process cannot be completec successfully

addAuth

protected void addAuth(HttpClient connection)
                throws OsmTransferException

Throws:

OsmTransferException

isCanceled

public boolean isCanceled()

Replies true if this connection is canceled

Returns:

true if this connection is canceled