Interface IConfigurationService

Defines a contract for Repository Management Service methods used by nodes.

Namespace: Nevatech.Vsb.Repository.Services

Assembly: Nevatech.Vsb.Repository.dll

Syntax

[ServiceContract(Name = "ConfigurationService", Namespace = "http://schemas.nevatech.com/sentinet/2011/02", SessionMode = SessionMode.Allowed)]
public interface IConfigurationService

Methods

GetFile(Guid, int)

Returns file corresponding to provided identifier.

Declaration

[OperationContract(Name = "GetFile2")]
[FaultContract(typeof(NodeNotFoundFault), Name = "NodeNotFoundFault", Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
File GetFile(Guid nodeKey, int fileId)

Parameters

Type	Name	Description
Guid	nodeKey	Calling node's unique identifier.
int	fileId	File identifier.

Returns

Type	Description
File	File corresponding to provided identifier.

GetMetadata(Guid, int)

Returns metadata for the specified service version specific to the requesting node.

Declaration

[OperationContract]
[FaultContract(typeof(NodeNotFoundFault), Name = "NodeNotFoundFault", Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
XmlNode[] GetMetadata(Guid nodeKey, int serviceVersionId)

Parameters

Type	Name	Description
Guid	nodeKey	Calling node's unique identifier.
int	serviceVersionId	Identifier of the service version which metadata needs to be retrieved.

Returns

Type	Description
XmlNode[]	Metadata for the specified service version specific to the requesting node.

GetNode(Guid)

Returns the node corresponding to provided key with its underlying objects.

Declaration

[OperationContract(Name = "GetNodeByKey2")]
[FaultContract(typeof(NodeNotFoundFault), Name = "NodeNotFoundFault", Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
NodeDefinition GetNode(Guid nodeKey)

Parameters

Type	Name	Description
Guid	nodeKey	Node unique identifier.

Returns

Type	Description
NodeDefinition	Fully populated hierarchy of objects composing the node.

GetNodeConfiguration(Guid, DateTime)

Returns runtime configuration of the specified node.

Declaration

[OperationContract]
[FaultContract(typeof(NodeNotFoundFault), Name = "NodeNotFoundFault", Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
NodeConfiguration GetNodeConfiguration(Guid nodeKey, DateTime nodeLastUpdate)

Parameters

Type	Name	Description
Guid	nodeKey	Node global identifier.
DateTime	nodeLastUpdate	Configuration timestamp on the node side. Only changes with the more recent timestamp will be fully populated in the returned result.

Returns

Type	Description
NodeConfiguration	Runtime configuration of the specified node.

GetProductConfiguration(Guid, int, DateTime?)

Returns runtime configuration for the requested product hosted on the specified node.

Declaration

[OperationContract]
[FaultContract(typeof(NodeNotFoundFault), Name = "NodeNotFoundFault", Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
ProductConfiguration GetProductConfiguration(Guid nodeKey, int productId, DateTime? productLastUpdate)

Parameters

Type	Name	Description
Guid	nodeKey	Node global identifier.
int	productId	Product identifier.
DateTime?	productLastUpdate	Product configuration timestamp on the node's side. Only changes made later this time will be included in the result. If parameter is NULL then full configuration will be returned.

Returns

Type	Description
ProductConfiguration	Runtime configuration for the requested product hosted on the specified node.

GetServiceConfiguration(Guid, int)

Returns runtime configuration of the requested service version hosted on the specified node.

Declaration

[OperationContract]
[FaultContract(typeof(NodeNotFoundFault), Name = "NodeNotFoundFault", Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
ServiceConfiguration GetServiceConfiguration(Guid nodeKey, int serviceVersionId)

Parameters

Type	Name	Description
Guid	nodeKey	Node global identifier.
int	serviceVersionId	Identifier of the service version which runtime configuration needs to be retrieved.

Returns

Type	Description
ServiceConfiguration	Runtime configuration of the requested service version hosted on the specified node.

UpdateNodeInstanceState(NodeInstanceState)

Updates node instance last heartbeat timestamp, sets node current health status, and returns node current configuration timestamp.

Declaration

[OperationContract]
[FaultContract(typeof(NodeNotFoundFault), Name = "NodeNotFoundFault", Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
DateTime UpdateNodeInstanceState(NodeInstanceState state)

Parameters

Type	Name	Description
NodeInstanceState	state	Node instance current state.

Returns

Type	Description
DateTime	Node's most recent configuration timestamp.

Exceptions

Type	Condition
FaultException<TDetail>	Thrown if the specified node does not exist.

Write(MonitoringBatch)

Writes provided monitoring data that includes collections of transactions, activity records, and captured messages to underlying persistent store.

Declaration

[OperationContract(IsOneWay = true)]
void Write(MonitoringBatch batch)

Parameters

Type	Name	Description
MonitoringBatch	batch	Monitoring data that need to be recorded.