Chain of Responsibility

Intent

Problem

There is a potentially variable number of "handler" or "processing element" or "node" objects, and a stream of requests that must be handled. Need to efficiently process the requests without hard-wiring handler relationships and precedence, or request-to-handler mappings.

Structure Summary

Structure category:  
recursive composition
Similar patterns:   Composite   Decorator   Interpreter

Discussion

Encapsulate the processing elements inside a "pipeline" abstraction; and have clients "launch and leave" their requests at the entrance to the pipeline.

The pattern chains the receiving objects together, and then passes any request messages from object to object until it reaches an object capable of handling the message. The number and type of handler objects isn't known a priori, they can be configured dynamically. The chaining mechanism uses recursive composition to allow an unlimited number of handlers to be linked.

Chain of Responsibility simplifies object interconnections. Instead of senders and receivers maintaining references to all candidate receivers, each sender keeps a single reference to the head of the chain, and each receiver keeps a single reference to its immediate successor in the chain.

Make sure there exists a "safety net" to "catch" any requests which go unhandled.

Do not use Chain of Responsibility when each request is only handled by one handler, or, when the client object knows which service object should handle the request.

Structure

The derived classes know how to satisfy Client requests. If the "current" object is not available or sufficient, then it delegates to the base class, which delegates to the "next" object, and the circle of life continues.

Multiple handlers could contribute to the handling of each request. The request can be passed down the entire length of the chain, with the last link being careful not to delegate to a "null next".

Example

The Chain of Responsibility pattern avoids coupling the sender of a request to the receiver by giving more than one object a chance to handle the request. Mechanical coin sorting banks use the Chain of Responsibility. Rather than having a separate slot for each coin denomination coupled with a receptacle for the denomination, a single slot is used. When the coin is dropped, the coin is routed to the appropriate receptacle by the mechanical mechanisms within the bank. [Michael Duell, "Non-software examples of software design patterns", Object Magazine, Jul 97, p54]

Check list

  1. The base class maintains a "next" pointer.
  2. Each derived class implements its contribution for handling the request.
  3. If the request needs to be "passed on", then the derived class "calls back" to the base class, which delegates to the "next" pointer.
  4. The client (or some third party) creates and links the chain (which may include a link from the last node to the root node).
  5. The client "launches and leaves" each request with the root of the chain.
  6. Recursive delegation produces the illusion of magic.

Before and after

BeforeAfter
// Before - the client is responsible for stepping
// through the "list" of Handler objects, and deter-
// mining when the request has been handled.
//
// After - the client submits each request to the
// "chain" abstraction and is decoupled from all sub-
// sequent processing.

class Handler {
   private static java.util.Random s_rn =
                     new java.util.Random();
   private static int s_next = 1;
   private int m_id = s_next++;

   public boolean handle( int num ) {
      if (s_rn.nextInt(4) != 0) {
         System.out.print( m_id + "-busy  " );
         return false;
      }
      System.out.println( m_id + "-handled-" + num );
      return true;
}  }

public class ChainDemo {
   public static void main( String[] args ) {
      Handler[] nodes = { new Handler(), new Handler(),
                          new Handler(), new Handler() };
      for (int i=1, j; i < 10; i++) {
         j = 0;
         while ( ! nodes[j].handle( i ))
            j = (j+1) % nodes.length;
}  }  }

// 1-busy  2-busy  3-busy  4-busy  1-busy  2-handled-1
// 1-busy  2-busy  3-handled-2
// 1-busy  2-busy  3-busy  4-handled-3
// 1-busy  2-busy  3-busy  4-busy  1-busy  2-busy
//     3-handled-4
// 1-busy  2-busy  3-handled-5
// 1-handled-6
// 1-busy  2-handled-7
// 1-busy  2-busy  3-busy  4-busy  1-busy  2-busy
//     3-busy  4-handled-8
// 1-busy  2-handled-9
  
class Handler {
   private static java.util.Random s_rn =
                     new java.util.Random();
   private static int     s_next = 1;
   private int     m_id = s_next++;
   private Handler m_next;

   public void add( Handler next ) {
      if (m_next == null)
         m_next = next;
      else
         m_next.add( next );
   }
   public void wrap_around( Handler root ) {
      if (m_next == null)
         m_next = root;
      else
         m_next.wrap_around( root );
   }
   public void handle( int num ) {
      if (s_rn.nextInt(4) != 0) {
         System.out.print( m_id + "-busy  " );
         m_next.handle( num );
      } else
         System.out.println( m_id + "-handled-" + num );
}  }

public class ChainDemo {
   public static void main( String[] args ) {
      Handler chain_root = new Handler();
      chain_root.add( new Handler() );
      chain_root.add( new Handler() );
      chain_root.add( new Handler() );
      chain_root.wrap_around( chain );
      for (int i=1; i < 10; i++)
         chain_root.handle( i );
}  }

// 1-busy  2-busy  3-handled-1
// 1-busy  2-busy  3-busy  4-busy  1-handled-2
// 1-busy  2-busy  3-busy  4-busy  1-busy  2-busy
//     3-busy  4-busy  1-handled-3
// 1-busy  2-handled-4
// 1-busy  2-busy  3-busy  4-handled-5
// 1-busy  2-busy  3-busy  4-busy  1-busy  2-handled-6
// 1-busy  2-handled-7
// 1-handled-8
// 1-busy  2-busy  3-handled-9

Rules of thumb

Chain of Responsibility, Command, Mediator, and Observer, address how you can decouple senders and receivers, but with different trade-offs. Chain of Responsibility passes a sender request along a chain of potential receivers.

Chain of Responsibility can use Command to represent requests as objects. [GoF, p349]

Chain of Responsibility is often applied in conjunction with Composite. There, a component's parent can act as its successor. [GoF, p232]