|
Rest
|
Represents a provider of data to a MetadataFile from a REST (Representational State Transfer) web service.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
GSF.AdaptersAdapter
GSF.Historian.MetadataProvidersMetadataProviderBase
GSF.Historian.MetadataProvidersRestWebServiceMetadataProvider
SystemMarshalByRefObject
GSF.AdaptersAdapter
GSF.Historian.MetadataProvidersMetadataProviderBase
GSF.Historian.MetadataProvidersRestWebServiceMetadataProvider
Namespace: GSF.Historian.MetadataProviders
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.218-beta
Syntaxpublic class RestWebServiceMetadataProvider : MetadataProviderBase
The RestWebServiceMetadataProvider type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RestWebServiceMetadataProvider | Initializes a new instance of the RestWebServiceMetadataProvider class. |
Properties| Name | Description | |
|---|---|---|
 | Domain |
Gets the AppDomain in which the Adapter is executing.
(Inherited from Adapter) |
| Enabled |
Gets or sets a boolean value that indicates whether the Adapter is currently enabled.
(Inherited from Adapter) |
| HostFile |
Gets or sets the path to the file where the Adapter is housed.
(Inherited from Adapter) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from Adapter) |
| MemoryUsage |
Gets the memory utilization of the Adapter in bytes if executing in a separate AppDomain, otherwise NaN.
(Inherited from Adapter) |
| Metadata |
Gets or sets the MetadataFile to be refreshed by the metadata provider.
(Inherited from MetadataProviderBase) |
| Name |
Gets the unique identifier of the Adapter.
(Inherited from Adapter) |
| PersistSettings |
Gets or sets a boolean value that indicates whether Adapter settings are to be saved to the config file.
(Inherited from Adapter) |
| ProcessorUsage |
Gets the % processor utilization of the Adapter if executing in a separate AppDomain otherwise NaN.
(Inherited from Adapter) |
| RefreshInterval |
Gets or sets the interval in minutes at which the Metadata if to be refreshed automatically.
(Inherited from MetadataProviderBase) |
| RefreshTimeout |
Gets or sets the number of seconds to wait for the Refresh to complete.
(Inherited from MetadataProviderBase) |
| ServiceDataFormat | Gets or sets the SerializationFormat in which the REST web service exposes the data. |
| ServiceUri | Gets or sets the URI where the REST web service is hosted. |
| SettingsCategory |
Gets or sets the category under which Adapter settings are to be saved to the config file if the PersistSettings property is set to true.
(Inherited from Adapter) |
| Status |
Gets the descriptive status of the Adapter.
(Inherited from Adapter) |
| TypeName |
Gets or sets the text representation of the Adapter's TypeName.
(Inherited from Adapter) |
Methods| Name | Description | |
|---|---|---|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| Dispose |
Releases all the resources used by the Adapter.
(Inherited from Adapter) |
 | Dispose(Boolean) |
Releases the unmanaged resources used by the metadata provider and optionally releases the managed resources.
(Inherited from MetadataProviderBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the Adapter is reclaimed by GC.
(Inherited from Adapter) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
Initializes the metadata provider.
(Inherited from MetadataProviderBase) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| LoadSettings |
Loads saved RestWebServiceMetadataProvider settings from the config file if the PersistSettings property is set to true.
(Overrides MetadataProviderBaseLoadSettings) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| OnDisposed |
Raises the Disposed event.
(Inherited from Adapter) |
| OnExecutionException |
Raises the ExecutionException event.
(Inherited from Adapter) |
| OnMetadataRefreshComplete |
Raises the MetadataRefreshComplete event.
(Inherited from MetadataProviderBase) |
| OnMetadataRefreshException |
Raises the MetadataRefreshException event.
(Inherited from MetadataProviderBase) |
| OnMetadataRefreshStart |
Raises the MetadataRefreshStart event.
(Inherited from MetadataProviderBase) |
| OnMetadataRefreshTimeout |
Raises the MetadataRefreshTimeout event.
(Inherited from MetadataProviderBase) |
| OnStatusUpdate |
Raises the StatusUpdate event.
(Inherited from Adapter) |
| Refresh |
Refreshes the Metadata from an external source.
(Inherited from MetadataProviderBase) |
| RefreshMetadata |
Refreshes the Metadata from a REST web service.
(Overrides MetadataProviderBaseRefreshMetadata) |
| SaveSettings |
Saves RestWebServiceMetadataProvider settings to the config file if the PersistSettings property is set to true.
(Overrides MetadataProviderBaseSaveSettings) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | Disposed |
Occurs when Adapter is disposed.
(Inherited from Adapter) |
| ExecutionException |
Occurs when the IAdapter encounters an Exception during execution.
(Inherited from Adapter) |
| MetadataRefreshComplete |
Occurs when Refresh of Metadata is completed.
(Inherited from MetadataProviderBase) |
| MetadataRefreshException |
Occurs when an Exception is encountered during Refresh of Metadata.
(Inherited from MetadataProviderBase) |
| MetadataRefreshStart |
Occurs when Refresh of Metadata is started.
(Inherited from MetadataProviderBase) |
| MetadataRefreshTimeout |
Occurs when Refresh of Metadata times out.
(Inherited from MetadataProviderBase) |
| StatusUpdate |
Occurs when the Adapter wants to provide a status update.
(Inherited from Adapter) |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
See Also