DataService Class

A base class for web service that can send and receive historian data over REST (Representational State Transfer) interface.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    GSF.AdaptersAdapter
      GSF.ServiceModelSelfHostingService
        GSF.Historian.DataServicesDataService
          GSF.Historian.DataServicesMetadataService
          GSF.Historian.DataServicesTimeSeriesDataService

Namespace: GSF.Historian.DataServices
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public class DataService : SelfHostingService, 
	IDataService, ISelfHostingService, IAdapter, ISupportLifecycle, IDisposable, 
	IProvideStatus, IPersistSettings

Public Class DataService
	Inherits SelfHostingService
	Implements IDataService, ISelfHostingService, IAdapter, ISupportLifecycle, 
	IDisposable, IProvideStatus, IPersistSettings

public ref class DataService : public SelfHostingService, 
	IDataService, ISelfHostingService, IAdapter, ISupportLifecycle, IDisposable, 
	IProvideStatus, IPersistSettings

type DataService = 
    class
        inherit SelfHostingService
        interface IDataService
        interface ISelfHostingService
        interface IAdapter
        interface ISupportLifecycle
        interface IDisposable
        interface IProvideStatus
        interface IPersistSettings
    end

GSF.Historian.DataServices.DataService = function();

Type.createClass(
	'GSF.Historian.DataServices.DataService',
	GSF.ServiceModel.SelfHostingService,
	GSF.Historian.DataServices.IDataService,
	GSF.ServiceModel.ISelfHostingService,
	GSF.Adapters.IAdapter,
	GSF.ISupportLifecycle,
	IDisposable,
	GSF.IProvideStatus,
	GSF.Configuration.IPersistSettings);

View Source

The DataService type exposes the following members.

Constructors

	Name	Description
	DataService	Initializes a new instance of historian data web service.

Top

Properties

	Name	Description
	AllowCrossDomainAccess	Gets or sets flag that indicates if web services will enable cross-domain access for Silverlight and Flash applications. (Inherited from SelfHostingService)
	AllowedDomainList	Gets or sets comma separated list of allowed domains when AllowCrossDomainAccess is true. Use * for domain wildcards, e.g., *.consoto.com. (Inherited from SelfHostingService)
	Archive	Gets or sets the IArchive used by the web service for its data.
	AutomaticFormatSelectionEnabled	Gets or sets a value that determines if automatic format selection is enabled for Web HTTP bindings. (Inherited from SelfHostingService)
	CloseTimeout	Gets or sets the desired CloseTimeout used as the interval of time provided for a connection to close before the transport raises an exception.
	ContractInterface	Gets or sets the FullName of the contract interface implemented by the web service. (Inherited from SelfHostingService)
	DefaultOutgoingRequestFormat	Gets and sets the default outgoing request format for Web HTTP bindings. (Inherited from SelfHostingService)
	DefaultOutgoingResponseFormat	Gets and sets the default outgoing response format for Web HTTP bindings. (Inherited from SelfHostingService)
	Domain	Gets the AppDomain in which the Adapter is executing. (Inherited from Adapter)
	Enabled	Gets or sets a boolean value that indicates whether the web service is currently enabled. (Inherited from SelfHostingService)
	Endpoints	Gets or sets a semicolon delimited list of URIs where the web service can be accessed. (Inherited from SelfHostingService)
	FaultExceptionEnabled	Gets or sets the flag that specifies whether a FaultException is generated when an internal server error(HTTP status code: 500) occurs for Web HTTP bindings. (Inherited from SelfHostingService)
	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)
	JsonFaultHandlingEnabled	Gets or sets a value that determines if JSON formatted fault messages should be returned during exceptions. (Inherited from SelfHostingService)
	MemoryUsage	Gets the memory utilization of the Adapter in bytes if executing in a separate AppDomain, otherwise NaN. (Inherited from Adapter)
	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)
	PublishMetadata	Gets or sets a boolean value that indicates whether web service metadata is to made available at all web service Endpoints. (Inherited from SelfHostingService)
	SecurityPolicy	Gets or sets the FullName of IAuthorizationPolicy to be used for securing all web service Endpoints. (Inherited from SelfHostingService)
	ServiceEnabled	Gets or sets a boolean value that indicates whether the web service is to be enabled at startup. (Inherited from SelfHostingService)
	ServiceHost	Gets the WebServiceHost hosting the web service. (Inherited from SelfHostingService)
	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)
	Singleton	Gets or sets a boolean value that indicates whether the ServiceHost will use the current instance of the web service for processing requests or base the web service instance creation on InstanceContextMode specified in its ServiceBehaviorAttribute. (Inherited from SelfHostingService)
	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)
	WindowsAuthentication	Gets or sets a boolean value that indicates whether Windows Authentication is to be enabled. (Inherited from SelfHostingService)

Top

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 web service and optionally releases the managed resources. (Inherited from SelfHostingService)
	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)
	GetFlashPolicy	Gets policy stream for Flash applications. (Inherited from SelfHostingService)
	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)
	GetServiceAddress	Gets an address where the ServiceHost will host the service. (Inherited from SelfHostingService)
	GetSilverlightPolicy	Gets policy stream for Silverlight applications. (Inherited from SelfHostingService)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetUnusedPort	Get an unused port number. (Inherited from SelfHostingService)
	Initialize	Initializes the web service. (Inherited from SelfHostingService)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
	InitializeServiceHost	Initializes the ServiceHost. (Inherited from SelfHostingService)
	LoadSettings	Loads saved web service settings from the config file if the PersistSettings property is set to true. (Overrides SelfHostingServiceLoadSettings)
	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)
	OnServiceHostCreated	Raises the ServiceHostCreated event. (Overrides SelfHostingServiceOnServiceHostCreated)
	OnServiceHostStarted	Raises the ServiceHostStarted event. (Inherited from SelfHostingService)
	OnServiceProcessException	Raises the ServiceProcessException event. (Inherited from SelfHostingService)
	OnStatusUpdate	Raises the StatusUpdate event. (Inherited from Adapter)
	SaveSettings	Saves web service settings to the config file if the PersistSettings property is set to true. (Overrides SelfHostingServiceSaveSettings)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

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)
	ServiceHostCreated	Occurs when the ServiceHost has been created with the specified Endpoints. (Inherited from SelfHostingService)
	ServiceHostStarted	Occurs when the ServiceHost has can process requests via all of its endpoints. (Inherited from SelfHostingService)
	ServiceProcessException	Occurs when an Exception is encountered when processing a request. (Inherited from SelfHostingService)
	StatusUpdate	Occurs when the Adapter wants to provide a status update. (Inherited from Adapter)

Top

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)

Top

Reference

GSF.Historian.DataServices Namespace