View Javadoc

1   /*
2    * $Id: AbstractMessageDispatcherFactory.java 19191 2010-08-25 21:05:23Z tcarlson $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.transport;
12  
13  import org.mule.api.MuleException;
14  import org.mule.api.endpoint.OutboundEndpoint;
15  import org.mule.api.transport.MessageDispatcher;
16  import org.mule.api.transport.MessageDispatcherFactory;
17  import org.mule.util.ClassUtils;
18  
19  /**
20   * <code>AbstractMessageDispatcherFactory</code> is a base implementation of the
21   * <code>MessageDispatcherFactory</code> interface for managing the lifecycle of
22   * message dispatchers.
23   * 
24   * @see MessageDispatcherFactory
25   */
26  public abstract class AbstractMessageDispatcherFactory implements MessageDispatcherFactory
27  {
28  
29      public AbstractMessageDispatcherFactory()
30      {
31          super();
32      }
33  
34      /**
35       * This default implementation of
36       * {@link MessageDispatcherFactory#isCreateDispatcherPerRequest()} returns
37       * <code>false</code>, which means that dispatchers are pooled according to
38       * their lifecycle as described in {@link MessageDispatcher}.
39       * 
40       * @return <code>false</code> by default, unless overwritten by a subclass.
41       */
42      public boolean isCreateDispatcherPerRequest()
43      {
44          return false;
45      }
46  
47      public abstract MessageDispatcher create(OutboundEndpoint endpoint) throws MuleException;
48  
49      public void activate(OutboundEndpoint endpoint, MessageDispatcher dispatcher) throws MuleException
50      {
51          dispatcher.activate();
52      }
53  
54      public void destroy(OutboundEndpoint endpoint, MessageDispatcher dispatcher)
55      {
56          dispatcher.dispose();
57      }
58  
59      public void passivate(OutboundEndpoint endpoint, MessageDispatcher dispatcher)
60      {
61          dispatcher.passivate();
62      }
63  
64      public boolean validate(OutboundEndpoint endpoint, MessageDispatcher dispatcher)
65      {
66          // Unless dispatchers are to be disposed of after every request, we check if
67          // the dispatcher is still valid or has e.g. disposed itself after an
68          // exception.
69          return (this.isCreateDispatcherPerRequest() ? false : dispatcher.validate());
70      }
71  
72      @Override
73      public String toString()
74      {
75          final StringBuffer sb = new StringBuffer(60);
76          sb.append(ClassUtils.getSimpleName(this.getClass()));
77          sb.append("{this=").append(Integer.toHexString(System.identityHashCode(this)));
78          sb.append(", createDispatcherPerRequest=").append(this.isCreateDispatcherPerRequest());
79          sb.append('}');
80          return sb.toString();
81      }
82  
83  }