MessageHeader (Eagle Core API)

java.lang.Object
- com.neeve.service.messages.MessageHeader

All Implemented Interfaces:: IRogValidatable, IMessageHeader

@Generated(value="com.neeve.adm.AdmJsonGenerator",
           date="Fri Dec 05 11:53:59 EST 2025")
 @AdmGenerated(encoding="Json",
              compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 11:53 AM",
              buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding")
 @AdmFactoryInfo(factoryClass=MessageFactory.class,
                vfid=132,
                ofid=132,
                typeId=1002)
public final class MessageHeader
extends Object
implements IMessageHeader

The 'MessageHeader' type.

ADM Details

ADM Type	Embedded Entity
Factory	MessageFactory

ADM Field Summary

Field	Type	Id	Description
channelId	String	32729	No doc provided.
credentials	`Credentials`	32732	No doc provided.
error	`ErrorContext`	32730	No doc provided.
origin	String	32737	No doc provided.
requestId	String	32733	No doc provided.
senderVersion	`Version`	32731	No doc provided.
sessionId	String	32735	No doc provided.
sourceId	String	32736	No doc provided.
transactionId	String	32734	No doc provided.

Field Summary

Fields
Modifier and Type Field and Description

static MessageHeader[] EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Fields
Modifier and Type	Field and Description
`static MessageHeader[]`	`EMPTY_ARRAY` A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

Constructors
Constructor and Description

MessageHeader()

Constructors
Constructor and Description
`MessageHeader()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessageHeader`	`acquire()`
`void`	`clearChannelId()` Clears the value of 'channelId'.
`void`	`clearContent()`
`void`	`clearCredentials()` Clears the value of 'credentials'.
`void`	`clearError()` Clears the value of 'error'.
`void`	`clearOrigin()` Clears the value of 'origin'.
`void`	`clearRequestId()` Clears the value of 'requestId'.
`void`	`clearSenderVersion()` Clears the value of 'senderVersion'.
`void`	`clearSessionId()` Clears the value of 'sessionId'.
`void`	`clearSourceId()` Clears the value of 'sourceId'.
`void`	`clearTransactionId()` Clears the value of 'transactionId'.
`Object`	`clone()` Creates a clone of this object.
`MessageHeader`	`copy()`
`void`	`copyInto(MessageHeader copy)`
`static MessageHeader`	`create()`
`static MessageHeader`	`createFrom(byte[] serializedJson)`
`static MessageHeader`	`createFromJson(String json)`
`static MessageHeader`	`createFromSerializedJson(byte[] serializedJson)`
`static MessageHeader`	`createFromSerializedJson(ByteBuffer serializedJson)`
`MessageHeader`	`deserializeFromByteArray(byte[] array)`
`MessageHeader`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`MessageHeader`	`deserializeFromNative(long address, int addressOffset, int length)`
`void`	`dispose()`
`String`	`getChannelId()` Gets the value of 'channelId'.
`static int`	`getChannelIdFieldId()`
`<T extends XString> T`	`getChannelIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getChannelIdTo(XString val)` Copies the value of 'channelId' into the provided XString.
`XString`	`getChannelIdUnsafe()` Gets the raw value of 'channelId'.
`Credentials`	`getCredentials()` Gets the value of 'credentials'.
`static int`	`getCredentialsFieldId()`
`void`	`getCredentialsTo(Credentials to)` Copies the value of Credentials into the provided value.
`ErrorContext`	`getError()` Gets the value of 'error'.
`static int`	`getErrorFieldId()`
`void`	`getErrorTo(ErrorContext to)` Copies the value of ErrorContext into the provided value.
`boolean`	`getIsReadOnly()`
`String`	`getOrigin()` Gets the value of 'origin'.
`static int`	`getOriginFieldId()`
`<T extends XString> T`	`getOriginTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getOriginTo(XString val)` Copies the value of 'origin' into the provided XString.
`XString`	`getOriginUnsafe()` Gets the raw value of 'origin'.
`int`	`getOwnerCount()`
`String`	`getRequestId()` Gets the value of 'requestId'.
`static int`	`getRequestIdFieldId()`
`<T extends XString> T`	`getRequestIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getRequestIdTo(XString val)` Copies the value of 'requestId' into the provided XString.
`XString`	`getRequestIdUnsafe()` Gets the raw value of 'requestId'.
`Version`	`getSenderVersion()` Gets the value of 'senderVersion'.
`static int`	`getSenderVersionFieldId()`
`void`	`getSenderVersionTo(Version to)` Copies the value of Version into the provided value.
`int`	`getSerializeToNativeLength()`
`String`	`getSessionId()` Gets the value of 'sessionId'.
`static int`	`getSessionIdFieldId()`
`<T extends XString> T`	`getSessionIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getSessionIdTo(XString val)` Copies the value of 'sessionId' into the provided XString.
`XString`	`getSessionIdUnsafe()` Gets the raw value of 'sessionId'.
`String`	`getSourceId()` Gets the value of 'sourceId'.
`static int`	`getSourceIdFieldId()`
`<T extends XString> T`	`getSourceIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getSourceIdTo(XString val)` Copies the value of 'sourceId' into the provided XString.
`XString`	`getSourceIdUnsafe()` Gets the raw value of 'sourceId'.
`String`	`getTransactionId()` Gets the value of 'transactionId'.
`static int`	`getTransactionIdFieldId()`
`<T extends XString> T`	`getTransactionIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getTransactionIdTo(XString val)` Copies the value of 'transactionId' into the provided XString.
`XString`	`getTransactionIdUnsafe()` Gets the raw value of 'transactionId'.
`void`	`getValidationErrors(List<XString> results, String errorPrefix)`
`boolean`	`hasChannelId()` Checks for the presence of 'channelId'.
`boolean`	`hasCredentials()` Checks for the presence of 'credentials'.
`boolean`	`hasError()` Checks for the presence of 'error'.
`boolean`	`hasOrigin()` Checks for the presence of 'origin'.
`boolean`	`hasRequestId()` Checks for the presence of 'requestId'.
`boolean`	`hasSenderVersion()` Checks for the presence of 'senderVersion'.
`boolean`	`hasSessionId()` Checks for the presence of 'sessionId'.
`boolean`	`hasSourceId()` Checks for the presence of 'sourceId'.
`boolean`	`hasTransactionId()` Checks for the presence of 'transactionId'.
`boolean`	`isBufferBacked()`
`boolean`	`isReferenceCounted()`
`boolean`	`isValid()`
`void`	`lendChannelId(XString val)` Lends the value of 'channelId' to this object.
`void`	`lendCredentials(Credentials val)` 'Lends' a reference of the Credentials to the message for this field.
`void`	`lendError(ErrorContext val)` 'Lends' a reference of the ErrorContext to the message for this field.
`void`	`lendOrigin(XString val)` Lends the value of 'origin' to this object.
`void`	`lendRequestId(XString val)` Lends the value of 'requestId' to this object.
`void`	`lendSenderVersion(Version val)` 'Lends' a reference of the Version to the message for this field.
`void`	`lendSessionId(XString val)` Lends the value of 'sessionId' to this object.
`void`	`lendSourceId(XString val)` Lends the value of 'sourceId' to this object.
`void`	`lendTransactionId(XString val)` Lends the value of 'transactionId' to this object.
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`int`	`serializeToNative(long address, int addressOffset)`
`void`	`setAsReadOnly()`
`void`	`setChannelId(String val)` Sets the value of 'channelId'.
`void`	`setChannelIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setChannelIdFrom(XString val)` Copies the provided XString value into this object's 'channelId'.
`void`	`setCredentials(Credentials val)` Sets the value of 'credentials'.
`void`	`setError(ErrorContext val)` Sets the value of 'error'.
`void`	`setOrigin(String val)` Sets the value of 'origin'.
`void`	`setOriginFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setOriginFrom(XString val)` Copies the provided XString value into this object's 'origin'.
`void`	`setRequestId(String val)` Sets the value of 'requestId'.
`void`	`setRequestIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setRequestIdFrom(XString val)` Copies the provided XString value into this object's 'requestId'.
`void`	`setSenderVersion(Version val)` Sets the value of 'senderVersion'.
`void`	`setSessionId(String val)` Sets the value of 'sessionId'.
`void`	`setSessionIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setSessionIdFrom(XString val)` Copies the provided XString value into this object's 'sessionId'.
`void`	`setSourceId(String val)` Sets the value of 'sourceId'.
`void`	`setSourceIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setSourceIdFrom(XString val)` Copies the provided XString value into this object's 'sourceId'.
`void`	`setTransactionId(String val)` Sets the value of 'transactionId'.
`void`	`setTransactionIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setTransactionIdFrom(XString val)` Copies the provided XString value into this object's 'transactionId'.
`Credentials`	`takeCredentials()` 'Takes' a reference to the credentials field from the message.
`ErrorContext`	`takeError()` 'Takes' a reference to the error field from the message.
`Version`	`takeSenderVersion()` 'Takes' a reference to the senderVersion field from the message.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final MessageHeader[] EMPTY_ARRAY
```
    A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Constructor Detail
  - MessageHeader
```
public MessageHeader()
```
- Method Detail
  - create
```
public static MessageHeader create()
```
  - createFromJson
```
public static MessageHeader createFromJson(String json)
```
  - createFromSerializedJson
```
public static MessageHeader createFromSerializedJson(ByteBuffer serializedJson)
```
  - createFromSerializedJson
```
public static MessageHeader createFromSerializedJson(byte[] serializedJson)
```
  - createFrom
```
public static MessageHeader createFrom(byte[] serializedJson)
```
  - clearContent
```
public final void clearContent()
```
  - setAsReadOnly
```
public final void setAsReadOnly()
```
  - getIsReadOnly
```
public final boolean getIsReadOnly()
```
  - getOriginFieldId
```
public static final int getOriginFieldId()
```
  - setOrigin
```
public final void setOrigin(String val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'origin'.
    
    Specified by:
    
    setOrigin in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - getOrigin
```
public final String getOrigin()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'origin'.
    
    Specified by:
    
    getOrigin in interface IMessageHeader
    
    Returns:
    
    The value of 'origin'
  - lendOrigin
```
public final void lendOrigin(XString val)
```
    Description copied from interface: IMessageHeader
    
    Lends the value of 'origin' to this object.
    This method is equivalent to setOrigin except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendOrigin in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - setOriginFrom
```
public final void setOriginFrom(long val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling IMessageHeader.setOrigin(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setOriginFrom in interface IMessageHeader
  - getOriginTo
```
public final <T extends XString> T getOriginTo(XString.Factory<T> factory)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getOriginTo in interface IMessageHeader
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
  - setOriginFrom
```
public final void setOriginFrom(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the provided XString value into this object's 'origin'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than IMessageHeader.setOrigin(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setOriginFrom in interface IMessageHeader
  - getOriginTo
```
public final void getOriginTo(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of 'origin' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than IMessageHeader.getOrigin() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getOriginTo in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getOrigin()
  - getOriginUnsafe
```
public final XString getOriginUnsafe()
```
    Description copied from interface: IMessageHeader
    
    Gets the raw value of 'origin'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getOriginUnsafe in interface IMessageHeader
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    IMessageHeader.getOrigin()
  - clearOrigin
```
public final void clearOrigin()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'origin'.
    
    Specified by:
    
    clearOrigin in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setOrigin(String)
  - hasOrigin
```
public final boolean hasOrigin()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'origin'.
    
    Specified by:
    
    hasOrigin in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getOrigin()
  - getSourceIdFieldId
```
public static final int getSourceIdFieldId()
```
  - setSourceId
```
public final void setSourceId(String val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'sourceId'.
    
    Specified by:
    
    setSourceId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - getSourceId
```
public final String getSourceId()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'sourceId'.
    
    Specified by:
    
    getSourceId in interface IMessageHeader
    
    Returns:
    
    The value of 'sourceId'
  - lendSourceId
```
public final void lendSourceId(XString val)
```
    Description copied from interface: IMessageHeader
    
    Lends the value of 'sourceId' to this object.
    This method is equivalent to setSourceId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendSourceId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - setSourceIdFrom
```
public final void setSourceIdFrom(long val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling IMessageHeader.setSourceId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setSourceIdFrom in interface IMessageHeader
  - getSourceIdTo
```
public final <T extends XString> T getSourceIdTo(XString.Factory<T> factory)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getSourceIdTo in interface IMessageHeader
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
  - setSourceIdFrom
```
public final void setSourceIdFrom(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the provided XString value into this object's 'sourceId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than IMessageHeader.setSourceId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setSourceIdFrom in interface IMessageHeader
  - getSourceIdTo
```
public final void getSourceIdTo(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of 'sourceId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than IMessageHeader.getSourceId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getSourceIdTo in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getSourceId()
  - getSourceIdUnsafe
```
public final XString getSourceIdUnsafe()
```
    Description copied from interface: IMessageHeader
    
    Gets the raw value of 'sourceId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getSourceIdUnsafe in interface IMessageHeader
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    IMessageHeader.getSourceId()
  - clearSourceId
```
public final void clearSourceId()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'sourceId'.
    
    Specified by:
    
    clearSourceId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setSourceId(String)
  - hasSourceId
```
public final boolean hasSourceId()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'sourceId'.
    
    Specified by:
    
    hasSourceId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getSourceId()
  - getChannelIdFieldId
```
public static final int getChannelIdFieldId()
```
  - setChannelId
```
public final void setChannelId(String val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'channelId'.
    
    Specified by:
    
    setChannelId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - getChannelId
```
public final String getChannelId()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'channelId'.
    
    Specified by:
    
    getChannelId in interface IMessageHeader
    
    Returns:
    
    The value of 'channelId'
  - lendChannelId
```
public final void lendChannelId(XString val)
```
    Description copied from interface: IMessageHeader
    
    Lends the value of 'channelId' to this object.
    This method is equivalent to setChannelId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendChannelId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - setChannelIdFrom
```
public final void setChannelIdFrom(long val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling IMessageHeader.setChannelId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setChannelIdFrom in interface IMessageHeader
  - getChannelIdTo
```
public final <T extends XString> T getChannelIdTo(XString.Factory<T> factory)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getChannelIdTo in interface IMessageHeader
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
  - setChannelIdFrom
```
public final void setChannelIdFrom(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the provided XString value into this object's 'channelId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than IMessageHeader.setChannelId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setChannelIdFrom in interface IMessageHeader
  - getChannelIdTo
```
public final void getChannelIdTo(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of 'channelId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than IMessageHeader.getChannelId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getChannelIdTo in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getChannelId()
  - getChannelIdUnsafe
```
public final XString getChannelIdUnsafe()
```
    Description copied from interface: IMessageHeader
    
    Gets the raw value of 'channelId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getChannelIdUnsafe in interface IMessageHeader
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    IMessageHeader.getChannelId()
  - clearChannelId
```
public final void clearChannelId()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'channelId'.
    
    Specified by:
    
    clearChannelId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setChannelId(String)
  - hasChannelId
```
public final boolean hasChannelId()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'channelId'.
    
    Specified by:
    
    hasChannelId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getChannelId()
  - getSessionIdFieldId
```
public static final int getSessionIdFieldId()
```
  - setSessionId
```
public final void setSessionId(String val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'sessionId'.
    
    Specified by:
    
    setSessionId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - getSessionId
```
public final String getSessionId()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'sessionId'.
    
    Specified by:
    
    getSessionId in interface IMessageHeader
    
    Returns:
    
    The value of 'sessionId'
  - lendSessionId
```
public final void lendSessionId(XString val)
```
    Description copied from interface: IMessageHeader
    
    Lends the value of 'sessionId' to this object.
    This method is equivalent to setSessionId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendSessionId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - setSessionIdFrom
```
public final void setSessionIdFrom(long val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling IMessageHeader.setSessionId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setSessionIdFrom in interface IMessageHeader
  - getSessionIdTo
```
public final <T extends XString> T getSessionIdTo(XString.Factory<T> factory)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getSessionIdTo in interface IMessageHeader
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
  - setSessionIdFrom
```
public final void setSessionIdFrom(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the provided XString value into this object's 'sessionId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than IMessageHeader.setSessionId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setSessionIdFrom in interface IMessageHeader
  - getSessionIdTo
```
public final void getSessionIdTo(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of 'sessionId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than IMessageHeader.getSessionId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getSessionIdTo in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getSessionId()
  - getSessionIdUnsafe
```
public final XString getSessionIdUnsafe()
```
    Description copied from interface: IMessageHeader
    
    Gets the raw value of 'sessionId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getSessionIdUnsafe in interface IMessageHeader
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    IMessageHeader.getSessionId()
  - clearSessionId
```
public final void clearSessionId()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'sessionId'.
    
    Specified by:
    
    clearSessionId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setSessionId(String)
  - hasSessionId
```
public final boolean hasSessionId()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'sessionId'.
    
    Specified by:
    
    hasSessionId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getSessionId()
  - getTransactionIdFieldId
```
public static final int getTransactionIdFieldId()
```
  - setTransactionId
```
public final void setTransactionId(String val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'transactionId'.
    
    Specified by:
    
    setTransactionId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - getTransactionId
```
public final String getTransactionId()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'transactionId'.
    
    Specified by:
    
    getTransactionId in interface IMessageHeader
    
    Returns:
    
    The value of 'transactionId'
  - lendTransactionId
```
public final void lendTransactionId(XString val)
```
    Description copied from interface: IMessageHeader
    
    Lends the value of 'transactionId' to this object.
    This method is equivalent to setTransactionId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendTransactionId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - setTransactionIdFrom
```
public final void setTransactionIdFrom(long val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling IMessageHeader.setTransactionId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setTransactionIdFrom in interface IMessageHeader
  - getTransactionIdTo
```
public final <T extends XString> T getTransactionIdTo(XString.Factory<T> factory)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getTransactionIdTo in interface IMessageHeader
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
  - setTransactionIdFrom
```
public final void setTransactionIdFrom(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the provided XString value into this object's 'transactionId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than IMessageHeader.setTransactionId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setTransactionIdFrom in interface IMessageHeader
  - getTransactionIdTo
```
public final void getTransactionIdTo(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of 'transactionId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than IMessageHeader.getTransactionId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getTransactionIdTo in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getTransactionId()
  - getTransactionIdUnsafe
```
public final XString getTransactionIdUnsafe()
```
    Description copied from interface: IMessageHeader
    
    Gets the raw value of 'transactionId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getTransactionIdUnsafe in interface IMessageHeader
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    IMessageHeader.getTransactionId()
  - clearTransactionId
```
public final void clearTransactionId()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'transactionId'.
    
    Specified by:
    
    clearTransactionId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setTransactionId(String)
  - hasTransactionId
```
public final boolean hasTransactionId()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'transactionId'.
    
    Specified by:
    
    hasTransactionId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getTransactionId()
  - getRequestIdFieldId
```
public static final int getRequestIdFieldId()
```
  - setRequestId
```
public final void setRequestId(String val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'requestId'.
    
    Specified by:
    
    setRequestId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - getRequestId
```
public final String getRequestId()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'requestId'.
    
    Specified by:
    
    getRequestId in interface IMessageHeader
    
    Returns:
    
    The value of 'requestId'
  - lendRequestId
```
public final void lendRequestId(XString val)
```
    Description copied from interface: IMessageHeader
    
    Lends the value of 'requestId' to this object.
    This method is equivalent to setRequestId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendRequestId in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - setRequestIdFrom
```
public final void setRequestIdFrom(long val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling IMessageHeader.setRequestId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setRequestIdFrom in interface IMessageHeader
  - getRequestIdTo
```
public final <T extends XString> T getRequestIdTo(XString.Factory<T> factory)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getRequestIdTo in interface IMessageHeader
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
  - setRequestIdFrom
```
public final void setRequestIdFrom(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the provided XString value into this object's 'requestId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than IMessageHeader.setRequestId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setRequestIdFrom in interface IMessageHeader
  - getRequestIdTo
```
public final void getRequestIdTo(XString val)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of 'requestId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than IMessageHeader.getRequestId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getRequestIdTo in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getRequestId()
  - getRequestIdUnsafe
```
public final XString getRequestIdUnsafe()
```
    Description copied from interface: IMessageHeader
    
    Gets the raw value of 'requestId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getRequestIdUnsafe in interface IMessageHeader
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    IMessageHeader.getRequestId()
  - clearRequestId
```
public final void clearRequestId()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'requestId'.
    
    Specified by:
    
    clearRequestId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setRequestId(String)
  - hasRequestId
```
public final boolean hasRequestId()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'requestId'.
    
    Specified by:
    
    hasRequestId in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getRequestId()
  - getCredentialsFieldId
```
public static final int getCredentialsFieldId()
```
  - setCredentials
```
public final void setCredentials(Credentials val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'credentials'.
    
    Specified by:
    
    setCredentials in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - lendCredentials
```
public final void lendCredentials(Credentials val)
```
    Description copied from interface: IMessageHeader
    
    'Lends' a reference of the Credentials to the message for this field.
    NOTE:
    It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
    To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
    
    Specified by:
    
    lendCredentials in interface IMessageHeader
    
    Parameters:
    
    val - the value to 'lend' to lend.
  - getCredentials
```
public final Credentials getCredentials()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'credentials'.
    
    Specified by:
    
    getCredentials in interface IMessageHeader
    
    Returns:
    
    The value of 'credentials'
  - getCredentialsTo
```
public final void getCredentialsTo(Credentials to)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of Credentials into the provided value.
    IF the value is not set, then the contents of the provided Credentials are cleared.
    
    Specified by:
    
    getCredentialsTo in interface IMessageHeader
    
    Parameters:
    
    to - the value to copy into
    
    See Also:
    
    Credentials.copyInto(Credentials)
  - takeCredentials
```
public final Credentials takeCredentials()
```
    Description copied from interface: IMessageHeader
    
    'Takes' a reference to the credentials field from the message.
    NOTE:
    A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.
    An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
    
    Specified by:
    
    takeCredentials in interface IMessageHeader
    
    Returns:
    
    a 'taken' reference to the field or null if the field is not set.
  - clearCredentials
```
public final void clearCredentials()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'credentials'.
    
    Specified by:
    
    clearCredentials in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setCredentials(Credentials)
  - hasCredentials
```
public final boolean hasCredentials()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'credentials'.
    
    Specified by:
    
    hasCredentials in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getCredentials()
  - getSenderVersionFieldId
```
public static final int getSenderVersionFieldId()
```
  - setSenderVersion
```
public final void setSenderVersion(Version val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'senderVersion'.
    
    Specified by:
    
    setSenderVersion in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - lendSenderVersion
```
public final void lendSenderVersion(Version val)
```
    Description copied from interface: IMessageHeader
    
    'Lends' a reference of the Version to the message for this field.
    NOTE:
    It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
    To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
    
    Specified by:
    
    lendSenderVersion in interface IMessageHeader
    
    Parameters:
    
    val - the value to 'lend' to lend.
  - getSenderVersion
```
public final Version getSenderVersion()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'senderVersion'.
    
    Specified by:
    
    getSenderVersion in interface IMessageHeader
    
    Returns:
    
    The value of 'senderVersion'
  - getSenderVersionTo
```
public final void getSenderVersionTo(Version to)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of Version into the provided value.
    IF the value is not set, then the contents of the provided Version are cleared.
    
    Specified by:
    
    getSenderVersionTo in interface IMessageHeader
    
    Parameters:
    
    to - the value to copy into
    
    See Also:
    
    Version.copyInto(Version)
  - takeSenderVersion
```
public final Version takeSenderVersion()
```
    Description copied from interface: IMessageHeader
    
    'Takes' a reference to the senderVersion field from the message.
    NOTE:
    A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.
    An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
    
    Specified by:
    
    takeSenderVersion in interface IMessageHeader
    
    Returns:
    
    a 'taken' reference to the field or null if the field is not set.
  - clearSenderVersion
```
public final void clearSenderVersion()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'senderVersion'.
    
    Specified by:
    
    clearSenderVersion in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setSenderVersion(Version)
  - hasSenderVersion
```
public final boolean hasSenderVersion()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'senderVersion'.
    
    Specified by:
    
    hasSenderVersion in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getSenderVersion()
  - getErrorFieldId
```
public static final int getErrorFieldId()
```
  - setError
```
public final void setError(ErrorContext val)
```
    Description copied from interface: IMessageHeader
    
    Sets the value of 'error'.
    
    Specified by:
    
    setError in interface IMessageHeader
    
    Parameters:
    
    val - The value to set.
  - lendError
```
public final void lendError(ErrorContext val)
```
    Description copied from interface: IMessageHeader
    
    'Lends' a reference of the ErrorContext to the message for this field.
    NOTE:
    It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
    To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
    
    Specified by:
    
    lendError in interface IMessageHeader
    
    Parameters:
    
    val - the value to 'lend' to lend.
  - getError
```
public final ErrorContext getError()
```
    Description copied from interface: IMessageHeader
    
    Gets the value of 'error'.
    
    Specified by:
    
    getError in interface IMessageHeader
    
    Returns:
    
    The value of 'error'
  - getErrorTo
```
public final void getErrorTo(ErrorContext to)
```
    Description copied from interface: IMessageHeader
    
    Copies the value of ErrorContext into the provided value.
    IF the value is not set, then the contents of the provided ErrorContext are cleared.
    
    Specified by:
    
    getErrorTo in interface IMessageHeader
    
    Parameters:
    
    to - the value to copy into
    
    See Also:
    
    ErrorContext.copyInto(ErrorContext)
  - takeError
```
public final ErrorContext takeError()
```
    Description copied from interface: IMessageHeader
    
    'Takes' a reference to the error field from the message.
    NOTE:
    A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.
    An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
    
    Specified by:
    
    takeError in interface IMessageHeader
    
    Returns:
    
    a 'taken' reference to the field or null if the field is not set.
  - clearError
```
public final void clearError()
```
    Description copied from interface: IMessageHeader
    
    Clears the value of 'error'.
    
    Specified by:
    
    clearError in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.setError(ErrorContext)
  - hasError
```
public final boolean hasError()
```
    Description copied from interface: IMessageHeader
    
    Checks for the presence of 'error'.
    
    Specified by:
    
    hasError in interface IMessageHeader
    
    See Also:
    
    IMessageHeader.getError()
  - serializeToByteArray
```
public final byte[] serializeToByteArray()
```
  - serializeToByteBuffer
```
public final ByteBuffer serializeToByteBuffer()
```
  - isBufferBacked
```
public final boolean isBufferBacked()
```
  - getSerializeToNativeLength
```
public final int getSerializeToNativeLength()
```
  - serializeToNative
```
public final int serializeToNative(long address,
                                   int addressOffset)
```
  - deserializeFromByteArray
```
public final MessageHeader deserializeFromByteArray(byte[] array)
```
  - deserializeFromByteBuffer
```
public final MessageHeader deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFromNative
```
public final MessageHeader deserializeFromNative(long address,
                                                 int addressOffset,
                                                 int length)
```
  - isReferenceCounted
```
public final boolean isReferenceCounted()
```
  - acquire
```
public final MessageHeader acquire()
```
  - getOwnerCount
```
public final int getOwnerCount()
```
  - dispose
```
public final void dispose()
```
  - clone
```
public final Object clone()
```
    Creates a clone of this object.
    This method differs from the copy() method in that:
    - For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
    - The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.
    Overrides:
    
    clone in class Object
  - copy
```
public final MessageHeader copy()
```
  - copyInto
```
public final void copyInto(MessageHeader copy)
```
  - isValid
```
public final boolean isValid()
```
    Specified by:
    
    isValid in interface IRogValidatable
  - getValidationErrors
```
public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)
```
    Specified by:
    
    getValidationErrors in interface IRogValidatable
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class MessageHeader

ADM Details

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Constructor Detail

MessageHeader

Method Detail

create

createFromJson

createFromSerializedJson

createFromSerializedJson

createFrom

clearContent

setAsReadOnly

getIsReadOnly

getOriginFieldId

setOrigin

getOrigin

lendOrigin

Usage Notes

setOriginFrom

getOriginTo

setOriginFrom

getOriginTo

getOriginUnsafe

clearOrigin

hasOrigin

getSourceIdFieldId

setSourceId

getSourceId

lendSourceId

Usage Notes

setSourceIdFrom

getSourceIdTo

setSourceIdFrom

getSourceIdTo

getSourceIdUnsafe

clearSourceId

hasSourceId

getChannelIdFieldId

setChannelId

getChannelId

lendChannelId

Usage Notes

setChannelIdFrom

getChannelIdTo

setChannelIdFrom

getChannelIdTo

getChannelIdUnsafe

clearChannelId

hasChannelId

getSessionIdFieldId

setSessionId

getSessionId

lendSessionId

Usage Notes

setSessionIdFrom

getSessionIdTo

setSessionIdFrom

getSessionIdTo

getSessionIdUnsafe

clearSessionId

hasSessionId

getTransactionIdFieldId

setTransactionId

getTransactionId

lendTransactionId

Usage Notes

setTransactionIdFrom

getTransactionIdTo

setTransactionIdFrom

getTransactionIdTo

getTransactionIdUnsafe

clearTransactionId

hasTransactionId

getRequestIdFieldId