Class LoadDataHandler
- java.lang.Object
-
- org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler
-
- org.openstreetmap.josm.io.remotecontrol.handler.LoadDataHandler
-
public class LoadDataHandler extends RequestHandler
Handler to load data directly from the URL.- Since:
- 7636
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
LoadDataHandler.LoadDataTask
-
Nested classes/interfaces inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler
RequestHandler.PermissionCache, RequestHandler.RawURLParseRequestHandler, RequestHandler.RequestHandlerBadRequestException, RequestHandler.RequestHandlerErrorException, RequestHandler.RequestHandlerException, RequestHandler.RequestHandlerForbiddenException, RequestHandler.RequestHandlerOsmApiException
-
-
Field Summary
Fields Modifier and Type Field Description static String
command
The remote control command name used to import data.private String
data
Holds the data input stringprivate DataSet
dataSet
Holds the parsed data setprivate static String
OSM_MIME_TYPE
-
Fields inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler
args, content, contentType, GLOBAL_CONFIRMATION, LOAD_IN_NEW_LAYER, myCommand, OSM_DOWNLOAD_TIMEOUT, PERMISSIONS, request, sender, SPLITTER_COMMA, SPLITTER_SEMIC
-
-
Constructor Summary
Constructors Constructor Description LoadDataHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String[]
getMandatoryParams()
Returns the mandatory parameters.String[]
getOptionalParams()
Returns the optional parameters.String
getPermissionMessage()
Get a specific message to ask the user for permission for the operation requested via remote control.PermissionPrefWithDefault
getPermissionPref()
Get a PermissionPref object containing the name of a special permission preference to individually allow the requested operation and an error message to be displayed when a disabled operation is requested.String
getUsage()
Returns usage description, for bad requests and documentation.String[]
getUsageExamples()
Returns usage examples, for bad requests and documentation.protected void
handleRequest()
Handle a specific command sent as remote control.protected void
validateRequest()
Validates the request before attempting to perform it.-
Methods inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler
checkMandatoryParams, checkPermission, getCommand, getContent, getContentType, getDownloadParams, getRequestParameter, getUsageExamples, handle, parseArgs, setCommand, setSender, setUrl, splitArg, validateDownloadParams
-
-
-
-
Field Detail
-
OSM_MIME_TYPE
private static final String OSM_MIME_TYPE
- See Also:
- Constant Field Values
-
command
public static final String command
The remote control command name used to import data.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
LoadDataHandler
public LoadDataHandler()
-
-
Method Detail
-
handleRequest
protected void handleRequest() throws RequestHandler.RequestHandlerErrorException
Description copied from class:RequestHandler
Handle a specific command sent as remote control. Any time-consuming operation must be performed asynchronously to avoid delaying the HTTP response. This method of the subclass will do the real work.- Specified by:
handleRequest
in classRequestHandler
- Throws:
RequestHandler.RequestHandlerErrorException
- if an error occurs while processing request
-
getMandatoryParams
public String[] getMandatoryParams()
Description copied from class:RequestHandler
Returns the mandatory parameters. Both used to enforce their presence at runtime and for documentation.- Specified by:
getMandatoryParams
in classRequestHandler
- Returns:
- the mandatory parameters
-
getOptionalParams
public String[] getOptionalParams()
Description copied from class:RequestHandler
Returns the optional parameters. Both used to enforce their presence at runtime and for documentation.- Overrides:
getOptionalParams
in classRequestHandler
- Returns:
- the optional parameters
-
getUsage
public String getUsage()
Description copied from class:RequestHandler
Returns usage description, for bad requests and documentation.- Overrides:
getUsage
in classRequestHandler
- Returns:
- usage description
-
getUsageExamples
public String[] getUsageExamples()
Description copied from class:RequestHandler
Returns usage examples, for bad requests and documentation.- Overrides:
getUsageExamples
in classRequestHandler
- Returns:
- Usage examples
-
getPermissionMessage
public String getPermissionMessage()
Description copied from class:RequestHandler
Get a specific message to ask the user for permission for the operation requested via remote control. This message will be displayed to the user if the preference remotecontrol.always-confirm is true.- Specified by:
getPermissionMessage
in classRequestHandler
- Returns:
- the message
-
getPermissionPref
public PermissionPrefWithDefault getPermissionPref()
Description copied from class:RequestHandler
Get a PermissionPref object containing the name of a special permission preference to individually allow the requested operation and an error message to be displayed when a disabled operation is requested. Default is not to check any special preference. Override this in a subclass to define permission preference and error message.- Specified by:
getPermissionPref
in classRequestHandler
- Returns:
- the preference name and error message or null
-
validateRequest
protected void validateRequest() throws RequestHandler.RequestHandlerBadRequestException
Description copied from class:RequestHandler
Validates the request before attempting to perform it.- Specified by:
validateRequest
in classRequestHandler
- Throws:
RequestHandler.RequestHandlerBadRequestException
- if request is invalid
-
-