Class RelativeUriComponent

Implements a message pipeline component that sets the relative request URI in an intercepted RESTful message. This component cannot be used to set or remove query parameters in the intercepted message.

Inheritance
Object
MessagePipelineComponentBase
RelativeUriComponent
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class RelativeUriComponent : MessagePipelineComponentBase, IValidator, IEquatable<MessagePipelineComponentBase>, IExtensibleDataObject

Constructors

RelativeUriComponent()

Declaration
public RelativeUriComponent()

Fields

ElementName

Name of the root element when object is serialized to XML.

Declaration
public const string ElementName = "SET-RELATIVE-URI"
Field Value
Type Description
String

Properties

AllowedPositions

Gets the message processing pipeline position(s) supported by the component: inbound request or outbound request.

Declaration
public override MessagePipelinePositions AllowedPositions { get; }
Property Value
Type Description
MessagePipelinePositions
Overrides

BindingTemplate

Gets or sets the URI template that will be used to create the relative URI value. Static strings, variables from the ParsingTemplate, and context properties can be used. Note that original query parameters will NOT be affected and will be preserved. This property is required.

Declaration
public string BindingTemplate { get; set; }
Property Value
Type Description
String
Examples

"{shoe}", "make/{shoe}/{bed=simple}"

ParsingTemplate

Gets or sets the URI template that will be used to parse the relating URI into segments and parameters. Template string may contain context properties. If template does not match the intercepted message request URI then no changes will be done. This property is optional.

Declaration
public string ParsingTemplate { get; set; }
Property Value
Type Description
String
Examples

"find/{shoe}/{boat=null}?x={bed}"

Methods

Equals(MessagePipelineComponentBase)

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

Declaration
public override bool Equals(MessagePipelineComponentBase other)
Parameters
Type Name Description
MessagePipelineComponentBase other

The object to compare with the current object.
Returns
Type Description
Boolean

True, if objects are equal. False, if objects are not equal.
Overrides

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

ProcessMessage(MessagePipelineContext)

Sets the relative request URI in the provided RESTful message.

Declaration
public override MessagePipelineResult ProcessMessage(MessagePipelineContext context)
Parameters
Type Name Description
MessagePipelineContext context

Provides the message processing context.
Returns
Type Description
MessagePipelineResult

Value indicating if message should continue on its way to the recipient or must be stopped and returned to the sender.
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 override bool Validate()
Returns
Type Description
Boolean

True if state is valid; otherwise, false.
Overrides

Implements