[mapguide-commits] r8273 - in sandbox/jng/convenience_apis: Common/PlatformBase/Services UnitTest/WebTier/DotNet/TestMapGuideApi UnitTest/WebTier/DotNet/TestMapGuideApi/ExternalTests UnitTest/WebTier/DotNet/TestMapGuideApi/Properties UnitTest/WebTier/DotNet/TestMapGuideApi/Resources Web/src/DotNetUnmanagedApi/PlatformBase Web/src/MapGuideApi
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Wed Jul 2 01:56:54 PDT 2014
Author: jng
Date: 2014-07-02 01:56:54 -0700 (Wed, 02 Jul 2014)
New Revision: 8273
Added:
sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Properties/Resources.Designer.cs
sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Properties/Resources.resx
sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Resources/
sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Resources/ResourceHeaderTemplate.txt
Modified:
sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceDefs.h
sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceService.h
sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/ExternalTests/ResourceServiceTests.cs
sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/TestMapGuideApi.csproj
sandbox/jng/convenience_apis/Web/src/DotNetUnmanagedApi/PlatformBase/PlatformBaseConstants.xml
sandbox/jng/convenience_apis/Web/src/MapGuideApi/Constants.xml
Log:
Promote MgResourceService.EnumerateResourceDocuments to EXTERNAL_API. Expose the MgResourceHeaderProperties constant class also as EXTERNAL_API. This API has value for applications that want to embed application-specific metadata to their resource headers and be able to query for this information in a repository-wide manner.
Add a .net test to exercise this API.
Modified: sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceDefs.h
===================================================================
--- sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceDefs.h 2014-07-01 13:31:10 UTC (rev 8272)
+++ sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceDefs.h 2014-07-02 08:56:54 UTC (rev 8273)
@@ -532,10 +532,10 @@
///
class MG_PLATFORMBASE_API MgResourceHeaderProperties
{
-INTERNAL_API:
- static const INT32 General = 0x00000001;
- static const INT32 Security = 0x00000002;
- static const INT32 Metadata = 0x00000004;
+EXTERNAL_API:
+ static const INT32 General = 1;
+ static const INT32 Security = 2;
+ static const INT32 Metadata = 4;
};
/// \endcond
Modified: sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceService.h
===================================================================
--- sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceService.h 2014-07-01 13:31:10 UTC (rev 8272)
+++ sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceService.h 2014-07-02 08:56:54 UTC (rev 8273)
@@ -1710,6 +1710,35 @@
/// \since 1.2
virtual MgByteReader* EnumerateUnmanagedData(CREFSTRING path, bool recursive, CREFSTRING type, CREFSTRING filter);
+ ///////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Enumerate the resource documents in the specified repository.
+ ///
+ /// \remarks
+ /// This method only works on "Library".
+ ///
+ /// \param resources
+ /// Resource identifiers specifying the resources to enumerate.
+ /// \n If it is null or contains no resource, then the type must be specified.
+ /// \n If it is not null and contains some resource, then the type will be ignored.
+ /// \param type
+ /// Type of the resource to be enumerated. See MgResourceType for valid types.
+ /// No folder type is allowed.
+ /// \param properties
+ /// Flag to specify which properties of the resource header should be filtered.
+ /// It may be set to 0 or by bitwise inclusively OR'ing together one or
+ /// more of the MgResourceHeaderProperties values.
+ ///
+ /// \return
+ /// Returns a string containing a description of the WMS layer definitions
+ /// in XML format using the \link ResourceList_schema ResourceList \endlink
+ /// schema.
+ ///
+ /// \exception MgInvalidResourceTypeException
+ ///
+ virtual STRING EnumerateResourceDocuments(MgStringCollection* resources,
+ CREFSTRING type, INT32 properties);
+
INTERNAL_API:
///////////////////////////////////////////////////////////////////////////
/// \brief
@@ -1773,35 +1802,6 @@
///////////////////////////////////////////////////////////////////////////
/// \brief
- /// Enumerate the resource documents in the specified repository.
- ///
- /// \remarks
- /// This method only works on "Library".
- ///
- /// \param resources
- /// Resource identifiers specifying the resources to enumerate.
- /// \n If it is null or contains no resource, then the type must be specified.
- /// \n If it is not null and contains some resource, then the type will be ignored.
- /// \param type
- /// Type of the resource to be enumerated. See MgResourceType for valid types.
- /// No folder type is allowed.
- /// \param properties
- /// Flag to specify which properties of the resource header should be filtered.
- /// It may be set to 0 or by bitwise inclusively OR'ing together one or
- /// more of the MgResourceHeaderProperties values.
- ///
- /// \return
- /// Returns a string containing a description of the WMS layer definitions
- /// in XML format using the \link ResourceList_schema ResourceList \endlink
- /// schema.
- ///
- /// \exception MgInvalidResourceTypeException
- ///
- virtual STRING EnumerateResourceDocuments(MgStringCollection* resources,
- CREFSTRING type, INT32 properties);
-
- ///////////////////////////////////////////////////////////////////////////
- /// \brief
/// Gets the content of the specified resource.
///
/// \param resource
Modified: sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/ExternalTests/ResourceServiceTests.cs
===================================================================
--- sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/ExternalTests/ResourceServiceTests.cs 2014-07-01 13:31:10 UTC (rev 8272)
+++ sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/ExternalTests/ResourceServiceTests.cs 2014-07-02 08:56:54 UTC (rev 8273)
@@ -2,6 +2,7 @@
using OSGeo.MapGuide.Test.Common.ExternalTests;
using System;
using System.Collections.Generic;
+using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
@@ -9,6 +10,41 @@
namespace OSGeo.MapGuide.Test.Web.ExternalTests
{
+ public class ResourceMetadataTest : IExternalTest
+ {
+ public void Execute(IPlatformFactory factory, ITestLogger logger)
+ {
+ var resSvc = (MgResourceService)factory.CreateService(MgServiceType.ResourceService);
+ var featSvc = (MgFeatureService)factory.CreateService(MgServiceType.FeatureService);
+ var fsId = new MgResourceIdentifier("Library://UnitTests/Data/Metadata.FeatureSource");
+ try
+ {
+ if (resSvc.ResourceExists(fsId))
+ resSvc.DeleteResource(fsId);
+
+ string metadata = resSvc.EnumerateResourceDocuments(null, MgResourceType.FeatureSource, MgResourceHeaderProperties.Metadata);
+ File.WriteAllText("metadata.txt", metadata);
+
+ string className = FeatureServiceTestUtil.CreateTestDataStore(fsId, "OSGeo.SDF", featSvc);
+ string headerXml = string.Format(Properties.Resources.ResourceHeaderTemplate, "Foo", "Bar");
+ var bytes = Encoding.UTF8.GetBytes(headerXml);
+ var source = new MgByteSource(bytes, bytes.Length);
+ var rdr = source.GetReader();
+
+ resSvc.SetResource(fsId, null, rdr);
+ string metadata2 = resSvc.EnumerateResourceDocuments(null, MgResourceType.FeatureSource, MgResourceHeaderProperties.Metadata);
+ File.WriteAllText("metadata2.txt", metadata2);
+
+ Assert.IsFalse(metadata == metadata2);
+ }
+ finally
+ {
+ if (resSvc.ResourceExists(fsId))
+ resSvc.DeleteResource(fsId);
+ }
+ }
+ }
+
public class ResourceModifiedTest : IExternalTest
{
public void Execute(IPlatformFactory factory, ITestLogger logger)
Added: sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Properties/Resources.Designer.cs
===================================================================
--- sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Properties/Resources.Designer.cs (rev 0)
+++ sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Properties/Resources.Designer.cs 2014-07-02 08:56:54 UTC (rev 8273)
@@ -0,0 +1,85 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+// This code was generated by a tool.
+// Runtime Version:4.0.30319.18444
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+
+namespace OSGeo.MapGuide.Test.Web.Properties {
+ using System;
+
+
+ /// <summary>
+ /// A strongly-typed resource class, for looking up localized strings, etc.
+ /// </summary>
+ // This class was auto-generated by the StronglyTypedResourceBuilder
+ // class via a tool like ResGen or Visual Studio.
+ // To add or remove a member, edit your .ResX file then rerun ResGen
+ // with the /str option, or rebuild your VS project.
+ [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "4.0.0.0")]
+ [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
+ [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
+ internal class Resources {
+
+ private static global::System.Resources.ResourceManager resourceMan;
+
+ private static global::System.Globalization.CultureInfo resourceCulture;
+
+ [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
+ internal Resources() {
+ }
+
+ /// <summary>
+ /// Returns the cached ResourceManager instance used by this class.
+ /// </summary>
+ [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]
+ internal static global::System.Resources.ResourceManager ResourceManager {
+ get {
+ if (object.ReferenceEquals(resourceMan, null)) {
+ global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("OSGeo.MapGuide.Test.Web.Properties.Resources", typeof(Resources).Assembly);
+ resourceMan = temp;
+ }
+ return resourceMan;
+ }
+ }
+
+ /// <summary>
+ /// Overrides the current thread's CurrentUICulture property for all
+ /// resource lookups using this strongly typed resource class.
+ /// </summary>
+ [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]
+ internal static global::System.Globalization.CultureInfo Culture {
+ get {
+ return resourceCulture;
+ }
+ set {
+ resourceCulture = value;
+ }
+ }
+
+ /// <summary>
+ /// Looks up a localized string similar to <?xml version="1.0"?>
+ ///<ResourceDocumentHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:noNamespaceSchemaLocation="ResourceDocumentHeader-1.0.0.xsd">
+ /// <Security>
+ /// <Inherited>true</Inherited>
+ /// </Security>
+ /// <Metadata>
+ /// <Simple>
+ /// <Property>
+ /// <Name>{0}</Name>
+ /// <Value>{1}</Value>
+ /// </Property>
+ /// </Simple>
+ /// </Metadata>
+ ///</ResourceDocumentHeader>.
+ /// </summary>
+ internal static string ResourceHeaderTemplate {
+ get {
+ return ResourceManager.GetString("ResourceHeaderTemplate", resourceCulture);
+ }
+ }
+ }
+}
Added: sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Properties/Resources.resx
===================================================================
--- sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Properties/Resources.resx (rev 0)
+++ sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Properties/Resources.resx 2014-07-02 08:56:54 UTC (rev 8273)
@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+ <!--
+ Microsoft ResX Schema
+
+ Version 2.0
+
+ The primary goals of this format is to allow a simple XML format
+ that is mostly human readable. The generation and parsing of the
+ various data types are done through the TypeConverter classes
+ associated with the data types.
+
+ Example:
+
+ ... ado.net/XML headers & schema ...
+ <resheader name="resmimetype">text/microsoft-resx</resheader>
+ <resheader name="version">2.0</resheader>
+ <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+ <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+ <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+ <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+ <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+ <value>[base64 mime encoded serialized .NET Framework object]</value>
+ </data>
+ <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+ <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+ <comment>This is a comment</comment>
+ </data>
+
+ There are any number of "resheader" rows that contain simple
+ name/value pairs.
+
+ Each data row contains a name, and value. The row also contains a
+ type or mimetype. Type corresponds to a .NET class that support
+ text/value conversion through the TypeConverter architecture.
+ Classes that don't support this are serialized and stored with the
+ mimetype set.
+
+ The mimetype is used for serialized objects, and tells the
+ ResXResourceReader how to depersist the object. This is currently not
+ extensible. For a given mimetype the value must be set accordingly:
+
+ Note - application/x-microsoft.net.object.binary.base64 is the format
+ that the ResXResourceWriter will generate, however the reader can
+ read any of the formats listed below.
+
+ mimetype: application/x-microsoft.net.object.binary.base64
+ value : The object must be serialized with
+ : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+ : and then encoded with base64 encoding.
+
+ mimetype: application/x-microsoft.net.object.soap.base64
+ value : The object must be serialized with
+ : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+ : and then encoded with base64 encoding.
+
+ mimetype: application/x-microsoft.net.object.bytearray.base64
+ value : The object must be serialized into a byte array
+ : using a System.ComponentModel.TypeConverter
+ : and then encoded with base64 encoding.
+ -->
+ <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+ <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
+ <xsd:element name="root" msdata:IsDataSet="true">
+ <xsd:complexType>
+ <xsd:choice maxOccurs="unbounded">
+ <xsd:element name="metadata">
+ <xsd:complexType>
+ <xsd:sequence>
+ <xsd:element name="value" type="xsd:string" minOccurs="0" />
+ </xsd:sequence>
+ <xsd:attribute name="name" use="required" type="xsd:string" />
+ <xsd:attribute name="type" type="xsd:string" />
+ <xsd:attribute name="mimetype" type="xsd:string" />
+ <xsd:attribute ref="xml:space" />
+ </xsd:complexType>
+ </xsd:element>
+ <xsd:element name="assembly">
+ <xsd:complexType>
+ <xsd:attribute name="alias" type="xsd:string" />
+ <xsd:attribute name="name" type="xsd:string" />
+ </xsd:complexType>
+ </xsd:element>
+ <xsd:element name="data">
+ <xsd:complexType>
+ <xsd:sequence>
+ <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+ <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+ </xsd:sequence>
+ <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+ <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+ <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+ <xsd:attribute ref="xml:space" />
+ </xsd:complexType>
+ </xsd:element>
+ <xsd:element name="resheader">
+ <xsd:complexType>
+ <xsd:sequence>
+ <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+ </xsd:sequence>
+ <xsd:attribute name="name" type="xsd:string" use="required" />
+ </xsd:complexType>
+ </xsd:element>
+ </xsd:choice>
+ </xsd:complexType>
+ </xsd:element>
+ </xsd:schema>
+ <resheader name="resmimetype">
+ <value>text/microsoft-resx</value>
+ </resheader>
+ <resheader name="version">
+ <value>2.0</value>
+ </resheader>
+ <resheader name="reader">
+ <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+ </resheader>
+ <resheader name="writer">
+ <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+ </resheader>
+ <assembly alias="System.Windows.Forms" name="System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
+ <data name="ResourceHeaderTemplate" type="System.Resources.ResXFileRef, System.Windows.Forms">
+ <value>..\Resources\ResourceHeaderTemplate.txt;System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;Windows-1252</value>
+ </data>
+</root>
\ No newline at end of file
Added: sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Resources/ResourceHeaderTemplate.txt
===================================================================
--- sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Resources/ResourceHeaderTemplate.txt (rev 0)
+++ sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/Resources/ResourceHeaderTemplate.txt 2014-07-02 08:56:54 UTC (rev 8273)
@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<ResourceDocumentHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:noNamespaceSchemaLocation="ResourceDocumentHeader-1.0.0.xsd">
+ <Security>
+ <Inherited>true</Inherited>
+ </Security>
+ <Metadata>
+ <Simple>
+ <Property>
+ <Name>{0}</Name>
+ <Value>{1}</Value>
+ </Property>
+ </Simple>
+ </Metadata>
+</ResourceDocumentHeader>
\ No newline at end of file
Modified: sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/TestMapGuideApi.csproj
===================================================================
--- sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/TestMapGuideApi.csproj 2014-07-01 13:31:10 UTC (rev 8272)
+++ sandbox/jng/convenience_apis/UnitTest/WebTier/DotNet/TestMapGuideApi/TestMapGuideApi.csproj 2014-07-02 08:56:54 UTC (rev 8273)
@@ -85,6 +85,11 @@
<Compile Include="MappingService\MappingServiceOperationExecutor.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="MapGuideTestExecutorCollection.cs" />
+ <Compile Include="Properties\Resources.Designer.cs">
+ <AutoGen>True</AutoGen>
+ <DesignTime>True</DesignTime>
+ <DependentUpon>Resources.resx</DependentUpon>
+ </Compile>
<Compile Include="RenderingService\RenderingServiceOperationExecutor.cs" />
<Compile Include="ServerAdmin\Operations.cs" />
<Compile Include="ServerAdmin\ServerAdminOperationExecutor.cs" />
@@ -99,7 +104,15 @@
<Name>TestCommon</Name>
</ProjectReference>
</ItemGroup>
- <ItemGroup />
+ <ItemGroup>
+ <EmbeddedResource Include="Properties\Resources.resx">
+ <Generator>ResXFileCodeGenerator</Generator>
+ <LastGenOutput>Resources.Designer.cs</LastGenOutput>
+ </EmbeddedResource>
+ </ItemGroup>
+ <ItemGroup>
+ <None Include="Resources\ResourceHeaderTemplate.txt" />
+ </ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<PropertyGroup>
<PreBuildEvent>call "$(SolutionDir)prebuild.bat" "$(ConfigurationName)" "$(PlatformName)"</PreBuildEvent>
Modified: sandbox/jng/convenience_apis/Web/src/DotNetUnmanagedApi/PlatformBase/PlatformBaseConstants.xml
===================================================================
--- sandbox/jng/convenience_apis/Web/src/DotNetUnmanagedApi/PlatformBase/PlatformBaseConstants.xml 2014-07-01 13:31:10 UTC (rev 8272)
+++ sandbox/jng/convenience_apis/Web/src/DotNetUnmanagedApi/PlatformBase/PlatformBaseConstants.xml 2014-07-02 08:56:54 UTC (rev 8273)
@@ -72,6 +72,7 @@
<Class name="MgResourceDataName" />
<Class name="MgResourceDataType" />
<Class name="MgResourcePermission" />
+ <Class name="MgResourceHeaderProperties" />
<Class name="MgLayerGroupType" />
<Class name="MgLayerType" />
<Class name="MgFeatureGeometricType" />
Modified: sandbox/jng/convenience_apis/Web/src/MapGuideApi/Constants.xml
===================================================================
--- sandbox/jng/convenience_apis/Web/src/MapGuideApi/Constants.xml 2014-07-01 13:31:10 UTC (rev 8272)
+++ sandbox/jng/convenience_apis/Web/src/MapGuideApi/Constants.xml 2014-07-02 08:56:54 UTC (rev 8273)
@@ -75,6 +75,7 @@
<Class name="MgResourceDataName" />
<Class name="MgResourceDataType" />
<Class name="MgResourcePermission" />
+ <Class name="MgResourceHeaderProperties" />
<Class name="MgMimeType" />
<Class name="MgPropertyType" />
<Class name="MgPageUnitsType" />
More information about the mapguide-commits
mailing list