org.openstreetmap.josm.io.remotecontrol.handler

Class OpenFileHandler

java.lang.Object

org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler

org.openstreetmap.josm.io.remotecontrol.handler.OpenFileHandler

public class OpenFileHandler
extends RequestHandler

Opens a local file

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	command The remote control command name used to open a local file.

Fields inherited from class org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler

args, content, contentType, globalConfirmationDefault, globalConfirmationKey, loadInNewLayerDefault, loadInNewLayerKey, myCommand, PERMISSIONS, request, sender, SPLITTER_COMMA, SPLITTER_SEMIC

Constructor Summary

Constructors

Constructor and Description
OpenFileHandler()

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	getUsage()
java.lang.String[]	getUsageExamples()
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, getContent, getContentType, getDownloadParams, getOptionalParams, getRequestParameter, getUsageExamples, handle, parseArgs, setCommand, setSender, setUrl, splitArg, validateDownloadParams

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

The remote control command name used to open a local file.

See Also:

Constant Field Values

Constructor Detail

OpenFileHandler

public OpenFileHandler()

Method Detail

getMandatoryParams

public java.lang.String[] getMandatoryParams()

Specified by:

getMandatoryParams in class RequestHandler

getUsage

public java.lang.String getUsage()

Overrides:

getUsage in class RequestHandler

getUsageExamples

public java.lang.String[] getUsageExamples()

Overrides:

getUsageExamples in class RequestHandler

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

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 - if an error occurs while processing request

RequestHandler.RequestHandlerBadRequestException - if request is invalid

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

validateRequest

protected void validateRequest()
                        throws RequestHandler.RequestHandlerBadRequestException

Description copied from class: RequestHandler

Validates the request before attempting to perform it.

Specified by:

validateRequest in class RequestHandler

Throws:

RequestHandler.RequestHandlerBadRequestException - if request is invalid