JSAMP Changelog

What's new in JSAMP 1.3-2

Jul 5, 2012

Remove some code which was not compatible with J2S1.4.
Web Profile URL control now controls all URLs not just local ones. All maps passing through the hub connection are now scanned for URLs.
Reduce logging for message send failures, partly by reducing failures themselves.
Hub implements x-samp.query.by-meta MType.
New methods on Hub class to determine whether the hub is running and with what profiles.
Added -subs flag to Snooper tool.
Fixed bug in JSON parser (wouldn't recognise empty objects "{}").
The implementation of MType restrictions for Web Profile clients has been changed. Blocked MTypes are now completely hidden from Web Profile clients. There is still a list of blocked MTypes (ones with known harmless semantics), but subscribing clients may override this, i.e. note MTypes that they subscribe to as known to be either harmless or harmful by annotating the subscription (populating the map value corresponding to the MType key) with a key "x-samp.mostly-harmless" and a value of "1" (harmless) or "0" (harmful).
The Web Profile registration dialogue now reports the apparent URL of the registering client (as determined from the Referer header) if available.

New in JSAMP 1.3-1 (Jul 5, 2012)

New in JSAMP 1.3 (Jul 5, 2012)

Various changes relating to configurable use of profiles and the Web Profile in particular, to match the SAMP 1.3 WD, and to enable experimentation with multi-profile configurations while we gain experience with security options. There is more discussion in the new Profiles page, but the main changes are:
The Web Profile is now available, but not switched on, by default. The Web Profile (and other profiles) can be switched on or off while the hub is running by using the new Profiles menu in the hub window or system tray icon. There is a corresponding new hub command flag -web:extraprofiles and system property jsamp.hub.profiles.extra.
The Profiles menu also has a Web Profile Configuration submenu, which allows fine control over the way the Web Profile is run. This is to permit experimentation with security options; this menu or some of its options may be withdrawn in future versions. There are corresponding flags for the hub command: -web:[no]cors, -web:[no]flash, -web:[no]silverlight, -web:[no]urlcontrol.
The Web Profile hub server now blocks non-localhost requests at the HTTP level. This should benefit security.
The Web Profile URL translation service now by default blocks access to sensitive resources (local filesystem and localhost URLs) if they have not previously been mentioned by a non-Web Profile client. This should benefit security.
Web profile now uses a map argument and not a string argument to register(), as per the change to the Web Profile specification.
Various related changes to the hub implementation and API have been made to enable the above. The recommended entry point, Hub.runHub(), still works though.
The Hub GUI window now has menus:
File menu, which just allows hub shutdown.
Clients menu, which allows pinging and disconnection of clients (this functionality duplicates the existing, but not very obvious, client popup menu).
Profiles menu, as described above.
JSON is now used as the standard serialization/deserialization format for SAMP objects in a few places:
New utility methods toJson and fromJson in SampUtils class.
Non-scalar message parameter contents and client metadata can now be specified to the messagesender and snooper tools on the command line using JSON syntax.
Message display, e.g. in the hub message tracker GUI, are now shown in JSON format. In practice this means you'll see a few more double quotes - it also means they can be cut and pasted directly into other JSON-aware contexts.
Other items:
The ClientProfile.isHubRunning method now probes more agressively for a hub (for instance in the Standard Profile it pings rather than just looking for the .samp file). This is a change to both the API and the implementations.
The Web Profile registration dialogue is now somewhat internationalised. Thanks to Luigi Paioro and Markus Demleitner for providing translations. This can be extended by providing further instances of AuthResourceBundle class or supplying a suitable org.astrogrid.samp.web.AuthResourceBundle_xx.properties resource; run AuthResourceBundle.main() for example output.
The Web Profile hub now fails at start time rather than during registration attempts if Swing client authorization is in use with headless graphics.
More helpful warning message when standard profile lockfile is present but broken (suggests deleting file).
HubMonitor now correctly uses DefaultClientProfile rather than StandardClientProfile.

New in JSAMP 1.2 (Jul 5, 2012)

Hub framework:
The org.astrogrid.samp.hub.HubRunner class has been deprecated in favour of the new class org.astrogrid.samp.hub.Hub. This can be used from the command line or programmatically to start a hub, and it can run zero or more profiles, defined by the new HubProfile interface, simultaneously. HubProfile implementations are provided for the Standard Profile and the Web Profile, and you can plug in your own at runtime. This class is now the Main-Class defined in the jar file's Manifest, so invoking (e.g. clicking or java -jar) the jsamp-*.jar file will now invoke this class. Documentation of the command-line usage is on the Command-line Tools page. By default only the Standard Profile is run, so simply invoking the jar file will have much the same behaviour as it did in previous versions, that is starting a Standard Profile-only hub. Which profiles are run can be influenced in various ways, including by defining the jsamp.hub.profiles system property.
A new "facade" mode of hub operation has been introduced, which allows tunnelling from one hub profile to another (mostly of interest to hub profile implementors).
There have been a number of other backwardly incompatible changes to the hub implementation classes: Most of the HubService interface has been replaced using HubConnection and Receiver has been replaced with CallableClient, reducing amount and duplication of code, and some assumptions specific to the Standard Profile have been removed from the interfaces of hub classes which are properly profile-independent. These changes are not believed likely to affect anybody who is not writing hub implementation code.
Web Profile:
This release also includes client and hub implementations of the experimental Web Profile. Implementation is in the new package org.astrogrid.samp.web. Note that this profile is still under discussion and details of the definition may change in the future.
Bug fixes:
Fixed URI escaping bugs related to "+" characters (new utility methods SampUtils.uriEncode/Decode).
Fixed some concurrency bugs to do with handler lists in HubConnector, HttpServer, InternalServer and ApacheServer (thanks to Laurent Bourgès).
Fixed, I think, threading issues that occasionally prevented hub forced shutdown notifications getting to some clients. It is possible this fix will have knock-on performance or other effects, especially in the presence of badly-behaved clients - please report if you notice problems. Thanks (again) to Laurent Borgès for extensive help with this.
Fixed a bug related to output capture when an external hub is started.
Fixed some not-quite-correct internal HTTP server error responses (405, 400).
Fixed internal HTTP server so it won't reorder request/response headers.
Improved header handling (case-sensitive, duplicated keys) in HttpServer.
Fixed client XML logging bug.
Minor changes and enhancements:
Changed pluggable XML-RPC implementation framework API slightly - handleCall method in SampXmlRpcHandler interface gets an additional argument.
SAMP Version now declares itself as SAMP v1.2 REC.
Some additional system properties are now propagated when starting an external hub.
Window positioning now follows platform norms by default rather than the java policy of placement at (0,0). Specifically: the java.awt.Window.locationByPlatform system property is set, if it does not already have an explicit value, in the JSamp class.
AbstractMessageHandler has a new method createResponse which may be overridden for more flexibility.
External hub start action is disabled in JNLP context, since it won't work.

New in JSAMP 1.1 (Jul 5, 2012)

Protocol extension:
The environment variable SAMP_HUB can now be used to specify a non-default lockfile location for clients and hub to use with the Standard Profile. This usage is expected to be part of the next version of the SAMP standard (SAMP 1.2, in WD at time of writing). See the documentation for the StandardClientProfile class for details, and DefaultClientProfile for a JSAMP-specific extension to this mechanism. The non-standard jsamp.lockfile and jsamp.profile system properties which did the same job in a non-standard way have been withdrawn. This has some backwardly incompatible consequences:
jsamp.lockfile and jsamp.profile system properties withdrawn; use SAMP_HUB environment variable instead.
SampUtils.LOCKFILE_NAME constant withdrawn; use StandardClientProfile.LOCKFILE_NAME instead.
SampUtils.getLockFile() method withdrawn; use StandardClientProfile.getLockUrl() instead. If you want to find out if a hub is running, instead of SampUtils.getLockFile().exists(), use DefaultClientProfile.getProfile().isHubRunning().
LockInfo.readLockFile(File) method withdrawn; use LockInfo.readLockFile(URL) instead.
LockInfo.readLockFile() method withdrawn; use StandardClientProfile.getLockInfo() instead.
LockWriter no-arg constructor withdrawn.
Enhancements:
Where possible, if the hub is running in GUI mode it will now install itself as an icon in the "system tray" rather than posting the window directly; a popup menu associated with the tray icon allows window display and hub shutdown. If the platform does not provide system tray functionality, it will revert to the previous behaviour of posting the window directly. System tray functionality is available only when running under Java 1.6 or later, and only when using a suitable display manager.
Added -httplock flag to hubrunner, which allows publication of lockfile by HTTP for use by non-localhost clients.
Usability:
Invoking JSamp class (e.g. "java -jar jsamp.jar") with no arguments now starts the hub rather than just printing a usage message.
ClientProfile interface has new method isHubRunning. This is more general (and easier to use) than testing something like StandardClientProfile.getLockFile().exists().
HubRunnner.runHub method now returns the running HubRunner instance.
Bugfixes:
Fix error in XML-RPC fault responses (faultCode was string instead of int).
Fix the MessageTracker hub so it doesn't get confused if clients re-use the same tag for different messages.
Adjusted logic of client tracking in HubConnector to be more robust.
Fix bug in outgoing message tooltips for MessageTracker message box.
Fix concurrency issue in HttpServer.
Fix issue which could cause GUI freeze while waiting for remote icons to load.
Catch security exceptions when calling addShutdownHook in XmlRpcHubConnection. It seems that signed applets may not have the appropiate permissions.
Minor improvements:
Command-line tools now use DefaultClientProfile.getProfile() rather than StandardClientProfile.getInstance() as they should (hence will be correctly influenced by SAMP_HUB environment variable).
More tests added to HubTester for correctness of XML-RPC responses.
Be more frugal with DocumentBuilderFactory instances to reduce some unwanted logging.
Improve wait implementation in HubTester to avoid non-yield race conditions.
A warning is now issued if getClientMap is called before declareSubscriptions on a HubConnector, since without declaring subscriptions the client map won't work.

New in JSAMP 1.0 (Jul 5, 2012)

New functionality:
New Bridge client added. This is a significant bit of infrastructure which allows clients on different hubs to interoperate.
Added popup menus to GUI hub views which allow you to ping or forcibly disconnect registered clients.
System property jsamp.server.port provided to allow selection of the default server port.
System property jsamp.lockfile provided to support non-standard lockfile location.
HubConnector now subscribes by default to new client.env.get MType.
Added -clientname and -clientmeta flags to Snooper command-line tool.
You can now set the samp.secret string for HubRunner if you don't want it chosen randomly.
Add some more documentation pages: System Properties, Debugging Aids and Bridge.
The help message now reports relevant system properties as well as other help info.
Changes to behaviour (note some of these may have backward compatibility issues):
The default hostname for HTTP server etc (SampUtils.getLocalHost()) is now "127.0.0.1", not the DNS name; in certain network environments this works better than the alternatives, though it's less good for inter-machine communications. This default can be altered by setting the samp.hostname system property; it has two new special values "[hostname]" and "[hostnumber]".
Icon URLs declared by test clients etc now use internal server references rather than links to external static resources. This means icons are not dependent on network availability.
Clients forcibly disconnected by samp.hub.disconnect now don't try to re-autoconnect themselves.
Remove warning if permission change on .samp file to owner-only read fails. This permission change is probably not possible on Windows-like OSes (unless anyone can tell me different), and the warning causes confusion.
System property samp.localhost renamed to jsamp.localhost (the old name is still recognised for backward compatibility).
Withdraw -xmlrpc flag from command-line tools; the jsamp.xmlrpc.impl system property should be used instead.
Standard version is now reported as v1.11 REC 2009-04-21.
API Changes (note some of these may have backward compatibility issues):
Added DefaultClientProfile class; this is now the recommended way of getting a general purpose ClientProfile object (rather than using StandardClientProfile.getInstance(). Using this will aid pluggability (ability to use with non-standard profiles in the future).
Added UtilServer class; this can help to reduce the number of HTTP servers run by a JSAMP application, and provides convenience methods for exporting local (e.g. file: or classpath) URLs.
Added getHubClient and disconnect methods to BasicHubService; you can now use the hub object to forcibly disconnect clients.
StandardClientProfile now has overridable getLockInfo method for better customisability.
Added parseValue utility method to SampUtils class.
Added new method HubConnector.connectionChanged.
InternalServerFactory now returns a server which can be safely reused.
Class LockInfo moved from org.astrogrid.samp package to org.astrogrid.samp.xmlrpc, which is where it should have been.
Bugfixes:
Missing jsamp.version file now included in source zip archive.
Fixed error reporting bug in messagesender tool.

New in JSAMP 0.3-1 (Jul 5, 2012)

New in JSAMP 0.3 (Jul 5, 2012)

Major New Features:
There is now an option for both hub and client GUI to keep track of and display messages which have been sent. HubRunner and HubMonitor GUIs by default now have tabs showing messages sent/received and their current status - see GUI Features section for some screenshots. To see this in action, start the HubRunner in (default) msg-gui mode and then run HubTester. Or just use the hub with your own SAMP clients. Note that this functionality incurs some overhead - if not used no such overhead is incurred.
A new small GUI component is available which just shows the icons for all registered clients (like what used to appear in the bottom right corner of VODesktop windows).
Facilities have been added for full logging of all XML or RPC communications in the hub or clients. See new xml-log and rpc-log options to -xmlrpc flags of command-line tools, and classes org.astrogrid.samp.xmlrpc.internal.*LoggingInternal*.
Replace DefaultSendActionManager with other, more capable, SendActionManager subclasses. This makes it easy to handle the results from messages which have been sent, for instance by passing the information to the user graphically or in other ways.
HubMonitor tool can now subscribe to messages other than administrative ones, like Snooper.
MessageSender tool now pretty-prints response(s).
Backwards Compatibility:
There have been a number of changes since release 0.2 which are backwardly incompatible, so that source code using earlier versions of JSAMP will need to be adjusted. GUI-related functionality is most affected. This is because I'm still designing it, and some changes were required to accommodate new features etc; sorry. I hope that there will be fewer backwardly incompatible changes in the future as the library matures - but I'm not offering any guarantees just yet. Some of the more obvious changes are as follows:
New class gui.GuiHubConnector now contains the Swing-related functionality which was previously in (its superclass) client.HubConnector, and also all the functionality from the now removed class gui.ConnectorGui.
HubRunner and ConnectorGui APIs modified to permit use of various different hub implementations (with different graphical characteristics - see HubMode).
If there are things which used to work in a previous version and you can't see how to do it now, please contact me and I'll advise how to update.
Bugfixes:
Fixed server error which sometimes resulted in failed reads, especially for long messages.
Fixed error in handling CalcStorm -xmlrpc flag.
Other:
Change return values of callAll and notifyAll hub methods as per agreed modifications to the standard at version 1.1. Affects hub and client API, implementation and test suite.
Default XML-RPC implementation is now Internal rather than Apache.
HubConnector now subscribes to samp.hub.disconnect MType.
Improved performance of internal client when sending long messages.
Add SampUtils.isSampChar() convenience method.
Add public createTag method to HubConnector.
Added test for long messages in HubTester.
HubTester now tests nearly all legal SAMP string characters.
...And some other things not mentioned here.