Class MessageHeaderAccessor

Namespace

Steeltoe.Messaging.Support

Assembly

Steeltoe.Messaging.MessagingBase.dll

public class MessageHeaderAccessor : IMessageHeaderAccessor

Inheritance

object

MessageHeaderAccessor

Implements

IMessageHeaderAccessor

Derived

IntegrationMessageHeaderAccessor

RabbitHeaderAccessor

NativeMessageHeaderAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

MessageHeaderAccessor()

public MessageHeaderAccessor()

MessageHeaderAccessor(IMessage)

public MessageHeaderAccessor(IMessage message)

Parameters

message IMessage

MessageHeaderAccessor(MessageHeaders)

public MessageHeaderAccessor(MessageHeaders headers)

Parameters

headers MessageHeaders

Fields

DEFAULT_CHARSET

public static readonly Encoding DEFAULT_CHARSET

Field Value

Encoding

headers

protected MessageHeaderAccessor.AccessorMessageHeaders headers

Field Value

MessageHeaderAccessor.AccessorMessageHeaders

Properties

ContentType

public virtual string ContentType { get; set; }

Property Value

string

EnableTimestamp

public virtual bool EnableTimestamp { get; set; }

Property Value

bool

ErrorChannel

public virtual object ErrorChannel { get; set; }

Property Value

object

ErrorChannelName

public virtual string ErrorChannelName { get; set; }

Property Value

string

Id

public virtual string Id { get; }

Property Value

string

IdGenerator

public virtual IIDGenerator IdGenerator { get; set; }

Property Value

IIDGenerator

IsModified

public virtual bool IsModified { get; set; }

Property Value

bool

IsMutable

public virtual bool IsMutable { get; }

Property Value

bool

LeaveMutable

public virtual bool LeaveMutable { get; set; }

Property Value

bool

MessageHeaders

public virtual IMessageHeaders MessageHeaders { get; }

Property Value

IMessageHeaders

ReplyChannel

public virtual object ReplyChannel { get; set; }

Property Value

object

ReplyChannelName

public virtual string ReplyChannelName { get; set; }

Property Value

string

Timestamp

public virtual long? Timestamp { get; }

Property Value

long?

Methods

CopyHeaders(IDictionary<string, object>)

public virtual void CopyHeaders(IDictionary<string, object> headersToCopy)

Parameters

headersToCopy IDictionary<string, object>

CopyHeadersIfAbsent(IDictionary<string, object>)

public virtual void CopyHeadersIfAbsent(IDictionary<string, object> headersToCopy)

Parameters

headersToCopy IDictionary<string, object>

CreateMutableAccessor(IMessage)

protected virtual MessageHeaderAccessor CreateMutableAccessor(IMessage message)

Parameters

message IMessage

Returns

MessageHeaderAccessor

CreateMutableAccessor(IMessageHeaders)

protected virtual MessageHeaderAccessor CreateMutableAccessor(IMessageHeaders messageHeaders)

Parameters

messageHeaders IMessageHeaders

Returns

MessageHeaderAccessor

GetAccessor(IMessage, Type)

public static MessageHeaderAccessor GetAccessor(IMessage message, Type accessorType)

Parameters

message IMessage

accessorType Type

Returns

MessageHeaderAccessor

GetAccessor(IMessageHeaders, Type)

public static MessageHeaderAccessor GetAccessor(IMessageHeaders messageHeaders, Type accessorType)

Parameters

messageHeaders IMessageHeaders

accessorType Type

Returns

MessageHeaderAccessor

GetAccessor<T>(IMessage)

public static T GetAccessor<T>(IMessage message) where T : MessageHeaderAccessor

Parameters

message IMessage

Returns

T

Type Parameters

T

GetAccessor<T>(IMessageHeaders)

public static T GetAccessor<T>(IMessageHeaders messageHeaders) where T : MessageHeaderAccessor

Parameters

messageHeaders IMessageHeaders

Returns

T

Type Parameters

T

GetDetailedLogMessage(object)

public virtual string GetDetailedLogMessage(object payload)

Parameters

payload object

Returns

string

GetDetailedPayloadLogMessage(object)

protected virtual string GetDetailedPayloadLogMessage(object payload)

Parameters

payload object

Returns

string

GetHeader(string)

public virtual object GetHeader(string headerName)

Parameters

headerName string

Returns

object

GetMutableAccessor(IMessage, Type)

public static MessageHeaderAccessor GetMutableAccessor(IMessage message, Type accessorType = null)

Parameters

message IMessage

accessorType Type

Returns

MessageHeaderAccessor

GetMutableAccessor(IMessageHeaders, Type)

public static MessageHeaderAccessor GetMutableAccessor(IMessageHeaders headers, Type accessorType = null)

Parameters

headers IMessageHeaders

accessorType Type

Returns

MessageHeaderAccessor

GetMutableAccessor<T>(IMessage)

public static T GetMutableAccessor<T>(IMessage message) where T : MessageHeaderAccessor

Parameters

message IMessage

Returns

T

Type Parameters

T

GetMutableAccessor<T>(IMessageHeaders)

public static T GetMutableAccessor<T>(IMessageHeaders messageHeaders) where T : MessageHeaderAccessor

Parameters

messageHeaders IMessageHeaders

Returns

T

Type Parameters

T

GetShortLogMessage(object)

public virtual string GetShortLogMessage(object payload)

Parameters

payload object

Returns

string

GetShortPayloadLogMessage(object)

protected virtual string GetShortPayloadLogMessage(object payload)

Parameters

payload object

Returns

string

IsReadOnly(string)

protected virtual bool IsReadOnly(string headerName)

Parameters

headerName string

Returns

bool

IsReadableContentType()

protected virtual bool IsReadableContentType()

Returns

bool

RemoveHeader(string)

public virtual void RemoveHeader(string headerName)

Parameters

headerName string

RemoveHeaders(params string[])

public virtual void RemoveHeaders(params string[] headerPatterns)

Parameters

headerPatterns string[]

SetHeader(string, object)

public virtual void SetHeader(string name, object value)

Parameters

name string

value object

SetHeaderIfAbsent(string, object)

public virtual void SetHeaderIfAbsent(string name, object value)

Parameters

name string

value object

SetImmutable()

public virtual void SetImmutable()

ToDictionary()

public virtual IDictionary<string, object> ToDictionary()

Returns

IDictionary<string, object>

ToMessageHeaders()

public virtual IMessageHeaders ToMessageHeaders()

Returns

IMessageHeaders

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

VerifyType(string, object)

protected virtual void VerifyType(string headerName, object headerValue)

Parameters

headerName string

headerValue object