org.openstreetmap.josm.io.remotecontrol.handler
Class LoadObjectHandler

java.lang.Object
  extended by org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler
      extended by org.openstreetmap.josm.io.remotecontrol.handler.LoadObjectHandler

public class LoadObjectHandler
extends RequestHandler

Loads OSM primitives using their ID similar to the "Download object" dialog (@see DownloadPrimitiveAction}. For instance, /load_object?objects=n1,w2,r3[&new_layer=false&relation_members=true].


Nested Class Summary
 
Nested classes/interfaces inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler
RequestHandler.RequestHandlerBadRequestException, RequestHandler.RequestHandlerErrorException, RequestHandler.RequestHandlerException, RequestHandler.RequestHandlerForbiddenException
 
Field Summary
static java.lang.String command
           
 
Fields inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler
args, content, contentType, globalConfirmationDefault, globalConfirmationKey, loadInNewLayerDefault, loadInNewLayerKey, myCommand, request
 
Constructor Summary
LoadObjectHandler()
           
 
Method Summary
 java.lang.String[] getMandatoryParams()
           
 java.lang.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.
protected  void handleRequest()
          Handle a specific command sent as remote control.
 
Methods inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler
checkMandatoryParams, checkPermission, getContent, getContentType, handle, isLoadInNewLayer, parseArgs, setCommand, setUrl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

command

public static final java.lang.String command
See Also:
Constant Field Values
Constructor Detail

LoadObjectHandler

public LoadObjectHandler()
Method Detail

getMandatoryParams

public java.lang.String[] getMandatoryParams()
Specified by:
getMandatoryParams in class RequestHandler

handleRequest

protected void handleRequest()
                      throws RequestHandler.RequestHandlerErrorException,
                             RequestHandler.RequestHandlerBadRequestException
Description copied from class: RequestHandler
Handle a specific command sent as remote control. This method of the subclass will do the real work.

Specified by:
handleRequest in class RequestHandler
Throws:
RequestHandler.RequestHandlerErrorException
RequestHandler.RequestHandlerBadRequestException

getPermissionMessage

public java.lang.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 class RequestHandler
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 class RequestHandler
Returns:
the preference name and error message or null


JOSM