com.neeve.service.messages

Interface IFirstRequest

All Superinterfaces:

CopyableMessageView<IFirstRequest>, IRogCopyableNode<IFirstRequest>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IStoreObject, IStoreObjectMetadata, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:

FirstRequest

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Fri Dec 05 11:53:59 EST 2025")
 @AdmGenerated(compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 11:53 AM",
              buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding")
public interface IFirstRequest
extends IRogNode, IRogMessage, IRogCopyableNode<IFirstRequest>

The 'FirstRequest' type.

ADM Details

ADM Type	Message
Factory	MessageFactory

ADM Field Summary

Field	Type	Id	Description
header	MessageHeader	32737	No doc provided.

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode

IRogNode.PoolingListener

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject

IStoreObject.EncodingType

Method Summary

Modifier and Type	Method and Description
void	clearHeader() Clears the value of 'header'.
FirstRequest	copy() Creates a copy of this FirstRequest.
void	copyInto(FirstRequest target) Copies the contents of this FirstRequest into the target.
MessageHeader	getHeader() Gets the value of 'header'.
void	getHeaderTo(MessageHeader val) Copies the value of MessageHeader into the provided value.
boolean	hasHeader() Checks for the presence of 'header'.
void	lendHeader(MessageHeader val) 'Lends' a reference of the MessageHeader to the message for this field.
void	setHeader(MessageHeader val) Sets the value of 'header'.
MessageHeader	takeHeader() 'Takes' a reference to the header field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, serialize, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setHeader

void setHeader(MessageHeader val)

Sets the value of 'header'.

Parameters:

val - The value to set.

lendHeader

void lendHeader(MessageHeader val)

'Lends' a reference of the MessageHeader 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.

Parameters:

val - the value to 'lend' to lend.

getHeader

MessageHeader getHeader()

Gets the value of 'header'.

Returns:

The value of 'header'

getHeaderTo

void getHeaderTo(MessageHeader val)

Copies the value of MessageHeader into the provided value.

IF the value is not set, then the contents of the provided MessageHeader are cleared.

Parameters:

val - the value to copy into

See Also:

MessageHeader.copyInto(MessageHeader)

takeHeader

MessageHeader takeHeader()

'Takes' a reference to the header 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.

Returns:

a 'taken' reference to the field or null if the field is not set.

hasHeader

boolean hasHeader()

Checks for the presence of 'header'.

See Also:

getHeader()

clearHeader

void clearHeader()

Clears the value of 'header'.

See Also:

setHeader(MessageHeader)

copy

FirstRequest copy()

Creates a copy of this FirstRequest.

The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this FirstRequest's embedded entity fields.

The returned copy will be writeable even if this FirstRequest is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Specified by:

copy in interface CopyableMessageView<IFirstRequest>

Specified by:

copy in interface IRogCopyableNode<IFirstRequest>

Returns:

A copy of this FirstRequest.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(FirstRequest target)

Copies the contents of this FirstRequest into the target.

The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this FirstRequest's embedded entity fields.

The returned copy will be writeable even if this FirstRequest is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Parameters:

target - The target to copy into which must not be null or read only.