Class ServiceVersion

Represents physical or virtual service.

Inheritance

System.Object

DomainObjectBase

ServiceVersion

ServiceVersionDefinition

Implements

IValidator

System.Runtime.Serialization.IExtensibleDataObject

System.IEquatable<ServiceVersion>

Inherited Members

DomainObjectBase.IsValidElementName(String)

DomainObjectBase.AreEqual(Nullable<DateTime>, Nullable<DateTime>)

DomainObjectBase.Equals(DomainObjectBase)

DomainObjectBase.Id

DomainObjectBase.Key

DomainObjectBase.Created

DomainObjectBase.Updated

DomainObjectBase.IsMajorObject

DomainObjectBase.ErrorMessage

DomainObjectBase.ExtensionData

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Nevatech.Vsb.Repository.Entities

Assembly: Nevatech.Vsb.Repository.dll

Syntax

public class ServiceVersion : DomainObjectBase, IValidator, IExtensibleDataObject, IEquatable<ServiceVersion>

Constructors

ServiceVersion()

Initializes a new instance of the Service object.

Declaration

public ServiceVersion()

Properties

BaseAddress

Gets or sets the relative base address of service endpoints. The value must be a string containing just digits and letters. This property applies only to virtual services.

Declaration

public string BaseAddress { get; set; }

Property Value

Type	Description
System.String

Remarks

Service base address:

uniquely identifies a host instance within a single node;
used for physical endpoints and ignored for service bus endpoints;
may include a path like "a/b/c";
may end with an ".svc" extension like "a/b/c.svc", but may not include ".svc" in the middle like "a/b.svc/c";
appends to the node base address together with ".svc" extension, if endpoint is hosted on a Mixed Transports Mode node. If service base address already ends with ".svc", the extra extension is not appended.

Examples

"SearchService", "SearchService.svc", "production/services/search.svc"

BehaviorId

Gets or sets the service behavior identifier this service uses.

Declaration

public int? BehaviorId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Description

Gets or sets service version description.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

FriendlyName

Gets or sets the service version friendly name.

Declaration

public string FriendlyName { get; set; }

Property Value

Type	Description
System.String

FullName

Gets the full friendly name of the service version that includes custom or standard version number.

Declaration

public string FullName { get; }

Property Value

Type	Description
System.String

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
System.Boolean

IsEnabled

Gets or sets flag indicating that service version is enabled and exposed by the runtime. This property applies only to virtual services.

Declaration

public bool IsEnabled { get; set; }

Property Value

Type	Description
System.Boolean

IsHostable

Gets flag indicating that current state of the service version allows it to be hosted on a node or be invoked by another service.

Declaration

public bool IsHostable { get; }

Property Value

Type	Description
System.Boolean

IsSchemaFirst

Gets or sets flag indicating that service is manually designed from a set of schemas. If False then service is created from a WSDL.

Declaration

public bool IsSchemaFirst { get; set; }

Property Value

Type	Description
System.Boolean

LastUpdate

Gets timestamp of the latest service version update. The update includes any changes in the service objects or downstream services that require virtual service to be restarted.

Declaration

public DateTime LastUpdate { get; }

Property Value

Type	Description
System.DateTime

MessageProcessing

Gets or sets the message processing pipeline configuration.

Declaration

public MessagePipeline MessageProcessing { get; set; }

Property Value

Type	Description
MessagePipeline

Name

Gets or sets the service name in WSDL (required for SOAP services).

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Namespace

Gets or sets the service target namespace in WSDL (required for SOAP services).

Declaration

public string Namespace { get; set; }

Property Value

Type	Description
System.String

ObjectType

Gets object type identifier.

Declaration

public override EntityType ObjectType { get; }

Property Value

Type	Description
EntityType

Overrides

DomainObjectBase.ObjectType

QName

Gets service version's XML qualified name.

Declaration

public XmlQualifiedName QName { get; }

Property Value

Type	Description
System.Xml.XmlQualifiedName

ServiceId

Gets or sets service id.

Declaration

public int ServiceId { get; set; }

Property Value

Type	Description
System.Int32

Settings

Gets service version advanced configuration settings. This property applies only to virtual services.

Declaration

public ServiceVersionSettings Settings { get; }

Property Value

Type	Description
ServiceVersionSettings

Status

Gets or sets this version status.

Declaration

public ServiceVersionStatus Status { get; set; }

Property Value

Type	Description
ServiceVersionStatus

Version

Gets or sets the custom-defined version identifier.

Declaration

public string Version { get; set; }

Property Value

Type	Description
System.String

VersionNumber

Gets service version number.

Declaration

public int VersionNumber { get; }

Property Value

Type	Description
System.Int32

Methods

Equals(ServiceVersion)

Determines whether the specified service version is equal to the current service version.

Declaration

public bool Equals(ServiceVersion other)

Parameters

Type	Name	Description
ServiceVersion	other	The service version to compare with the current service version.

Returns

Type	Description
System.Boolean	True, if service versions are equal. False, if service versions are not equal.

Equals(Object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object to compare with the current object.

Returns

Type	Description
System.Boolean	True, if objects are equal. False, if objects are not equal.

Overrides

DomainObjectBase.Equals(Object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code of the current instance.

Overrides

DomainObjectBase.GetHashCode()

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents the current object.

Overrides

DomainObjectBase.ToString()

Validate()

Evaluates the state of this object.

Declaration

public override bool Validate()

Returns

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

Overrides

DomainObjectBase.Validate()

Validate(Boolean, Boolean)

Evaluates the state of this object.

Declaration

public bool Validate(bool isVirtual, bool isSoap)

Parameters

Type	Name	Description
System.Boolean	isVirtual	Flag indicating that validated service version belongs to a virtual service.
System.Boolean	isSoap	Flag indicating that validation is performed for SOAP service.

Returns

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

Implements

IValidator

System.Runtime.Serialization.IExtensibleDataObject

System.IEquatable<T>