MapGuide Developer's Guide. /// /// \todo /// [[Add examples for all these. ]] /// /// \ingroup Resource_Service_classes /// class MgResourceTag { /// \if INTERNAL /// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them. /// \endif /////////////////////////////////////////////////////////// /// \brief /// Replaced with the name of the currently logged in user. /// const LoginUsername = "%MG_LOGIN_USERNAME%"; /// \if INTERNAL \endif /////////////////////////////////////////////////////////////// /// \brief /// Replaced with the password of the currently logged in user. /// const LoginPassword = "%MG_LOGIN_PASSWORD%"; /// \if INTERNAL \endif //////////////////////////////////////////////////////////// /// \brief /// Replaced with the default resource-specific username. /// const Username = "%MG_USERNAME%"; /// \if INTERNAL \endif //////////////////////////////////////////////////////////////// /// \brief /// Replaced with the default resource-specific password. /// const Password = "%MG_PASSWORD%"; /// \if INTERNAL \endif //////////////////////////////////////////////////////////////// /// \brief /// Replaced with the location of data files associated with the /// given resource. The trailing "/" is included. /// const DataFilePath = "%MG_DATA_FILE_PATH%"; /// \if INTERNAL \endif //////////////////////////////////////////////////////////////// /// \brief /// Denotes beginning of data path alias. /// const DataPathAliasBegin = "%MG_DATA_PATH_ALIAS["; /// \if INTERNAL \endif //////////////////////////////////////////////////////////////// /// \brief /// Denotes end of data path alias. /// const DataPathAliasEnd = "]%"; /// \if INTERNAL \endif } /////////////////////////////////////////////////////////////////////////////// /// \brief /// Defines reserved names for resource data. /// /// \ingroup Resource_Service_classes /// class MgResourceDataName { ///////////////////////////////////////////////////////////////// /// \brief /// Data name for adding default credentials to a resource. /// /// \remarks /// For an example, see \link MgResourceService::SetResourceData SetResourceData \endlink. /// const UserCredentials = "MG_USER_CREDENTIALS"; /// \if INTERNAL \endif } /////////////////////////////////////////////////////////////////////////////// /// \brief /// Defines the different types of \link resource_data resource data \endlink. /// /// \remarks /// For more information, see the MapGuide Developer's Guide. /// /// \ingroup Resource_Service_classes /// class MgResourceDataType { /// \if INTERNAL /// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them. /// \endif ///////////////////////////////////////////////////////////////// /// \brief /// Resource data stored as a file on disk. /// /// \remarks /// MapGuide creates a separate directory for each resource /// and stores all resource data files in that directory. The /// directory name can be dynamically substituted into the XML /// resource content using \link MgResourceTag::DataFilePath DataFilePath \endlink. /// \n /// Large files can be uploaded using \link MgResourceService::ApplyResourcePackage ApplyResourcePackage \endlink. /// Web server limitations (timeouts, post message sizes, etc.) /// will typically limit direct HTTP uploads of file resources to /// a few megabytes. /// const File = "File"; /// \if INTERNAL \endif ///////////////////////////////////////////////////////////////// /// \brief /// Stream resource data is stored as a binary stream in the /// repository database. /// /// \remarks /// Streams provide quick access to smaller data sets like symbol /// libraries. They are not intended for data streams larger than /// a few megabytes. Large data sets should be stored as files. /// const Stream = "Stream"; /// \if INTERNAL \endif //////////////////////////////////////////////////////////////// /// \brief /// Resource data is stored as a string. /// /// \remarks /// Strings are typically used for small pieces of text, such as /// credentials to connect to a database. /// const String = "String"; /// \if INTERNAL \endif } /// \endcond /////////////////////////////////////////////////////////////////////////////// /// \brief /// Types of resource permissions. /// /// \ingroup Resource_Service_classes /// class MgResourcePermission { /// \if INTERNAL /// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them. /// \endif /// No Access permission. const NoAccess = "n"; /// \if INTERNAL \endif /// Read-Only permission. const ReadOnly = "r"; /// \if INTERNAL \endif /// Read/Write permission. const ReadWrite = "r,w"; /// \if INTERNAL \endif } /// \defgroup MgPageUnitsType MgPageUnitsType /// \ingroup Mapping_Service_Module /// \{ ///////////////////////////////////////////////////////////////// /// \brief /// Defines page size units for the Mapping Service. /// /// \todo /// * [[TO DO: I should change my examples to use this /// instead of hardcoding the string.]] /// class MgPageUnitsType { /// \if INTERNAL /// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them. /// \endif /// Page units are in inches. const Inches = "in"; /// \if INTERNAL \endif /// Page units are in millimeters. const Millimeters = "mm"; /// \if INTERNAL \endif } /// \} /// \defgroup MgCoordinateSpace MgCoordinateSpace /// \ingroup Mapping_Service_Module /// \{ /////////////////////////////////////////////////////////////////////////////// /// \brief /// Specifies the coordinate space for feature geometry returned from QueryFeatures. /// Can also specify that only non-geometric data should be returned by QueryFeature. /// class MgCoordinateSpace { /// \if INTERNAL /// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them. /// \endif /// \brief /// Specifies that geometry properties should not be returned by QueryFeature. /// const None = "None"; /// \if INTERNAL \endif /// \brief /// Specifies that geometry properties should be returned by QueryFeature in /// the coordinate system space of the map they belong to. /// const Map = "Map"; /// \if INTERNAL \endif /// \brief /// Specifies that geometry properties should be returned by QueryFeature in /// the coordinate system space of the display in the client. /// const Display = "Display"; /// \if INTERNAL \endif } /// \defgroup MgReaderType MgReaderType /// \ingroup Feature_Service_classes /// \{ /////////////////////////////////////////////////////////////// /// \brief /// Type of reader represented by an MgReader /// /// \remarks /// Defines the type of a reader whose class is derived from /// MgReader. The three derived classes are MgDataReader, /// MgFeatureReader, and MgSqlDataReader. An MgReaderType value /// is returned by the reader's GetReaderType method. /// class MgReaderType { ///////////////////////////////////////////////////////// /// Signifies that the object is of type MgFeatureReader. const FeatureReader = 0 ; ////////////////////////////////////////////////////// /// Signifies that the object is of type MgDataReader. const DataReader = 1 ; ///////////////////////////////////////////////////////// /// Signifies that the object is of type MgSqlDataReader. const SqlDataReader = 2 ; } /// \defgroup MgOrderingOption MgOrderingOption /// \ingroup Feature_Service_classes /// \{ ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// \brief /// Defines a type used to specify the order in which features /// are returned by MgFeatureService::SelectFeatures. This type /// is used as an argument to the MgFeatureQueryOptions::SetOrderingFilter. /// class MgOrderingOption { /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// \brief /// Signifies that the features are returned in ascending order /// relative to the properties specified in the first argument of /// MgFeatureQueryOptions::SetOrderingFilter. const Ascending = 0 ; /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// \brief /// Signifies that the features are returned in descending order /// relative to the properties specified in the first argument of /// MgFeatureQueryOptions::SetOrderingFilter. const Descending = 1 ; } /// \defgroup MgObjectPropertyType MgObjectPropertyType /// \ingroup Feature_Schema_Module /// \{ /////////////////////////////////////////////////////////////// /// \brief /// Defines the type of an MgObjectPropertionDefinition object /// property, that is, whether the property ccontains a single /// feature class object, or an unordered or ordered collection /// of them. /// class MgObjectPropertyType { //////////////////////////////////////////////////////////////// /// Signifies that the object property contains a single feature /// class object. const Value = 0 ; ////////////////////////////////////////////////////////////// /// Signifies that the object property contains more than one /// feature class object. The collection of objects is in no /// particular order relative to the identity property defined /// for the collection. See /// MgObjectPropertyDefinition::GetIdentityProperty. const Collection = 1 ; ///////////////////////////////////////////////////////////////// /// Signifies that the object property contains more than one /// feature class object in ascending or descending order /// relative to the identity property defined for the collection. /// See MgObjectPropertyDefinition::GetIdentityProperty. const OrderedCollection = 2 ; } /// \defgroup MgFeatureSpatialOperations MgFeatureSpatialOperations /// \ingroup Feature_Service_classes /// \{ ///////////////////////////////////////////////////////////// /// \brief /// Is a set of constants used to type spatial operations. /// \remarks /// A value from this set of constants is used as an argument /// incalls to MgFeatureQueryOptions::SetSpatialFilter. /// class MgFeatureSpatialOperations { ////////////////////////////////////////////////////////////////////////////////////////////// /// Test whether the geometric property value spatially \link Contains contains \endlink /// the literal geometric value. const Contains = 0 ; ////////////////////////////////////////////////////////////////////////////////// /// Test whether the geometric property value \link Crosses crosses \endlink /// the given geometry. const Crosses = 1 ; /////////////////////////////////////////////////////////////////////// /// Test whether the geometric property value is \link Disjoint disjoint \endlink /// from the given geometry. const Disjoint = 2 ; ////////////////////////////////////////////////////////////////////////////////// /// Test whether the geometric property value is \link Equals equal \endlink /// to the given geometry. const Equals = 3 ; //////////////////////////////////////////////////////////////// /// Test whether the geometric property \link Intersects intersects \endlink /// the given geometry. const Intersects = 4 ; ////////////////////////////////////////////////////////////////////////////// /// Test whether the geometric property \link Overlaps overlaps \endlink /// the given geometry. const Overlaps = 5 ; ///////////////////////////////////////////////////////////////// /// Test whether the geometric property \link Touches touches \endlink the /// given geometry. const Touches = 6 ; ///////////////////////////////////////////////////////////////////////////// /// Test whether the geometric property is \link Within within \endlink /// the given geometry. const Within = 7 ; ////////////////////////////////////////////////////////////////////////////////////////// /// Test whether the geometric property value is \link CoveredBy covered by \endlink /// the given geometry. const CoveredBy = 8 ; ///////////////////////////////////////////////////////////////////////////// /// Test whether the geometric property is \link Inside inside \endlink /// the given geometry. const Inside = 9 ; ////////////////////////////////////////////////////////////////////////////////////////////////////////// /// Test whether the envelope of the geometric property \link EnvelopeIntersects intersects \endlink /// the envelope of the given geometry. const EnvelopeIntersects = 10 ; } /// \defgroup MgFeatureCommandType MgFeatureCommandType /// \ingroup Feature_Service_classes /// \{ ///////////////////////////////////////////////////////// /// \brief /// Is a set of constants used to specify the type of an /// MgFeatureCommand object. /// class MgFeatureCommandType { ///////////////////////////////////////////////////// /// Specifies the type of an MgInsertFeatures object. const InsertFeatures = 0 ; ///////////////////////////////////////////////////// /// Specifies the type of an MgUpdateFeatures object. const UpdateFeatures = 1 ; ///////////////////////////////////////////////////// /// Specifies the type of an MgDeleteFeatures object. const DeleteFeatures = 2 ; ///////////////////////////////////////////////////// /// Specifies the type of an MgLockFeatures object. const LockFeatures = 3 ; ///////////////////////////////////////////////////// /// Specifies the type of an MgUnlockFeatures object. const UnlockFeatures = 4 ; } /// \defgroup MgSpatialContextExtentType MgSpatialContextExtentType /// \ingroup Feature_Service_classes /// \{ ///////////////////////////////////////////////////////////////// /// \brief /// The SpatialContextExtentType enumeration defines how the extent of /// a context should be handled by the provider. class MgSpatialContextExtentType { /// The spatial extent of the context is static and must be specified /// when the context is created. const scStatic = 0 ; /// The spatial extent of the context is dynamic and changes as data is /// added and removed from the context. const scDynamic = 1 ; } /// \cond INTERNAL //////////////////////////////////////////////////////////// /// \brief /// MgGeometryEntityType defines two integer constants which /// signify whether an MgGeometricEntity is a geometry or a /// geometry ciomponent. /// class MgGeometryEntityType { ///////////////////////////////////////////////////////////////// /// \brief /// Specifies that the geometric entity is a geometry component. /// const GeometryComponent = 0 ; /////////////////////////////////////////////////////// /// \brief /// Specifies that the geometric entity is a geometry. /// const Geometry = 1 ; } /// \defgroup MgCoordinateDimension MgCoordinateDimension /// \ingroup Geometry_Module_classes /// \{ /////////////////////////////////////////////////////////////// /// \brief /// MgCoordinateDimension defines a set of integer constants /// which can be OR'd together to specify the dimensionality of /// an MgCoordinate instance. /// class MgCoordinateDimension { ///////////////////////////////////////////////////////// /// \brief /// Specifies that the coordinate has X and Y ordinates. /// /// const XY = 0 ; ///////////////////////////////////////////////////////////// /// \brief /// Specifies that the coordinate has X, Y, and Z ordinates. /// /// const XYZ = 1 ; ///////////////////////////////////////////////////// /// \brief /// Specifies that the coordinate has an M ordinate. /// /// const M = 2 ; } /// \cond INTERNAL /////////////////////////////////////////////////////////////////////////////// /// \brief /// MgGeometricPathInstructionType defines enumerated values used to specify /// the instructions contained in a geometric path. See MgGeometricPathIterator /// for a definition of a geometric path. class MgGeometricPathInstructionType { /////////////////////////////////////////////////////////////////////////// /// \brief /// Defines the beginning coordinate of a new segment in a geometric /// path. /// const MoveTo = 0 ; /////////////////////////////////////////////////////////////////////////// /// \brief /// Defines a straight line from the last coordinate in the geometric /// path to the coordinate included with this instruction. /// const LineTo = 1 ; /////////////////////////////////////////////////////////////////////////// /// \brief /// Defines a quadratic curve from the last coordinate in the geometric /// path using the first coordinate of this instruction as the end point /// and the second coordinate as the control point. /// const QuadTo = 2 ; /////////////////////////////////////////////////////////////////////////// /// \brief /// Defines a line from the current coordinate in the geometric path back /// to the last MgGeometricPathInstruction.MoveTo, which is the beginning /// of the last segment in the path. /// const Close = 4 ; } /// \defgroup MgGeometryType MgGeometryType /// \ingroup Geometry_Module_classes /// \{ //////////////////////////////////////////////////////////////// /// \brief /// MgGeometryType defines integer constants used to signify the /// derived type of an MgGeometry instance. /// class MgGeometryType { //////////////////////////////////////////// /// \brief /// Specifies that the geometry is a Point. /// const Point = 1 ; ///////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a LineString. /// const LineString = 2 ; ////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a Polygon. /// const Polygon = 3 ; ///////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a MultiPoint. /// const MultiPoint = 4 ; ////////////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a MultiLineString. /// const MultiLineString = 5 ; /////////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a MultiPolygon. /// const MultiPolygon = 6 ; ////////////////////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a MultiGeometry. In OpenGIS /// this is referred to as a GeometryCollection. /// const MultiGeometry = 7 ; ////////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a CurveString. /// const CurveString = 10 ; /////////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a CurvePolygon. /// const CurvePolygon = 11 ; ////////////////////////////////////////////////////// /// \brief /// Specifies that the geometry is a MultiLineString. /// const MultiCurveString = 12 ; ////////////////////////////////////////////// /// \brief /// Specifies the geometry is a MultiPolygon. /// const MultiCurvePolygon = 13 ; } /// \defgroup MgGeometryComponentType MgGeometryComponentType /// \ingroup Geometry_Module_classes /// \{ //////////////////////////////////////////////////////////////// /// \brief /// MgGeometryComponentType defines a set of integer constants /// used to signify the type of a geometry component instance. /// /// \remarks /// A /// geometry component instance is used in the construction of a /// geometry. /// class MgGeometryComponentType { //////////////////////////////////////////////////////// /// \brief /// Specifies the geometry component is a MgLinearRing. /// const LinearRing = 129 ; ///////////////////////////////////////////////////////// /// \brief /// Specifies the geometry component is an MgArcSegment. /// const ArcSegment = 130 ; //////////////////////////////////////////////////////////// /// \brief /// Specifies the geometry component is an MgLinearSegment. /// const LinearSegment = 131 ; //////////////////////////////////////////////////////// /// \brief /// Specifies the geometry component is an MgCurveRing. /// const CurveRing = 132 ; } /// \defgroup MgLayerGroupType MgLayerGroupType /// \ingroup Mapping_Service_Module /// \{ //////////////////////////////////////////////////////////////// /// \brief /// MgLayerGroupType defines integer constants used to identify /// the type of a layer group. class MgLayerGroupType { //////////////////////////////////////////// /// \brief /// Specifies that the layer group is a normal layer group. /// const Normal = 1 ; ///////////////////////////////////////////////// /// \brief /// Specifies that the layer is a base map layer group (i.e. /// it contains base map layers). /// const BaseMap = 2 ; } /// \defgroup MgLayerType MgLayerType /// \ingroup Mapping_Service_Module /// \{ //////////////////////////////////////////////////////////////// /// \brief /// MgLayerType defines integer constants used to identify the /// type of a layer. class MgLayerType { //////////////////////////////////////////// /// \brief /// Specifies that the layer is a dynamic layer. /// const Dynamic = 1 ; ///////////////////////////////////////////////// /// \brief /// Specifies that the layer is a base map layer. /// const BaseMap = 2 ; } /// \defgroup MgFeatureGeometricType MgFeatureGeometricType /// \ingroup Feature_Service_classes /// \{ ///////////////////////////////////////////////////////////////// /// \brief /// Is a set of constants specifying the dimensions of geometries /// which can be stored in a geometry property. /// \remarks /// The constants can be bit-wise OR'd together. A value of this /// type is returned by /// MgGeometricPropertyDefinition::GetGeometryTypes. /// class MgFeatureGeometricType { ///////////////////////////////////////////////////////////// /// Represents zero-dimensional geometric primitives, such as /// MgPoint. const Point = 1 ; //////////////////////////////////////////////////////////// /// Represents one-dimensional geometric primitives, such as /// MgLineString and MgCurveString. const Curve = 2 ; //////////////////////////////////////////////////////////// /// Represents two-dimensional geometric primitives, such as /// MgPolygon and MgCurvePolygon. const Surface = 4 ; ////////////////////////////////////////////////////////////// /// Represents three-dimensional geometric primitives, such as /// Cubes. const Solid = 8 ; } /// \cond INTERNAL ////////////////////////////////////////////////////////////////// /// \brief /// Properties stored in an MgConfiguration object. Note that the properties are /// organized into Property Sections. These sections may be used in the API to /// set/get groups of configuration properties. /// INTERNAL_ONLY: class MgConfigProperties { /// Default configuration filenames const DefaultConfigurationFilename = "webconfig.ini"; const ServerConfigurationFilename = "serverconfig.ini"; /////////////////////////////////////////////////////////////////////////// /// Common Configuration Validation Information Maps /// /// GENERAL PROPERTIES SECTION --------------------------------------------------------------------------------------- /// General server properties const GeneralPropertiesSection = "GeneralProperties"; /// Sets the maximum amount of time (in seconds) for connection idle activity before the socket connection is closed const GeneralPropertyConnectionTimeout = "ConnectionTimeout"; const DefaultGeneralPropertyConnectionTimeout = 120; /// Sets the time duration (in seconds) between timeout checks const GeneralPropertyConnectionTimerInterval = "ConnectionTimerInterval"; const DefaultGeneralPropertyConnectionTimerInterval = 60; /// Server's locale const GeneralPropertyLocale = "Locale"; const DefaultGeneralPropertyLocale = ""; /// Server's default message locale const GeneralPropertyDefaultMessageLocale = "DefaultMessageLocale"; const DefaultGeneralPropertyDefaultMessageLocale = "en"; /// Server's display name const GeneralPropertyDisplayName = "DisplayName"; const DefaultGeneralPropertyDisplayName = ""; /// Fdo file path const GeneralPropertyFdoPath = "FdoPath"; const DefaultGeneralPropertyFdoPath = ""; /// Path of the license server const GeneralPropertyLicenseServerPath = "LicenseServerPath"; const DefaultGeneralPropertyLicenseServerPath = ""; /// ; /// Sets the field delimiter in the logs const GeneralPropertyLogsDelimiter = "LogsDelimiter"; const DefaultGeneralPropertyLogsDelimiter = "\t"; /// Root folder for server's log files const GeneralPropertyLogsPath = "LogsPath"; const DefaultGeneralPropertyLogsPath = "Logs/"; /// Sets the Machine IP address const GeneralPropertyMachineIp = "MachineIp"; const DefaultGeneralPropertyMachineIp = "127.0.0.1"; /// Sets the maximum log file size (in kilobytes) const GeneralPropertyMaxLogFileSize = "MaxLogFileSize"; const DefaultGeneralPropertyMaxLogFileSize = 64; /// Specifies whether the maximum log size restriction is enabled const GeneralPropertyMaxLogFileSizeEnabled = "MaxLogFileSizeEnabled"; const DefaultGeneralPropertyMaxLogFileSizeEnabled = false; /// Root folder for server's localization resources const GeneralPropertyResourcesPath = "ResourcesPath"; const DefaultGeneralPropertyResourcesPath = "Resources/"; /// Product serial number const GeneralPropertySerialNumber = "SerialNumber"; const DefaultGeneralPropertySerialNumber = ""; /// ; /// Sets the time duration (in seconds) between service registrations const GeneralPropertyServiceRegistrationTimerInterval = "ServiceRegistrationTimerInterval"; const DefaultGeneralPropertyServiceRegistrationTimerInterval = 60; /// TCP/IP Maximum Transmission Unit const GeneralPropertyTcpIpMtu = "TcpIpMtu"; const DefaultGeneralPropertyTcpIpMtu = 1460; /// Temporary file path const GeneralPropertyTempPath = "TempPath"; const DefaultGeneralPropertyTempPath = "Temp/"; /// Document path location for WFS documents const GeneralPropertyWfsDocumentPath = "WfsDocumentPath"; const DefaultGeneralPropertyWfsDocumentPath = "Wfs/"; /// Document path location for WMS documents const GeneralPropertyWmsDocumentPath = "WmsDocumentPath"; const DefaultGeneralPropertyWmsDocumentPath = "Wms/"; /// ADMINISTRATIVE CONNECTION PROPERTIES SECTION --------------------------------------------------------------------- /// Administrative Connection properties const AdministrativeConnectionPropertiesSection = "AdministrativeConnectionProperties"; /// Administrator's email address const AdministrativeConnectionPropertyEmail = "Email"; const DefaultAdministrativeConnectionPropertyEmail = ""; /// Maximum number of simultaneous administrative connections const AdministrativeConnectionPropertyMaxConnections = "MaxConnections"; const DefaultAdministrativeConnectionPropertyMaxConnections = 20; /// Sets the port on which administrative connections are made const AdministrativeConnectionPropertyPort = "Port"; const DefaultAdministrativeConnectionPropertyPort = 5555; /// Sets the size of the administrative operation queue const AdministrativeConnectionPropertyQueueSize = "QueueSize"; const DefaultAdministrativeConnectionPropertyQueueSize = 10; /// Sets the number of worker threads available for administrative processing const AdministrativeConnectionPropertyThreadPoolSize = "ThreadPoolSize"; const DefaultAdministrativeConnectionPropertyThreadPoolSize = 5; /// CLIENT CONNECTION PROPERTIES SECTION ----------------------------------------------------------------------------- /// Client Connection properties const ClientConnectionPropertiesSection = "ClientConnectionProperties"; /// Maximum number of simultaneous client connections const ClientConnectionPropertyMaxConnections = "MaxConnections"; const DefaultClientConnectionPropertyMaxConnections = 100; /// Sets the port on which client connections are made const ClientConnectionPropertyPort = "Port"; const DefaultClientConnectionPropertyPort = 4444; /// Sets the size of the client operation queue const ClientConnectionPropertyQueueSize = "QueueSize"; const DefaultClientConnectionPropertyQueueSize = 10; /// Sets the number of worker threads available for client processing const ClientConnectionPropertyThreadPoolSize = "ThreadPoolSize"; const DefaultClientConnectionPropertyThreadPoolSize = 10; /// SITE CONNECTION PROPERTIES SECTION ------------------------------------------------------------------------------- /// Site Connection properties const SiteConnectionPropertiesSection = "SiteConnectionProperties"; /// Sets the Site Connection IP address const SiteConnectionPropertyIpAddress = "IpAddress"; const DefaultSiteConnectionPropertyIpAddress = "127.0.0.1"; /// Maximum number of simultaneous site connections const SiteConnectionPropertyMaxConnections = "MaxConnections"; const DefaultSiteConnectionPropertyMaxConnections = 20; /// Sets the port on which site connections are made const SiteConnectionPropertyPort = "Port"; const DefaultSiteConnectionPropertyPort = 3333; /// Sets the size of the site operation queue const SiteConnectionPropertyQueueSize = "QueueSize"; const DefaultSiteConnectionPropertyQueueSize = 10; /// Sets the number of worker threads available for site processing const SiteConnectionPropertyThreadPoolSize = "ThreadPoolSize"; const DefaultSiteConnectionPropertyThreadPoolSize = 5; /// HOST PROPERTIES SECTION ------------------------------------------------------------------------------------------ /// Host properties const HostPropertiesSection = "HostProperties"; /// Enables/disables the Drawing Service. Note that in V1.0 this service is only /// available on the Site Server and must be enabled there. const HostPropertyDrawingService = "DrawingService"; const DefaultHostPropertyDrawingService = false; /// Enables/disables the Feature Service. Note that in V1.0 this service is only /// available on the Site Server and must be enabled there. const HostPropertyFeatureService = "FeatureService"; const DefaultHostPropertyFeatureService = false; /// Enables/disables the Kml Service. const HostPropertyKmlService = "KmlService"; const DefaultHostPropertyKmlService = false; /// Enables/disables the Mapping Service const HostPropertyMappingService = "MappingService"; const DefaultHostPropertyMappingService = false; /// Enables/disables the Rendering Service const HostPropertyRenderingService = "RenderingService"; const DefaultHostPropertyRenderingService = false; /// Enables/disables the Resource Service. Note that in V1.0 this service is only /// available on the Site Server and must be enabled there. const HostPropertyResourceService = "ResourceService"; const DefaultHostPropertyResourceService = false; /// Enables/disables the Site Service. Note that in V1.0 this service is only /// available on the Site Server and must be enabled there. const HostPropertySiteService = "SiteService"; const DefaultHostPropertySiteService = false; /// Enables/disables the Tile Service const HostPropertyTileService = "TileService"; const DefaultHostPropertyTileService = false; /// DRAWING SERVICE PROPERTIES SECTION ------------------------------------------------------------------------------- /// Drawing Service properties. Note that in V1.0 this property section is only defined on the Site Server. const DrawingServicePropertiesSection = "DrawingServiceProperties"; /// FEATURE SERVICE PROPERTIES SECTION ------------------------------------------------------------------------------- /// Feature Service properties. Note that in V1.0 this property section is only defined on the Site Server. const FeatureServicePropertiesSection = "FeatureServiceProperties"; /// Sets the maximum number of internal data objects to cache const FeatureServicePropertyCacheSize = "CacheSize"; const DefaultFeatureServicePropertyCacheSize = 100; /// Sets the maximum amount of time (in seconds) to cache the internal data objects const FeatureServicePropertyCacheTimeLimit = "CacheTimeLimit"; const DefaultFeatureServicePropertyCacheTimeLimit = 86400; /// Sets the time duration (in seconds) between cache timelimit checks const FeatureServicePropertyCacheTimerInterval = "CacheTimerInterval"; const DefaultFeatureServicePropertyCacheTimerInterval = 3600; /// Sets the maximum number of features fetched to reduce the network traffic const FeatureServicePropertyDataCacheSize = "DataCacheSize"; const DefaultFeatureServicePropertyDataCacheSize = 100; /// Sets whether to pool connections const FeatureServicePropertyDataConnectionPoolEnabled = "DataConnectionPoolEnabled"; const DefaultFeatureServicePropertyDataConnectionPoolEnabled = false; /// Sets the excluded privders from the pooled data connections const FeatureServicePropertyDataConnectionPoolExcludedProviders = "DataConnectionPoolExcludedProviders"; const DefaultFeatureServicePropertyDataConnectionPoolExcludedProviders = "OSGeo.SDF,OSGeo.SHP"; /// Sets the number of pooled data connections const FeatureServicePropertyDataConnectionPoolSize = "DataConnectionPoolSize"; const DefaultFeatureServicePropertyDataConnectionPoolSize = 50; /// Sets the number of pooled data connections for a specific provider const FeatureServicePropertyDataConnectionPoolSizeCustom = "DataConnectionPoolSizeCustom"; const DefaultFeatureServicePropertyDataConnectionPoolSizeCustom = ""; /// Sets the maximum amount of time (in seconds) for data connection idle activity before the data connection is closed const FeatureServicePropertyDataConnectionTimeout = "DataConnectionTimeout"; const DefaultFeatureServicePropertyDataConnectionTimeout = 600; /// Sets the time duration (in seconds) between timeout checks const FeatureServicePropertyDataConnectionTimerInterval = "DataConnectionTimerInterval"; const DefaultFeatureServicePropertyDataConnectionTimerInterval = 60; /// Sets the batch size used by the join query algorithm const FeatureServicePropertyJoinQueryBatchSize = "JoinQueryBatchSize"; const DefaultFeatureServicePropertyJoinQueryBatchSize = 100; /// MAPPING SERVICE PROPERTIES SECTION ------------------------------------------------------------------------------- /// Mapping Service properties const MappingServicePropertiesSection = "MappingServiceProperties"; /// Sets the font to use when rendering legend elements const MappingServicePropertyLegendFont = "LegendFont"; const DefaultMappingServicePropertyLegendFont = "Arial"; /// RENDERING SERVICE PROPERTIES SECTION ----------------------------------------------------------------------------- /// Rendering Service properties const RenderingServicePropertiesSection = "RenderingServiceProperties"; /// Sets the maximum request extent offset to use when requesting features for a tile, specified as a factor of the tile size const RenderingServicePropertyTileExtentOffset = "TileExtentOffset"; const DefaultRenderingServicePropertyTileExtentOffset = 0.35; /// FONT ALIASES SECTION ----------------------------------------------------------------------------- /// font alias mappings const FontAliasMappingSection = "FontAliases"; /// unmanaged data mappings const UnmanagedDataMappingsSection = "UnmanagedDataMappings"; /// RESOURCE SERVICE PROPERTIES SECTION ------------------------------------------------------------------------------ /// Resource Service properties. Note that in V1.0 this property section is only defined on the Site Server. const ResourceServicePropertiesSection = "ResourceServiceProperties"; /// Sets the root of the library repository const ResourceServicePropertyLibraryRepositoryPath = "LibraryRepositoryPath"; const DefaultResourceServicePropertyLibraryRepositoryPath = "Repositories/Library/"; /// Sets the root of the library resource data files const ResourceServicePropertyLibraryResourceDataFilePath = "LibraryResourceDataFilePath"; const DefaultResourceServicePropertyLibraryResourceDataFilePath = "Repositories/Library/DataFiles/"; /// Sets the path to resource packages const ResourceServicePropertyPackagesPath = "PackagesPath"; const DefaultResourceServicePropertyPackagesPath = "Packages/"; /// Sets the time duration (in seconds) between repository checkpoints const ResourceServicePropertyRepositoryCheckpointsTimerInterval = "RepositoryCheckpointsTimerInterval"; const DefaultResourceServicePropertyRepositoryCheckpointsTimerInterval = 600; /// Sets the time duration (in seconds) between resource change notifications const ResourceServicePropertyResourceChangeTimerInterval = "ResourceChangeTimerInterval"; const DefaultResourceServicePropertyResourceChangeTimerInterval = 5; /// Sets the trash folder name const ResourceServicePropertyResourceDataFileTrashFolderName = "ResourceDataFileTrashFolderName"; const DefaultResourceServicePropertyResourceDataFileTrashFolderName = "Trash"; /// Sets the maximum number of resources with permission information to be cached const ResourceServicePropertyResourcePermissionCacheSize = "ResourcePermissionCacheSize"; const DefaultResourceServicePropertyResourcePermissionCacheSize = 1000; /// Sets the path to all resource schema files const ResourceServicePropertyResourceSchemaFilePath = "ResourceSchemaFilePath"; const DefaultResourceServicePropertyResourceSchemaFilePath = "Schema/"; /// Sets the root of the session repository const ResourceServicePropertySessionRepositoryPath = "SessionRepositoryPath"; const DefaultResourceServicePropertySessionRepositoryPath = "Repositories/Session/"; /// Sets the root of the session resource data files const ResourceServicePropertySessionResourceDataFilePath = "SessionResourceDataFilePath"; const DefaultResourceServicePropertySessionResourceDataFilePath = "Repositories/Session/DataFiles/"; /// Sets the root of the site repository const ResourceServicePropertySiteRepositoryPath = "SiteRepositoryPath"; const DefaultResourceServicePropertySiteRepositoryPath = "Repositories/Site/"; /// SITE SERVICE PROPERTIES SECTION ---------------------------------------------------------------------------------- /// Site Service properties. Note that in V1.0 this property section is only defined on the Site Server. const SiteServicePropertiesSection = "SiteServiceProperties"; /// Sets the maximum amount of time (in seconds) for session timeout const SiteServicePropertySessionTimeout = "SessionTimeout"; const DefaultSiteServicePropertySessionTimeout = 1200; /// Sets the time duration (in seconds) between session timeout checks const SiteServicePropertySessionTimerInterval = "SessionTimerInterval"; const DefaultSiteServicePropertySessionTimerInterval = 400; /// TILE SERVICE PROPERTIES SECTION ---------------------------------------------------------------------------------- /// Tile Service properties const TileServicePropertiesSection = "TileServiceProperties"; /// Specifies whether the tile is only rendered const TileServicePropertyRenderOnly = "RenderOnly"; const DefaultTileServicePropertyRenderOnly = false; /// Sets the root of the image tile cache const TileServicePropertyTileCachePath = "TileCachePath"; const DefaultTileServicePropertyTileCachePath = "Repositories/TileCache/"; const TileServicePropertyTileColumnsPerFolder = "TileColumnsPerFolder"; const DefaultTileServicePropertyTileColumnsPerFolder = 30; const TileServicePropertyTileRowsPerFolder = "TileRowsPerFolder"; const DefaultTileServicePropertyTileRowsPerFolder = 30; const TileServicePropertyTileSizeX = "DefaultTileSizeX"; /// ; const DefaultTileServicePropertyTileSizeX = 300; /// ; const TileServicePropertyTileSizeY = "DefaultTileSizeY"; /// ; const DefaultTileServicePropertyTileSizeY = 300; /// ; const TileServicePropertyImageFormat = "ImageFormat"; const DefaultTileServicePropertyImageFormat = "PNG"; ////////////////////////////////////////////////////////////////// /// \brief /// The remaining properties are log properties. For each type of log, there is a "Parameters" property. /// These parameters may be used to customize a log and are listed below. Note that not /// all of the parameters may be used with a particular log. See the list of valid /// parameters for each log type below. The Parameters string is a list of /// comma-delimited parameter names. Each log type has a different set of possible /// parameters. /// ///
Parameter | ///Description | ///
---|---|
ALL | ///Activates all valid parameters for log. | ///
AKEY | ///Access Key used by the map layer. | ///
CLIENT | ///The client and version that generated the request. | ///
CLIENTID | ///A unique identifier for the client computer that generated the request. | ///
DATASRC | ///Data source name. | ///
ITEM | ///The type of request | ///
LYRTYPE | ///Layer Type. | ///
MLNAME | ///Map layer name. | ///
MWIN | ///A composite item that generates entries for MWFURL, XMIN, YMIN, XMAX, and YMAX. | ///
MWFURL | ///The URL of the map that generated the request. | ///
NLAYER | ///The number of layers in the request. | ///
NSCALOG | ///A composite item that generates several entries that conform to the NCSA/CERN log file standard. | ///
PASSWORD | ///Password used by the map layer. | ///
PREC | ///A number that indicates map data precision. | ///
REQID | ///The request identification number. | ///
REQTIME | ///Time taken to process the request in seconds. | ///
SCALE | ///The current scale. | ///
TABLE | ///Feature table name used by the map layer. | ///
TRACKID | ///Customer tracking ID. | ///
USER | ///User ID used by this map layer. | ///
XMAX | ///The maximum X value of the area covered by the request. | ///
YMAX | ///The maximum Y value of the area covered by the request. | ///
XMIN | ///The minimum X value of the area covered by the request. | ///
YMIN | ///The minimum Y value of the area covered by the request. | ///