Package com.yahoo.documentapi.messagebus.protocol

Interface RoutingPolicyFactory

public interface RoutingPolicyFactory

This interface defines the necessary methods of a routing policy factory that can be plugged into a DocumentProtocol using the DocumentProtocol.putRoutingPolicyFactory(String, RoutingPolicyFactory) method.

Author:

Simon Thoresen Hult

Method Summary

Modifier and Type	Method	Description
DocumentProtocolRoutingPolicy	createPolicy(String param)	This method creates and returns a routing policy that corresponds to the implementing class, using the given parameter string.

Method Details

createPolicy

DocumentProtocolRoutingPolicy createPolicy(String param)

This method creates and returns a routing policy that corresponds to the implementing class, using the given parameter string. There is only ever one instance of a routing policy for a given name and parameter combination, and because of this the policies must be stateless beyond what can be derived from the parameter string. Because there is only a single thread running route resolution within message bus, it is not necessary to make policies thread-safe. For more information see RoutingPolicy. Do NOT throw exceptions out of this method because that will cause the running thread to die, just return null to signal failure instead.

Parameters:

param - The parameter to use when creating the policy.

Returns:

The created routing policy.