1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.deploy.hot;
24  
25  import com.liferay.portal.kernel.messaging.DestinationNames;
26  import com.liferay.portal.kernel.messaging.MessageBusUtil;
27  import com.liferay.portal.kernel.messaging.MessageListener;
28  import com.liferay.portal.kernel.servlet.ServletContextUtil;
29  import com.liferay.portal.kernel.util.WebKeys;
30  
31  import java.lang.reflect.Field;
32  
33  import java.util.ArrayList;
34  import java.util.List;
35  import java.util.Set;
36  
37  import javax.servlet.ServletContext;
38  
39  /**
40   * <a href="BaseHotDeployListener.java.html"><b><i>View Source</i></b></a>
41   *
42   * @author Brian Wing Shun Chan
43   */
44  public abstract class BaseHotDeployListener implements HotDeployListener {
45  
46      public void throwHotDeployException(
47              HotDeployEvent event, String msg, Throwable t)
48          throws HotDeployException {
49  
50          ServletContext servletContext = event.getServletContext();
51  
52          String servletContextName = servletContext.getServletContextName();
53  
54          throw new HotDeployException(msg + servletContextName, t);
55      }
56  
57      protected void registerClpMessageListeners(
58              ServletContext servletContext, ClassLoader portletClassLoader)
59          throws Exception {
60  
61          List<MessageListener> clpMessageListeners =
62              (List<MessageListener>)servletContext.getAttribute(
63                  WebKeys.CLP_MESSAGE_LISTENERS);
64  
65          if (clpMessageListeners != null) {
66              return;
67          }
68  
69          clpMessageListeners = new ArrayList<MessageListener>();
70  
71          Set<String> classNames = ServletContextUtil.getClassNames(
72              servletContext);
73  
74          for (String className : classNames) {
75              if (className.endsWith(".ClpMessageListener")) {
76                  Class<?> clpMessageListenerClass = portletClassLoader.loadClass(
77                      className);
78  
79                  MessageListener clpMessageListener =
80                      (MessageListener)clpMessageListenerClass.newInstance();
81  
82                  Field servletContextNameField =
83                      clpMessageListenerClass.getField(
84                          "SERVLET_CONTEXT_NAME");
85  
86                  String clpServletContextName = servletContextNameField.get(
87                      clpMessageListener).toString();
88  
89                  if (clpServletContextName.equals(
90                          servletContext.getServletContextName())) {
91  
92                      continue;
93                  }
94  
95                  clpMessageListeners.add(clpMessageListener);
96  
97                  MessageBusUtil.registerMessageListener(
98                      DestinationNames.HOT_DEPLOY, clpMessageListener);
99              }
100         }
101 
102         servletContext.setAttribute(
103             WebKeys.CLP_MESSAGE_LISTENERS, clpMessageListeners);
104     }
105 
106     protected void unregisterClpMessageListeners(ServletContext servletContext)
107         throws Exception {
108 
109         List<MessageListener> clpMessageListeners =
110             (List<MessageListener>)servletContext.getAttribute(
111                 WebKeys.CLP_MESSAGE_LISTENERS);
112 
113         if (clpMessageListeners != null) {
114             servletContext.removeAttribute(WebKeys.CLP_MESSAGE_LISTENERS);
115 
116             for (MessageListener clpMessageListener : clpMessageListeners) {
117                 MessageBusUtil.unregisterMessageListener(
118                     DestinationNames.HOT_DEPLOY, clpMessageListener);
119             }
120         }
121     }
122 
123 }