Package com.yahoo.documentapi.messagebus
Class MessageBusParams
java.lang.Object
com.yahoo.documentapi.DocumentAccessParams
com.yahoo.documentapi.messagebus.MessageBusParams
- Author:
- Einar M R Rosenvinge
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncom.yahoo.messagebus.MessageBusParams
Returns the params object used to instantiate the message bus.Returns the id to resolve to protocol config.getRoute()
Returns the route string that all requests will be sent to.Returns the id to resolve to routing config.com.yahoo.messagebus.network.rpc.RPCNetworkParams
Returns the params object used to instantiate the rpc network layer for message bus.com.yahoo.messagebus.SourceSessionParams
Returns a reference to the extended source session params object.int
Returns the trace level to use when sending.setDocumentProtocolPoliciesConfig
(DocumentProtocolPoliciesConfig policiesConfig, com.yahoo.vespa.config.content.DistributionConfig distributionConfig) Sets the config used by theDocumentProtocol
policies.setMessageBusParams
(com.yahoo.messagebus.MessageBusParams params) Sets the params object used to instantiate the message bus.setProtocolConfigId
(String configId) Sets the id to resolve to protocol config.Sets the route string to send all requests to.setRouteForGet
(String route) setRouteName
(String routeName) Sets the name of the route to send appropriate requests to.setRouteNameForGet
(String routeName) setRoutingConfigId
(String configId) Sets the id to resolve to routing config.setRPCNetworkParams
(com.yahoo.messagebus.network.rpc.RPCNetworkParams params) Sets the params object used to instantiate the rpc network layer for message bus.setSourceSessionParams
(com.yahoo.messagebus.SourceSessionParams params) Sets the extended source session params.setTraceLevel
(int traceLevel) Sets the trace level to use when sending.Methods inherited from class com.yahoo.documentapi.DocumentAccessParams
documentmanagerConfig, getDocumentManagerConfigId, setDocumentmanagerConfig, setDocumentManagerConfigId
-
Constructor Details
-
MessageBusParams
public MessageBusParams()
-
-
Method Details
-
getRoutingConfigId
Returns the id to resolve to routing config.- Returns:
- The config id.
-
setRoutingConfigId
Sets the id to resolve to routing config. This has a proper default value that holds for Vespa applications, and can therefore be left unset.- Parameters:
configId
- The config id.- Returns:
- This object for chaining.
-
getProtocolConfigId
Returns the id to resolve to protocol config.- Returns:
- The config id.
-
setProtocolConfigId
Sets the id to resolve to protocol config. This has a proper default value that holds for Vespa applications, and can therefore be left usnet.- Parameters:
configId
- The config id.- Returns:
- This, to allow chaining.
-
setDocumentProtocolPoliciesConfig
public MessageBusParams setDocumentProtocolPoliciesConfig(DocumentProtocolPoliciesConfig policiesConfig, com.yahoo.vespa.config.content.DistributionConfig distributionConfig) Sets the config used by theDocumentProtocol
policies. -
setRouteName
Sets the name of the route to send appropriate requests to. This is a convenience method for prefixing a route with "route:", and usingsetRoute(java.lang.String)
instead.- Parameters:
routeName
- The route name.- Returns:
- This object for chaining.
-
setRoute
Sets the route string to send all requests to. This string will be parsed as a route string, so setting a route name directly will not necessarily have the intended consequences. Use "route:<routename>" syntax for route names, or the convenience methodsetRouteName(java.lang.String)
for this.- Parameters:
route
- The route string.- Returns:
- This object for chaining.
-
setRouteNameForGet
-
setRouteForGet
-
getRoute
Returns the route string that all requests will be sent to.- Returns:
- The route string.
-
getRouteForGet
-
getTraceLevel
public int getTraceLevel()Returns the trace level to use when sending.- Returns:
- The trace level.
-
setTraceLevel
Sets the trace level to use when sending.- Parameters:
traceLevel
- The trace level.- Returns:
- This object for chaining.
-
getRPCNetworkParams
public com.yahoo.messagebus.network.rpc.RPCNetworkParams getRPCNetworkParams()Returns the params object used to instantiate the rpc network layer for message bus.- Returns:
- The params object.
-
setRPCNetworkParams
public MessageBusParams setRPCNetworkParams(com.yahoo.messagebus.network.rpc.RPCNetworkParams params) Sets the params object used to instantiate the rpc network layer for message bus.- Parameters:
params
- The params object.- Returns:
- This object for chaining.
-
getMessageBusParams
public com.yahoo.messagebus.MessageBusParams getMessageBusParams()Returns the params object used to instantiate the message bus.- Returns:
- The params object.
-
setMessageBusParams
Sets the params object used to instantiate the message bus.- Parameters:
params
- The params object.- Returns:
- This object for chaining.
-
getSourceSessionParams
public com.yahoo.messagebus.SourceSessionParams getSourceSessionParams()Returns a reference to the extended source session params object.- Returns:
- The params object.
-
setSourceSessionParams
Sets the extended source session params.- Parameters:
params
- The params object.- Returns:
- This object for chaining.
-