MapGuide RFC 131 - Deprecate eMap Mapping Service APIs

This page contains a change request (RFC) for the MapGuide Open Source project. More MapGuide RFCs can be found on the RFCs page.

Status

RFC Template Version	(1.0)
Submission Date	7 Feb 2013
Last Modified	7 Feb 2013
Author	Jackie Ng
RFC Status	adopted
Implementation Status	complete
Proposed Milestone	2.5
Assigned PSC guide(s)	(when determined)
Voting History	(vote date)
+1
+0
-0
-1
no vote

Overview

This RFC proposes to deprecate some public Mapping Service APIs related to eMap DWF functionality.

Motivation

MapGuide uses a somewhat ancient version of the DWF Toolkit (7.1). While we are still using this version of the DWF Toolkit, we lack the ability to support DWFx files, 64-bit Linux and possibly fix many DWF-related issues in MapGuide. While putting in a newer DWF Toolkit will solve these problems, it will break our eMap-related Mapping Service APIs as this support has been removed in versions of the DWF Toolkit since 7.1

As such, we should give application developers some heads-up that eMap support will be going away in the future before going ahead with such a move.

While such notice of DWF Viewer/eMap deprecation has been informal (evidenced by the various discussions on the matter on the mailing list), it has never been formalized in the API documentation. This RFC addresses that.

Proposed Solution

Mark the following public APIs as deprecated:

• MgMappingService::GenerateMap
• MgMappingService::GenerateMapUpdate

Due to work on MapGuide RFC 129, doxygen \deprecated markers applied to these methods will transfer down to .net and Java and trigger necessary .net/Java compiler warnings.

If/when we do upgrade our internal copy of the DWF Toolkit, these APIs will have to be removed as they will no longer function.

Implications

This RFC is just an official warning to application developers that eMap support is ending and will be removed in a future release of MapGuide. No actual APIs are removed.

Test Plan

N/A

Funding / Resources

Community