net.sf.eBus.client.sysmessages

Class PauseReply

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ESystemMessage

net.sf.eBus.client.sysmessages.AbstractLogonMessage

net.sf.eBus.client.sysmessages.PauseReply

All Implemented Interfaces:

Serializable

public final class PauseReply
extends AbstractLogonMessage
implements Serializable

This message is sent is response to a PauseRequest. This response specifies whether the pause request is accepted or not. If accepted, then this response provides the allowed pause duration and backlog size. These values will be ≤ to the requested values, never greater than. The requested discard policy is always accepted.

If rejected, then replyReason provided human-readable text explaining the rejection. Please note that replyStatus will either be EReplyMessage.ReplyStatus.OK_FINAL (accepted) or EReplyMessage.ReplyStatus.ERROR (rejected); it will never be set to EReplyMessage.ReplyStatus.OK_CONTINUING.

Author:

Charles W. Rapp

See Also:

PauseRequest, LogonReply, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PauseReply.Builder Class used to create PauseReply messages.

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
int	maximumBacklogSize Requesting the far-end store up to this many undelivered messages before beginning to discard messages.
Duration	pauseTime Requesting a connection pause lasting for this duration.
String	replyReason The reason for a EReplyMessage.ReplyStatus.ERROR reply status.
EReplyMessage.ReplyStatus	replyStatus The current request handling status.

Fields inherited from class net.sf.eBus.client.sysmessages.AbstractLogonMessage

eid

Fields inherited from class net.sf.eBus.messages.ESystemMessage

SYSTEM_SUBJECT

Fields inherited from class net.sf.eBus.messages.EMessage

subject, timestamp

Fields inherited from class net.sf.eBus.messages.EMessageObject

MAX_FIELDS

Method Summary

Modifier and Type	Method and Description
static PauseReply.Builder	builder() Returns a new instance of the PauseReply message builder.
String	toString() Returns a human-readable text version of this message.

Methods inherited from class net.sf.eBus.client.sysmessages.AbstractLogonMessage

equals, hashCode

Methods inherited from class net.sf.eBus.messages.EMessage

isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

replyStatus

public final EReplyMessage.ReplyStatus replyStatus

The current request handling status. If EReplyMessage.ReplyStatus.ERROR, then replyReason will contain text explaining why the request was rejected.

replyReason

@Optional
public final String replyReason

The reason for a EReplyMessage.ReplyStatus.ERROR reply status. May be null or empty.

pauseTime

public final Duration pauseTime

Requesting a connection pause lasting for this duration. The far-end may not accept this time and require a shorter pause time

maximumBacklogSize

public final int maximumBacklogSize

Requesting the far-end store up to this many undelivered messages before beginning to discard messages. Which messages are to be discarded is based on the PauseRequest.discardPolicy. Please note that this size is a suggestion. The far-end response may specify smaller backlog size.

Method Detail

toString

public String toString()

Description copied from class: AbstractLogonMessage

Returns a human-readable text version of this message.

Overrides:

toString in class AbstractLogonMessage

Returns:

text version of this message.

builder

public static PauseReply.Builder builder()

Returns a new instance of the PauseReply message builder.

Returns:

message builder instance.