Add endpoint description to usage page of remote control

[simon04]

I suggest to improve/rework the remote control part in two ways:

• instead of low-level-re-implementing parts of the HTTP protocol, use com.sun.net.httpserver.HttpServer
• add some usage examples in the code, in order to (hopefully) have all parameters documented, e.g.:

/imagery: adds an imagery layer (e.g. WMS, TMS))
  mandatory parameter: url
  usage examples:
    /imagery?title=...&type={wms|tms|html|bing|scanex}&url=....[&cookies=...][&min_zoom=...][&max_zoom=...]

This patch is meant for the post-stabilization phase and is open for discussion. (Note: the reverter plugin needs some small adoptions as it provides a remote control handler.)

[Don-vip]

Replying to simon04:

• instead of low-level-re-implementing parts of the HTTP protocol, use com.sun.net.httpserver.HttpServer

Is it safe to use this class in com.sun package ?

[simon04]

It's listed in JavaDoc ​http://docs.oracle.com/javase/6/docs/jre/api/net/httpserver/spec/com/sun/net/httpserver/HttpServer.html and also available in OpenJDK (I'm using 1.7.0_09, OpenJDK Runtime Environment (IcedTea7 2.3.3)).

[Don-vip]

Ok.

I did not look in detail but I'm surprised this patch only contains new lines ? Shouldn't it remove the HTTP reimplemented mechanisms you were talking about ?

[simon04]

Right, the files

• source:trunk/src/org/openstreetmap/josm/io/remotecontrol/RemoteControlHttpServer.java​
• source:trunk/src/org/openstreetmap/josm/io/remotecontrol/RequestProcessor.java​

will be deleted.

[Don-vip]

I think we can try this patch :)

[bastiK]

Replying to simon04:

It's listed in JavaDoc ​http://docs.oracle.com/javase/6/docs/jre/api/net/httpserver/spec/com/sun/net/httpserver/HttpServer.html and also available in OpenJDK (I'm using 1.7.0_09, OpenJDK Runtime Environment (IcedTea7 2.3.3)).

Still, the package com.sun.net.httpserver is only present in the Sun based implementations and not part of the official Java API.

If there is a significant advantage, we can live with it at the moment, but it is better avoid these internal classes.

(There have been tries to run JOSM with GNU Classpath and it even works to some extend, but this is just academic exercise at the moment.)

[akks]

In 6091/josm:

see #8612, #8228: remote control - add examples [patch by simon04, parts], add /feature request to detect commands

[akks]

I have added the examples from the patch and wiki, but I am not sure we need descriptions now (there will be many untranslated strings for very specific purpose).

[simon04]

Actually, we don't i18n the remote control usage page at all, do we?

[stoecker]

Replying to simon04:

Actually, we don't i18n the remote control usage page at all, do we?

What do you mean?

[simon04]

Currently, the strings from getUsageAsHtml are not being translated, e.g., "optional parameters". Therefore, we could also show untranslated descriptions …

[simon04]

In 6536/josm:

fix #8228 - remote control: add command description to usage page