Class ServiceConfiguration

Defines the active configuration of the service version hosted on specific node.

Inheritance

Object

ServiceConfiguration

Implements

IExtensibleDataObject

IExtension<ServiceHostBase>

IValidator

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Nevatech.Vsb.Repository.Services

Assembly: Nevatech.Vsb.Repository.dll

Syntax

public sealed class ServiceConfiguration : IExtensibleDataObject, IExtension<ServiceHostBase>, IValidator

Constructors

ServiceConfiguration()

Declaration

public ServiceConfiguration()

Properties

AuthorizationRules

Gets collection of the authorization rule assignments for current service version.

Declaration

public Collection<AuthorizationRuleAssignment> AuthorizationRules { get; }

Property Value

Type	Description
Collection<AuthorizationRuleAssignment>

BaseAddress

Gets or sets the relative base address associated with all inbound endpoints.

Declaration

public string BaseAddress { get; set; }

Property Value

Type	Description
String

ErrorMessage

Gets the summary of validation errors populated by the call to Validate() method.

Declaration

public string ErrorMessage { get; }

Property Value

Type	Description
String

ExtensionData

Gets or sets ExtensionDataObject that enables serialization round-trips.

Declaration

public ExtensionDataObject ExtensionData { get; set; }

Property Value

Type	Description
ExtensionDataObject

Files

Gets collection of the files (without content) used by the service version.

Declaration

public Collection<File> Files { get; }

Property Value

Type	Description
Collection<File>

Id

Gets or sets the service version id associated with the configuration.

Declaration

public int Id { get; set; }

Property Value

Type	Description
Int32

InboundEndpoints

Gets collection of the inbound endpoints.

Declaration

public Collection<RoutingEndpointDefinition> InboundEndpoints { get; }

Property Value

Type	Description
Collection<RoutingEndpointDefinition>

InboundRequests

Gets collection of the inbound request messages.

Declaration

public Collection<InboundRequestMessageDefinition> InboundRequests { get; }

Property Value

Type	Description
Collection<InboundRequestMessageDefinition>

IsAccessKeyRequired

Gets or sets flag indicating that service requires an access key (API key) to be provided by the caller. Such service can only be used in a product that requires subscriptions. If set to false then service can be used in a product that does not require subscriptions or as a stand-alone service. This property applies to virtual service only.

Declaration

public bool IsAccessKeyRequired { get; set; }

Property Value

Type	Description
Boolean

IsMulticast

Gets flag indicating that service is working in multicast mode.

Declaration

public bool IsMulticast { get; }

Property Value

Type	Description
Boolean

Key

Gets or sets the service version key associated with the configuration.

Declaration

public Guid Key { get; set; }

Property Value

Type	Description
Guid

Kind

Gets the effective service kind: SOAP, REST, or OData.

Declaration

public ServiceKind Kind { get; }

Property Value

Type	Description
ServiceKind

LastUpdated

Gets or sets the last updated date and time.

Declaration

public DateTime LastUpdated { get; set; }

Property Value

Type	Description
DateTime

MessageProcessing

Gets or sets the message processing pipeline configuration.

Declaration

public MessagePipeline MessageProcessing { get; set; }

Property Value

Type	Description
MessagePipeline

NodeId

Gets or sets the node id that hosts this virtual service.

Declaration

public int NodeId { get; set; }

Property Value

Type	Description
Int32

OutboundEndpointGroups

Gets collection of the outbound endpoint groups.

Declaration

public Collection<EndpointGroupDefinition> OutboundEndpointGroups { get; }

Property Value

Type	Description
Collection<EndpointGroupDefinition>

ServiceBehavior

Gets or sets the service behavior configuration.

Declaration

public Behavior ServiceBehavior { get; set; }

Property Value

Type	Description
Behavior

Settings

Gets or sets service version advanced configuration settings.

Declaration

public ServiceVersionSettings Settings { get; set; }

Property Value

Type	Description
ServiceVersionSettings

Methods

Attach(ServiceHostBase)

Enables an extension object to find out when it has been aggregated. Called when the extension is added to the IExtensibleObject{T}.Extensions property.

Declaration

public void Attach(ServiceHostBase owner)

Parameters

Type	Name	Description
ServiceHostBase	owner	The ServiceHostBase that aggregates this extension.

Detach(ServiceHostBase)

Enables an extension object to find out when it is not longer aggregated. Called when the extension is removed from the IExtensibleObject{T}.Extensions property.

Declaration

public void Detach(ServiceHostBase owner)

Parameters

Type	Name	Description
ServiceHostBase	owner	The ServiceHostBase that aggregates this extension.

Validate()

Evaluates the state of this object.

Declaration

public bool Validate()

Returns

Type	Description
Boolean	True if state is valid; otherwise, false.

Implements

System.Runtime.Serialization.IExtensibleDataObject

System.ServiceModel.IExtension<T>

IValidator