org.openstreetmap.josm.io
Class OsmApiException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.openstreetmap.josm.io.OsmTransferException
              extended by org.openstreetmap.josm.io.OsmApiException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
OsmApiPrimitiveGoneException

public class OsmApiException
extends OsmTransferException

Exception thrown when a communication error occurs when accessing the OSM API.

See Also:
OsmApi, Serialized Form

Field Summary
private  java.lang.String accessedUrl
           
private  java.lang.String errorBody
           
private  java.lang.String errorHeader
           
private  int responseCode
           
 
Constructor Summary
OsmApiException(int responseCode, java.lang.String errorHeader, java.lang.String errorBody)
          Constructs an OsmApiException with the specified response code, error header and error body
OsmApiException(java.lang.String message)
          Constructs an OsmApiException with the specified detail message.
OsmApiException(java.lang.String message, java.lang.Throwable cause)
          Constructs an OsmApiException with the specified detail message and cause.
OsmApiException(java.lang.Throwable cause)
          Constructs an OsmApiException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
 
Method Summary
 java.lang.String getAccessedUrl()
          Replies the complete URL accessed when this error occured.
 java.lang.String getDisplayMessage()
          Replies a message suitable to be displayed in a message dialog
 java.lang.String getErrorBody()
          Replies the error body.
 java.lang.String getErrorHeader()
          Replies the error header.
 java.lang.String getMessage()
           
 int getResponseCode()
          Replies the HTTP response code.
 void setAccessedUrl(java.lang.String url)
          Sets the complete URL accessed when this error occured.
 void setErrorBody(java.lang.String errorBody)
          Sets the error body.
 void setErrorHeader(java.lang.String errorHeader)
          Sets the error header.
 void setResponseCode(int responseCode)
          Sets the HTTP response code.
 
Methods inherited from class org.openstreetmap.josm.io.OsmTransferException
getUrl, setUrl
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

responseCode

private int responseCode

errorHeader

private java.lang.String errorHeader

errorBody

private java.lang.String errorBody

accessedUrl

private java.lang.String accessedUrl
Constructor Detail

OsmApiException

public OsmApiException(int responseCode,
                       java.lang.String errorHeader,
                       java.lang.String errorBody)
Constructs an OsmApiException with the specified response code, error header and error body

Parameters:
responseCode - The HTTP response code replied by the OSM server. See HttpURLConnection for predefined HTTP response code values
errorHeader - The error header, as transmitted in the Error field of the HTTP response header
errorBody - The error body, as transmitted in the HTTP response body

OsmApiException

public OsmApiException(java.lang.String message)
Constructs an OsmApiException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:
message - The detail message (which is saved for later retrieval by the getMessage() method)

OsmApiException

public OsmApiException(java.lang.Throwable cause)
Constructs an OsmApiException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Parameters:
cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). A null value is permitted, and indicates that the cause is nonexistent or unknown.

OsmApiException

public OsmApiException(java.lang.String message,
                       java.lang.Throwable cause)
Constructs an OsmApiException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated into this exception's detail message.

Parameters:
message - The detail message (which is saved for later retrieval by the getMessage() method)
cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). A null value is permitted, and indicates that the cause is nonexistent or unknown.
Method Detail

getResponseCode

public int getResponseCode()
Replies the HTTP response code.

Returns:
The HTTP response code replied by the OSM server. Refer to OSM API to see the list of response codes returned by the API for each call.

setResponseCode

public void setResponseCode(int responseCode)
Sets the HTTP response code.

Parameters:
responseCode - The HTTP response code replied by the OSM server. See HttpURLConnection for predefined HTTP response code values

getErrorHeader

public java.lang.String getErrorHeader()
Replies the error header.

Returns:
the error header, as transmitted in the Error field of the HTTP response header

setErrorHeader

public void setErrorHeader(java.lang.String errorHeader)
Sets the error header.

Parameters:
errorHeader - the error header, as transmitted in the Error field of the HTTP response header

getErrorBody

public java.lang.String getErrorBody()
Replies the error body.

Returns:
The error body, as transmitted in the HTTP response body

setErrorBody

public void setErrorBody(java.lang.String errorBody)
Sets the error body.

Parameters:
errorBody - The error body, as transmitted in the HTTP response body

getMessage

public java.lang.String getMessage()
Overrides:
getMessage in class java.lang.Throwable

getDisplayMessage

public java.lang.String getDisplayMessage()
Replies a message suitable to be displayed in a message dialog

Returns:
a message which is suitable to be displayed in a message dialog

setAccessedUrl

public void setAccessedUrl(java.lang.String url)
Sets the complete URL accessed when this error occured. This is distinct from the one set with OsmTransferException.setUrl(java.lang.String), which is generally only the base URL of the server.

Parameters:
url - the complete URL accessed when this error occured.

getAccessedUrl

public java.lang.String getAccessedUrl()
Replies the complete URL accessed when this error occured. This is distinct from the one returned by OsmTransferException.getUrl(), which is generally only the base URL of the server.

Returns:
the complete URL accessed when this error occured.


JOSM