Package com.yahoo.documentapi.messagebus.protocol

Class DocumentMessage

java.lang.Object
com.yahoo.messagebus.Routable
com.yahoo.messagebus.Message
com.yahoo.documentapi.messagebus.protocol.DocumentMessage
Direct Known Subclasses:
CreateVisitorMessage, DestroyVisitorMessage, GetBucketListMessage, GetBucketStateMessage, GetDocumentMessage, RemoveLocationMessage, StatBucketMessage, TestAndSetMessage, VisitorMessage
public abstract class DocumentMessage extends com.yahoo.messagebus.Message
Author:
Simon Thoresen Hult

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentMessage()
    Constructs a new message with no content.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract DocumentReply
    createReply()
    Creates and returns a reply to this message.
    int
    getApproxSize()
     
    LoadType
    getLoadType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    load types are deprecated
    DocumentProtocol.Priority
    getPriority()
    Deprecated, for removal: This API element is subject to removal in a future version.
    explicit operation priority is deprecated
    com.yahoo.text.Utf8String
    getProtocol()
     
    void
    setLoadType(LoadType loadType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    load types are deprecated
    void
    setPriority(DocumentProtocol.Priority priority)
    Deprecated, for removal: This API element is subject to removal in a future version.
    specifying explicit operation priority is deprecated
    void
    swapState(com.yahoo.messagebus.Routable rhs)
     

    Methods inherited from class com.yahoo.messagebus.Message

    getBucketSequence, getRetry, getRetryEnabled, getRoute, getSequenceId, getTimeReceived, getTimeRemaining, getTimeRemainingNow, hasBucketSequence, hasSequenceId, isExpired, setRetry, setRetryEnabled, setRoute, setTimeReceived, setTimeReceivedNow, setTimeRemaining

    Methods inherited from class com.yahoo.messagebus.Routable

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DocumentMessage

      public DocumentMessage()
      Constructs a new message with no content.

  • Method Details

    • createReply

      public abstract DocumentReply createReply()
      Creates and returns a reply to this message.
      Returns:
      The created reply.

    • swapState

      public void swapState(com.yahoo.messagebus.Routable rhs)
      Overrides:
      swapState in class com.yahoo.messagebus.Message

    • getPriority

      @Deprecated(forRemoval=true) public DocumentProtocol.Priority getPriority()
      Deprecated, for removal: This API element is subject to removal in a future version.
      explicit operation priority is deprecated
      Returns the priority tag for this message. This is an optional tag added for VDS that is not interpreted by the document protocol.
      Returns:
      The priority.

    • setPriority

      @Deprecated(forRemoval=true) public void setPriority(DocumentProtocol.Priority priority)
      Deprecated, for removal: This API element is subject to removal in a future version.
      specifying explicit operation priority is deprecated
      Sets the priority tag for this message.
      Parameters:
      priority - The priority to set.

    • getLoadType

      @Deprecated(forRemoval=true) public LoadType getLoadType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      load types are deprecated

    • setLoadType

      @Deprecated(forRemoval=true) public void setLoadType(LoadType loadType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      load types are deprecated

    • getApproxSize

      public int getApproxSize()
      Overrides:
      getApproxSize in class com.yahoo.messagebus.Message

    • getProtocol

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