Package com.yahoo.documentapi.messagebus.protocol

Class DocumentReply

java.lang.Object
com.yahoo.messagebus.Routable
com.yahoo.messagebus.Reply
com.yahoo.documentapi.messagebus.protocol.DocumentReply
Direct Known Subclasses:
CreateVisitorReply, DocumentAcceptedReply, DocumentIgnoredReply, GetBucketListReply, GetBucketStateReply, StatBucketReply, WrongDistributionReply
public class DocumentReply extends com.yahoo.messagebus.Reply
This class implements a generic document protocol reply that can be reused by document messages that require no special reply implementation while still allowing applications to distinguish between types.
Author:
Simon Thoresen Hult

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentReply(int type)
    Constructs a new reply of given type.

  • Method Summary

    Modifier and Type
    Method
    Description
    DocumentProtocol.Priority
    getPriority()
    Returns the priority tag for this message.
    com.yahoo.text.Utf8String
    getProtocol()
     
    final int
    getType()
     
    void
    setPriority(DocumentProtocol.Priority priority)
    Sets the priority tag for this message.

    Methods inherited from class com.yahoo.messagebus.Reply

    addError, getError, getErrorCodes, getErrors, getMessage, getNumErrors, getRetryDelay, hasErrors, hasFatalErrors, setMessage, setRetryDelay, swapState

    Methods inherited from class com.yahoo.messagebus.Routable

    discard, getCallStack, getContext, getTrace, popHandler, pushHandler, setContext

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • DocumentReply

      public DocumentReply(int type)
      Constructs a new reply of given type.
      Parameters:
      type - The type code to assign to this.

  • Method Details

    • getPriority

      public DocumentProtocol.Priority getPriority()
      Returns the priority tag for this message.
      Returns:
      The priority.

    • setPriority

      public void setPriority(DocumentProtocol.Priority priority)
      Sets the priority tag for this message.
      Parameters:
      priority - The priority to set.

    • getProtocol

      public com.yahoo.text.Utf8String getProtocol()
      Specified by:
      getProtocol in class com.yahoo.messagebus.Routable

    • getType

      public final int getType()
      Specified by:
      getType in class com.yahoo.messagebus.Routable