Class DocumentProtocol

  • All Implemented Interfaces:
    com.yahoo.config.ConfigInstance.Producer, com.yahoo.documentapi.messagebus.protocol.DocumentrouteselectorpolicyConfig.Producer, Protocol

    public final class DocumentProtocol
    extends java.lang.Object
    implements Protocol, com.yahoo.documentapi.messagebus.protocol.DocumentrouteselectorpolicyConfig.Producer
    This class is responsible for generating all hops and routes for the Document protocol running on message bus. All the code within could really be part of Routing, but it has been partitioned out to allow better readability and also more easily maintainable as the number of protocols increase.
    Author:
    Simon Thoresen Hult
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.yahoo.messagebus.routing.ApplicationSpec getApplicationSpec()
      Returns the specification of the application as seen by this protocol.
      void getConfig​(com.yahoo.documentapi.messagebus.protocol.DocumentrouteselectorpolicyConfig.Builder builder)  
      static java.lang.String getDirectRouteName​(java.lang.String configId)  
      static java.lang.String getIndexedRouteName​(java.lang.String configId)  
      com.yahoo.messagebus.routing.RoutingTableSpec getRoutingTableSpec()
      Returns the specification for the routing table of this protocol.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getIndexedRouteName

        public static java.lang.String getIndexedRouteName​(java.lang.String configId)
      • getDirectRouteName

        public static java.lang.String getDirectRouteName​(java.lang.String configId)
      • getConfig

        public void getConfig​(com.yahoo.documentapi.messagebus.protocol.DocumentrouteselectorpolicyConfig.Builder builder)
        Specified by:
        getConfig in interface com.yahoo.documentapi.messagebus.protocol.DocumentrouteselectorpolicyConfig.Producer
      • getApplicationSpec

        public com.yahoo.messagebus.routing.ApplicationSpec getApplicationSpec()
        Description copied from interface: Protocol
        Returns the specification of the application as seen by this protocol.
        Specified by:
        getApplicationSpec in interface Protocol
      • getRoutingTableSpec

        public com.yahoo.messagebus.routing.RoutingTableSpec getRoutingTableSpec()
        Description copied from interface: Protocol
        Returns the specification for the routing table of this protocol.
        Specified by:
        getRoutingTableSpec in interface Protocol