| | 1 | |
| | 2 | = !MapGuide RFC 131 - Deprecate eMap Mapping Service APIs = |
| | 3 | |
| | 4 | This page contains a change request (RFC) for the !MapGuide Open Source project. |
| | 5 | More !MapGuide RFCs can be found on the [wiki:MapGuideRfcs RFCs] page. |
| | 6 | |
| | 7 | == Status == |
| | 8 | |
| | 9 | ||RFC Template Version||(1.0)|| |
| | 10 | ||Submission Date||7 Feb 2013|| |
| | 11 | ||Last Modified||7 Feb 2013|| |
| | 12 | ||Author||Jackie Ng|| |
| | 13 | ||RFC Status||draft|| |
| | 14 | ||Implementation Status||draft|| |
| | 15 | ||Proposed Milestone||2.5|| |
| | 16 | ||Assigned PSC guide(s)||(when determined)|| |
| | 17 | ||'''Voting History'''||(vote date)|| |
| | 18 | ||+1|||| |
| | 19 | ||+0|||| |
| | 20 | ||-0|||| |
| | 21 | ||-1|||| |
| | 22 | ||no vote|||| |
| | 23 | |
| | 24 | == Overview == |
| | 25 | |
| | 26 | This RFC proposes to deprecate some public Mapping Service APIs related to eMap DWF functionality. |
| | 27 | |
| | 28 | == Motivation == |
| | 29 | |
| | 30 | 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 |
| | 31 | |
| | 32 | 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. |
| | 33 | |
| | 34 | 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. |
| | 35 | |
| | 36 | == Proposed Solution == |
| | 37 | |
| | 38 | Mark the following public APIs as deprecated: |
| | 39 | |
| | 40 | * MgMappingService::GenerateMap |
| | 41 | * MgMappingService::GenerateMapUpdate |
| | 42 | |
| | 43 | Due to work on [wiki:MapGuideRfc129 MapGuide RFC 129], doxygen {{{\deprecated}}} markers applied to these methods will transfer down to .net and Java and trigger necessary .net/Java compiler warnings. |
| | 44 | |
| | 45 | 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. |
| | 46 | |
| | 47 | == Implications == |
| | 48 | |
| | 49 | 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. |
| | 50 | |
| | 51 | == Test Plan == |
| | 52 | |
| | 53 | N/A |
| | 54 | |
| | 55 | == Funding / Resources == |
| | 56 | |
| | 57 | Community |
