Package org.openstreetmap.josm.io.remotecontrol.handler

Class OpenApiHandler

java.lang.Object

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

org.openstreetmap.josm.io.remotecontrol.handler.OpenApiHandler

public class OpenApiHandler
extends RequestHandler

Reports available commands as OpenAPI.

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, RequestHandler.RequestHandlerOsmApiException

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	command	The remote control command name.

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
OpenApiHandler()

Method Summary

Modifier and Type	Method	Description
private java.lang.String	getDescription(RequestHandler handler)
private jakarta.json.JsonObjectBuilder	getHandler(RequestHandler handler)
private jakarta.json.JsonObjectBuilder	getHandlers()
java.lang.String[]	getMandatoryParams()	Returns the mandatory parameters.
private jakarta.json.JsonObjectBuilder	getOpenApi()
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()	Returns usage description, for bad requests and documentation.
java.lang.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, 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.

See Also:

Constant Field Values

Constructor Detail

OpenApiHandler

public OpenApiHandler()

Method Detail

handleRequest

protected void handleRequest()

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 class RequestHandler

getOpenApi

private jakarta.json.JsonObjectBuilder getOpenApi()

getHandlers

private jakarta.json.JsonObjectBuilder getHandlers()

getHandler

private jakarta.json.JsonObjectBuilder getHandler(RequestHandler handler)

getDescription

private java.lang.String getDescription(RequestHandler handler)

getUsage

public java.lang.String getUsage()

Description copied from class: RequestHandler

Returns usage description, for bad requests and documentation.

Overrides:

getUsage in class RequestHandler

Returns:

usage description

getUsageExamples

public java.lang.String[] getUsageExamples()

Description copied from class: RequestHandler

Returns usage examples, for bad requests and documentation.

Overrides:

getUsageExamples in class RequestHandler

Returns:

Usage examples

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

getMandatoryParams

public java.lang.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 class RequestHandler

Returns:

the mandatory parameters

validateRequest

protected void validateRequest()

Description copied from class: RequestHandler

Validates the request before attempting to perform it.

Specified by:

validateRequest in class RequestHandler