KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > codehaus > loom > components > manager > AbstractJMXManager


1 /* ====================================================================
2  * Loom Software License, version 1.1
3  *
4  * Copyright (c) 2003, Loom Group. All rights reserved.
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. Neither the name of the Loom Group nor the name "Loom" nor
18  * the names of its contributors may be used to endorse or promote
19  * products derived from this software without specific prior
20  * written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  * ====================================================================
36  *
37  * Loom includes code from the Apache Software Foundation
38  *
39  * ====================================================================
40  * The Apache Software License, Version 1.1
41  *
42  * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
43  * reserved.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  *
49  * 1. Redistributions of source code must retain the above copyright
50  * notice, this list of conditions and the following disclaimer.
51  *
52  * 2. Redistributions in binary form must reproduce the above copyright
53  * notice, this list of conditions and the following disclaimer in
54  * the documentation and/or other materials provided with the
55  * distribution.
56  *
57  * 3. The end-user documentation included with the redistribution,
58  * if any, must include the following acknowledgment:
59  * "This product includes software developed by the
60  * Apache Software Foundation (http://www.apache.org/)."
61  * Alternately, this acknowledgment may appear in the software
62  * itself, if and wherever such third-party acknowledgments
63  * normally appear.
64  *
65  * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
66  * must not be used to endorse or promote products derived from this
67  * software without prior written permission. For written
68  * permission, please contact apache@apache.org.
69  *
70  * 5. Products derived from this software may not be called "Apache",
71  * nor may "Apache" appear in their name, without prior written
72  * permission of the Apache Software Foundation.
73  *
74  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
75  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
76  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
77  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
78  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
79  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
80  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
81  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
82  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
83  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
84  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
85  * SUCH DAMAGE.
86  */
87 package org.codehaus.loom.components.manager;
88
89 import javax.management.MBeanServer JavaDoc;
90 import javax.management.MalformedObjectNameException JavaDoc;
91 import javax.management.ObjectName JavaDoc;
92
93 import org.codehaus.loom.interfaces.ContainerConstants;
94 import org.codehaus.loom.interfaces.LoomException;
95 import org.codehaus.metaclass.jmx.MBeanBinder;
96 import org.codehaus.spice.salt.i18n.ResourceManager;
97 import org.codehaus.spice.salt.i18n.Resources;
98
99
100 /**
101  * An abstract class via which JMX Managers can extend.
102  *
103  * @author Peter Donald
104  * @author <a HREF="mailto:Huw@mmlive.com">Huw Roberts</a>
105  * @version $Revision: 1.4 $ $Date: 2004/08/17 23:14:32 $
106  */
107 public abstract class AbstractJMXManager
108     extends AbstractSystemManager
109 {
110     private static final Resources REZ =
111         ResourceManager.getPackageResources( AbstractJMXManager.class );
112
113     private static final MBeanBinder BINDER = new MBeanBinder();
114     private MBeanServer JavaDoc m_mBeanServer;
115
116     public void initialize()
117         throws Exception JavaDoc
118     {
119         super.initialize();
120         m_mBeanServer = createMBeanServer();
121     }
122
123     public void dispose()
124     {
125         m_mBeanServer = null;
126         super.dispose();
127     }
128
129     /**
130      * Export the object to the particular management medium using the supplied
131      * object and interfaces. This needs to be implemented by subclasses.
132      *
133      * @param name the name of object
134      * @param object the object
135      * @return the exported object
136      * @throws LoomException if an error occurs
137      */
138     protected Object JavaDoc export( final String JavaDoc name,
139                              final Object JavaDoc object )
140         throws LoomException
141     {
142         try
143         {
144             BINDER.bindMBean( object,
145                               createObjectName( name ),
146                               getMBeanServer() );
147             return object;
148         }
149         catch( final Exception JavaDoc e )
150         {
151             final String JavaDoc message = REZ.format( "jmxmanager.error.export.fail",
152                                                name );
153             getLogger().error( message, e );
154             throw new LoomException( message, e );
155         }
156     }
157
158     /**
159      * Stop the exported object from being managed.
160      *
161      * @param name the name of object
162      * @param exportedObject the object return by export
163      * @throws LoomException if an error occurs
164      */
165     protected void unexport( final String JavaDoc name,
166                              final Object JavaDoc exportedObject )
167         throws LoomException
168     {
169         try
170         {
171             BINDER.unbindMBean( exportedObject,
172                                 createObjectName( name ),
173                                 getMBeanServer() );
174         }
175         catch( final Exception JavaDoc e )
176         {
177             final String JavaDoc message =
178                 REZ.format( "jmxmanager.error.unexport.fail", name );
179             throw new LoomException( message, e );
180         }
181     }
182
183     protected MBeanServer JavaDoc getMBeanServer()
184     {
185         return m_mBeanServer;
186     }
187
188     /**
189      * Creates a new MBeanServer. The subclass should implement this to create
190      * specific MBeanServer.
191      */
192     protected abstract MBeanServer JavaDoc createMBeanServer()
193         throws Exception JavaDoc;
194
195     /**
196      * Create JMX name for object.
197      *
198      * @param name the name of object
199      * @return the {@link ObjectName} representing object
200      * @throws MalformedObjectNameException if malformed name
201      */
202     private ObjectName JavaDoc createObjectName( final String JavaDoc name )
203         throws MalformedObjectNameException JavaDoc
204     {
205         return new ObjectName JavaDoc( ContainerConstants.SOFTWARE + ":" + name );
206     }
207 }
208
Popular Tags