openPDC Historian Help
MetadataService Class
NamespacesTVA.Historian.ServicesMetadataService

[This is preliminary documentation and is subject to change.]

Represents a REST web service for historian metadata.
Declaration Syntax
C#Visual BasicVisual C++
[ServiceBehaviorAttribute(InstanceContextMode = InstanceContextMode.Single, ConcurrencyMode = ConcurrencyMode.Multiple)]
public class MetadataService : Service, 
	IMetadataService
<ServiceBehaviorAttribute(InstanceContextMode := InstanceContextMode.Single, ConcurrencyMode := ConcurrencyMode.Multiple)> _
Public Class MetadataService _
	Inherits Service _
	Implements IMetadataService
[ServiceBehaviorAttribute(InstanceContextMode = InstanceContextMode::Single, ConcurrencyMode = ConcurrencyMode::Multiple)]
public ref class MetadataService : public Service, 
	IMetadataService
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
MetadataService()()()
Initializes a new instance of the MetadataService class.

Archive
Gets or sets the IArchive used by the web service for its data.
(Inherited from Service.)
CanRead
Gets a boolean value that indicates whether the web service can read Archive data and send it.
(Inherited from Service.)
CanWrite
Gets a boolean value that indicates whether the web service can receive data and write it to Archive.
(Inherited from Service.)
Dispose()()()
Releases all the resources used by the web service.
(Inherited from Service.)
Dispose(Boolean)
Releases the unmanaged resources used by the web service and optionally releases the managed resources.
(Inherited from Service.)
Enabled
Gets or sets a boolean value that indicates whether the web service is currently enabled.
(Inherited from Service.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()
Releases the unmanaged resources before the web service is reclaimed by GC.
(Inherited from Service.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
Initialize()()()
Initializes the web service.
(Inherited from Service.)
LoadSettings()()()
Loads saved web service settings from the config file if the PersistSettings property is set to true.
(Inherited from Service.)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnServiceHostCreated()()()
Raises the ServiceHostCreated event.
(Inherited from Service.)
OnServiceHostStarted()()()
Raises the ServiceHostStarted event.
(Inherited from Service.)
OnServiceProcessError(Exception)
Raises the ServiceProcessError event.
(Inherited from Service.)
PersistSettings
Gets or sets a boolean value that indicates whether the web service settings are to be saved to the config file.
(Inherited from Service.)
ReadAllMetadataAsJson()()()
Reads all metadata from the Archive and sends it in Json format.

ReadAllMetadataAsXml()()()
Reads all metadata from the Archive and sends it in Xml format.

ReadRangeMetadataAsJson(String, String)
Reads a subset of metadata from the Archive and sends it in Json format.

ReadRangeMetadataAsXml(String, String)
Reads a subset of metadata from the Archive and sends it in Xml format.

ReadSelectMetadataAsJson(String)
Reads a subset of metadata from the Archive and sends it in Json format.

ReadSelectMetadataAsXml(String)
Reads a subset of metadata from the Archive and sends it in Xml format.

SaveSettings()()()
Saves web service settings to the config file if the PersistSettings property is set to true.
(Inherited from Service.)
ServiceContract
Gets or sets the contract interface implemented by the web service.
(Inherited from Service.)
ServiceDataFlow
Gets or sets the DataFlowDirection of the web service.
(Inherited from Service.)
ServiceHost
Gets the WebServiceHost hosting the web service.
(Inherited from Service.)
ServiceHostCreated
Occurs when the ServiceHost has been created for the specified ServiceUri.
(Inherited from Service.)
ServiceHostStarted
Occurs when the ServiceHost has can process requests via all of its endpoints.
(Inherited from Service.)
ServiceProcessError
Occurs when an Exception is encountered when processing a request.
(Inherited from Service.)
ServiceUri
Gets or sets the URI where the web service is to be hosted.
(Inherited from Service.)
SettingsCategory
Gets or sets the category under which the web service settings are to be saved to the config file if the PersistSettings property is set to true.
(Inherited from Service.)
ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
WriteMetadataAsJson(SerializableMetadata)
Writes metadata received in Json format to the Archive.

WriteMetadataAsXml(SerializableMetadata)
Writes metadata received in Xml format to the Archive.

Inheritance Hierarchy
Object
Service
 MetadataService
See Also

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.0.0