Class SoapHeader
Represents a SOAP header that needs to be set, replaced, or removed in an intercepted SOAP message.
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class SoapHeader : IValidator, IEquatable<SoapHeader>Constructors
SoapHeader()
Declaration
public SoapHeader()Fields
ElementName
Name of the root element when object is serialized to XML.
Declaration
public const string ElementName = "HEADER"Field Value
| Type | Description |
|---|---|
| String |
Properties
Action
Gets or sets the the action to take when a header is already present in the message.
Declaration
public ExistingValueAction Action { get; set; }Property Value
| Type | Description |
|---|---|
| ExistingValueAction |
ErrorMessage
Gets the summary of validation errors populated by the call to Validate() method.
Declaration
public string ErrorMessage { get; }Property Value
| Type | Description |
|---|---|
| String |
Name
Gets or sets the header's root element name. Name may contain a specially formatted context property name which value must be used as the header's name.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Namespace
Gets or sets the header's root element namespace. Name may contain a specially formatted context property name which value must be used as the header's namespace. Property may be set to an empty string, but not to Null.
Declaration
public string Namespace { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Value
Gets or sets the new header in XML format starting from the root element that should match value defined in Name and Namespace properties. Value may contain a specially formatted context property name which value must be used in the header. If set to Null or left empty, an existing header will be deleted.
Declaration
public string Value { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Methods
Equals(SoapHeader)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(SoapHeader other)Parameters
| Type | Name | Description |
|---|---|---|
| SoapHeader | other | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| Boolean | True, if objects are equal. False, if objects 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 |
|---|---|---|
| Object | obj | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| Boolean | True, if objects are equal. False, if objects are not equal. |
Overrides
GetHashCode()
Returns the hash code for this instance.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 | Hash code of the current instance. |
Overrides
ToString()
Returns string representation of the object.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String | String representing the object's content. |
Overrides
Validate()
Evaluates the state of this object.
Declaration
public bool Validate()Returns
| Type | Description |
|---|---|
| Boolean | True if state is valid; otherwise, false. |