001: /*
002: * BEGIN_HEADER - DO NOT EDIT
003: *
004: * The contents of this file are subject to the terms
005: * of the Common Development and Distribution License
006: * (the "License"). You may not use this file except
007: * in compliance with the License.
008: *
009: * You can obtain a copy of the license at
010: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
011: * See the License for the specific language governing
012: * permissions and limitations under the License.
013: *
014: * When distributing Covered Code, include this CDDL
015: * HEADER in each file and include the License file at
016: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
017: * If applicable add the following below this CDDL HEADER,
018: * with the fields enclosed by brackets "[]" replaced with
019: * your own identifying information: Portions Copyright
020: * [year] [name of copyright owner]
021: */
022:
023: /*
024: * @(#)JBIJMXObjectNames.java
025: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
026: *
027: * END_HEADER - DO NOT EDIT
028: */
029: package com.sun.jbi.ui.common;
030:
031: import javax.management.MalformedObjectNameException;
032: import javax.management.ObjectName;
033:
034: /**
035: * This class provides the JBI MBean ObjectNames
036: *
037: * @author Sun Microsystems, Inc.
038: */
039: public final class JBIJMXObjectNames {
040:
041: /** JMX Domain name for the jbi jmx server */
042: public static final String JMX_JBI_DOMAIN = "com.sun.jbi";
043:
044: /** JBI MBean Object type */
045: public static final String CONTROL_TYPE_KEY = "ControlType";
046:
047: /** JBI MBean Object type value */
048: public static final String DEPLOYER_CONTROL_TYPE_VALUE = "Deployer";
049:
050: /** JBI MBean Object type value */
051: public static final String INSTALLER_CONTROL_TYPE_VALUE = "Installer";
052:
053: /** JBI MBean Object type value */
054: public static final String LIFECYCLE_CONTROL_TYPE_VALUE = "Lifecycle";
055:
056: /** JBI MBean Object type value */
057: public static final String CONTROLLER_CONTROL_TYPE_VALUE = "Controller";
058:
059: /** JBI MBean Object type value */
060: public static final String ADMIN_SERVICE_CONTROL_TYPE_VALUE = "AdministrationService";
061:
062: /** JBI MBean Object type */
063: public static final String COMPONENT_TYPE_KEY = "ComponentType";
064:
065: /** JBI MBean Object type value */
066: public static final String SYSTEM_COMPONENT_TYPE_VALUE = "System";
067:
068: /** JBI MBean Object type value */
069: public static final String INSTALL_COMPONENT_TYPE_VALUE = "Installed";
070:
071: /** JBI MBean Object type */
072: public static final String INSTALLED_TYPE_KEY = "InstalledType";
073:
074: /** JBI MBean Object type */
075: public static final String ENGINE_INSTALLED_TYPE_VALUE = "Engine";
076:
077: /** JBI MBean Object type */
078: public static final String BINDING_INSTALLED_TYPE_VALUE = "Binding";
079:
080: /** JBI MBean Object type name */
081: public static final String COMPONENT_ID_KEY = "ComponentName";
082:
083: /** JBI Service Names */
084: /** JBI MBean Object type name */
085: public static final String SERVICE_NAME_KEY = "ServiceName";
086:
087: /** Service Names */
088: public static final String ADMIN_SERVICE = "AdminService";
089:
090: /** Service Names */
091: public static final String DEPLOYMENT_SERVICE = "DeploymentService";
092:
093: /** Service Names */
094: public static final String INSTALLATION_SERVICE = "InstallationService";
095:
096: /** Service Names */
097: public static final String CONFIGURATION_SERVICE = "ConfigurationService";
098:
099: /** Service Names */
100: public static final String JBI_ADMIN_UI_SERVICE = "JbiAdminUiService";
101:
102: /** Service Names */
103: public static final String JBI_REFERENCE_ADMIN_UI_SERVICE = "JbiReferenceAdminUiService";
104:
105: /** statistics service */
106: public static final String JBI_STATISTICS_SERVICE = "JbiStatisticsService";
107:
108: /** Service Names */
109: public static final String JAVA_CAPS_MANAGEMENT_ADMINISTRATION_SERVICE = "ESBAdministrationService";
110:
111: public static final String JAVA_CAPS_MANAGEMENT_CONFIGURATION_SERVICE = "ESBConfigurationService";
112:
113: public static final String JAVA_CAPS_MANAGEMENT_DEPLOYMENT_SERVICE = "ESBDeploymentService";
114:
115: public static final String JAVA_CAPS_MANAGEMENT_INSTALLATION_SERVICE = "ESBInstallationService";
116:
117: public static final String JAVA_CAPS_MANAGEMENT_RUNTIME_MANAGEMENT_SERVICE = "ESBRuntimeManagementService";
118:
119: public static final String JAVA_CAPS_MANAGEMENT_PERFORMANCE_MEASUREMENT_SERVICE = "ESBPerformanceMeasurementService";
120:
121: public static final String JAVA_CAPS_MANAGEMENT_NOTIFICATION_SERVICE = "ESBNotificationService";
122:
123: public static final String TARGET_KEY = "Target";
124:
125: public static final String SERVICE_TYPE_KEY = "ServiceType";
126:
127: public static final String COMPONENT_LIFECYCLE_KEY = "ComponentLifeCycle";
128:
129: /** jbi jmx domain */
130: private static String sJbiJmxDomain = null;
131:
132: /** jbi admin object name */
133: private static ObjectName sAdminMBeanObjectName = null;
134:
135: /** jbi admin object name */
136: private static ObjectName sUiMBeanObjectName = null;
137:
138: /** jbi reference admin object name */
139: private static ObjectName sReferenceUiMBeanObjectName = null;
140:
141: /** statistics mbean name */
142: private static ObjectName sStatisticsMBeanObjectName = null;
143:
144: /** Java CAPS common management Administration Service object name */
145: private static ObjectName administrationServiceMBeanObjectName = null;
146:
147: /** Java CAPS common management Notification Service object name */
148: private static ObjectName notificationServiceMBeanObjectName = null;
149:
150: /** Java CAPS common management Configuration Service object name */
151: private static ObjectName configurationServiceMBeanObjectName = null;
152:
153: /** Java CAPS common management Deployment Service object name */
154: private static ObjectName deploymentServiceMBeanObjectName = null;
155:
156: /** Java CAPS common management Installation Service object name */
157: private static ObjectName installationServiceMBeanObjectName = null;
158:
159: /** Java CAPS common management Runtime Management Service object name */
160: private static ObjectName runtimeManagementServiceMBeanObjectName = null;
161:
162: /** Java CAPS common management Performance Measurement Service object name */
163: private static ObjectName performanceMeasurementServiceMBeanObjectName = null;
164:
165: /**
166: * gets the jmx domain name
167: *
168: * @return domain name
169: */
170: public static String getJbiJmxDomain() {
171: if (sJbiJmxDomain == null) {
172: sJbiJmxDomain = System.getProperty("jbi.jmx.domain",
173: JMX_JBI_DOMAIN);
174: }
175: return sJbiJmxDomain;
176: }
177:
178: /**
179: * returns the ObjectName for the installer Mbean.
180: *
181: * @return the ObjectName for the installer Mbean.
182: * @throws MalformedObjectNameException
183: * if the object name is not formatted according to jmx object
184: * name
185: */
186: public static ObjectName getJbiAdminUiMBeanObjectName()
187: throws MalformedObjectNameException {
188: if (sUiMBeanObjectName == null) {
189: String mbeanRegisteredName = getJbiJmxDomain() + ":"
190: + SERVICE_NAME_KEY + "=" + JBI_ADMIN_UI_SERVICE
191: + "," + COMPONENT_TYPE_KEY + "="
192: + SYSTEM_COMPONENT_TYPE_VALUE;
193: sUiMBeanObjectName = new ObjectName(mbeanRegisteredName);
194: }
195: return sUiMBeanObjectName;
196:
197: }
198:
199: /**
200: * returns the ObjectName for the reference JBI Mbean.
201: *
202: * @return the ObjectName for the reference JBI Mbean.
203: * @throws MalformedObjectNameException
204: * if the object name is not formatted according to jmx object
205: * name
206: */
207: public static ObjectName getJbiReferenceAdminUiMBeanObjectName()
208: throws MalformedObjectNameException {
209: if (sReferenceUiMBeanObjectName == null) {
210: String mbeanRegisteredName = getJbiJmxDomain() + ":"
211: + SERVICE_NAME_KEY + "="
212: + JBI_REFERENCE_ADMIN_UI_SERVICE + ","
213: + COMPONENT_TYPE_KEY + "="
214: + SYSTEM_COMPONENT_TYPE_VALUE;
215: sReferenceUiMBeanObjectName = new ObjectName(
216: mbeanRegisteredName);
217: }
218: return sReferenceUiMBeanObjectName;
219:
220: }
221:
222: /**
223: * returns the ObjectName for the CAPS Management Administration Service
224: * Mbean.
225: *
226: * @return the ObjectName for the CAPS Management Administration Service
227: * Mbean.
228: * @throws MalformedObjectNameException
229: * if the object name is not formatted according to jmx object
230: * name
231: */
232: public static ObjectName getJavaCapsAdministrationServiceMBeanObjectName()
233: throws MalformedObjectNameException {
234: if (administrationServiceMBeanObjectName == null) {
235: String mbeanRegisteredName = getJbiJmxDomain() + ":"
236: + SERVICE_NAME_KEY + "="
237: + JAVA_CAPS_MANAGEMENT_ADMINISTRATION_SERVICE + ","
238: + COMPONENT_TYPE_KEY + "="
239: + SYSTEM_COMPONENT_TYPE_VALUE;
240: administrationServiceMBeanObjectName = new ObjectName(
241: mbeanRegisteredName);
242: }
243: return administrationServiceMBeanObjectName;
244:
245: }
246:
247: /**
248: * returns the ObjectName for the CAPS Management Notification Service
249: * Mbean.
250: *
251: * @return the ObjectName for the CAPS Management Notification Service
252: * Mbean.
253: * @throws MalformedObjectNameException
254: * if the object name is not formatted according to jmx object
255: * name
256: */
257: public static ObjectName getJavaCapsNotificationServiceMBeanObjectName()
258: throws MalformedObjectNameException {
259: if (notificationServiceMBeanObjectName == null) {
260: String mbeanRegisteredName = getJbiJmxDomain() + ":"
261: + SERVICE_NAME_KEY + "="
262: + JAVA_CAPS_MANAGEMENT_NOTIFICATION_SERVICE + ","
263: + COMPONENT_TYPE_KEY + "="
264: + SYSTEM_COMPONENT_TYPE_VALUE;
265: notificationServiceMBeanObjectName = new ObjectName(
266: mbeanRegisteredName);
267: }
268: return notificationServiceMBeanObjectName;
269:
270: }
271:
272: /**
273: * returns the ObjectName for the CAPS Management Configuration Service
274: * Mbean.
275: *
276: * @return the ObjectName for the CAPS Management Configuration Service
277: * Mbean.
278: * @throws MalformedObjectNameException
279: * if the object name is not formatted according to jmx object
280: * name
281: */
282: public static ObjectName getJavaCapsConfigurationServiceMBeanObjectName()
283: throws MalformedObjectNameException {
284: if (configurationServiceMBeanObjectName == null) {
285: String mbeanRegisteredName = getJbiJmxDomain() + ":"
286: + SERVICE_NAME_KEY + "="
287: + JAVA_CAPS_MANAGEMENT_CONFIGURATION_SERVICE + ","
288: + COMPONENT_TYPE_KEY + "="
289: + SYSTEM_COMPONENT_TYPE_VALUE;
290: configurationServiceMBeanObjectName = new ObjectName(
291: mbeanRegisteredName);
292: }
293: return configurationServiceMBeanObjectName;
294:
295: }
296:
297: /**
298: * returns the ObjectName for the CAPS Management Deployment Service Mbean.
299: *
300: * @return the ObjectName for the CAPS Management Deployment Service Mbean.
301: * @throws MalformedObjectNameException
302: * if the object name is not formatted according to jmx object
303: * name
304: */
305: public static ObjectName getJavaCapsDeploymentServiceMBeanObjectName()
306: throws MalformedObjectNameException {
307: if (deploymentServiceMBeanObjectName == null) {
308: String mbeanRegisteredName = getJbiJmxDomain() + ":"
309: + SERVICE_NAME_KEY + "="
310: + JAVA_CAPS_MANAGEMENT_DEPLOYMENT_SERVICE + ","
311: + COMPONENT_TYPE_KEY + "="
312: + SYSTEM_COMPONENT_TYPE_VALUE;
313: deploymentServiceMBeanObjectName = new ObjectName(
314: mbeanRegisteredName);
315: }
316: return deploymentServiceMBeanObjectName;
317:
318: }
319:
320: /**
321: * returns the ObjectName for the CAPS Management Installation Service
322: * Mbean.
323: *
324: * @return the ObjectName for the CAPS Management Installation Service
325: * Mbean.
326: * @throws MalformedObjectNameException
327: * if the object name is not formatted according to jmx object
328: * name
329: */
330: public static ObjectName getJavaCapsInstallationServiceMBeanObjectName()
331: throws MalformedObjectNameException {
332: if (installationServiceMBeanObjectName == null) {
333: String mbeanRegisteredName = getJbiJmxDomain() + ":"
334: + SERVICE_NAME_KEY + "="
335: + JAVA_CAPS_MANAGEMENT_INSTALLATION_SERVICE + ","
336: + COMPONENT_TYPE_KEY + "="
337: + SYSTEM_COMPONENT_TYPE_VALUE;
338: installationServiceMBeanObjectName = new ObjectName(
339: mbeanRegisteredName);
340: }
341: return installationServiceMBeanObjectName;
342:
343: }
344:
345: /**
346: * returns the ObjectName for the CAPS Runtime Management Service Mbean.
347: *
348: * @return the ObjectName for the CAPS Runtime Management Service Mbean.
349: * @throws MalformedObjectNameException
350: * if the object name is not formatted according to jmx object
351: * name
352: */
353: public static ObjectName getJavaCapsRuntimeManagementServiceMBeanObjectName()
354: throws MalformedObjectNameException {
355: if (runtimeManagementServiceMBeanObjectName == null) {
356: String mbeanRegisteredName = getJbiJmxDomain() + ":"
357: + SERVICE_NAME_KEY + "="
358: + JAVA_CAPS_MANAGEMENT_RUNTIME_MANAGEMENT_SERVICE
359: + "," + COMPONENT_TYPE_KEY + "="
360: + SYSTEM_COMPONENT_TYPE_VALUE;
361: runtimeManagementServiceMBeanObjectName = new ObjectName(
362: mbeanRegisteredName);
363: }
364: return runtimeManagementServiceMBeanObjectName;
365:
366: }
367:
368: /**
369: * returns the ObjectName for the CAPS Management Performance Measurement
370: * Service Mbean.
371: *
372: * @return the ObjectName for the CAPS Management Performance Measurement
373: * Service Mbean.
374: * @throws MalformedObjectNameException
375: * if the object name is not formatted according to jmx object
376: * name
377: */
378: public static ObjectName getJavaCapsPerformanceMeasurementServiceMBeanObjectName()
379: throws MalformedObjectNameException {
380: if (performanceMeasurementServiceMBeanObjectName == null) {
381: String mbeanRegisteredName = getJbiJmxDomain()
382: + ":"
383: + SERVICE_NAME_KEY
384: + "="
385: + JAVA_CAPS_MANAGEMENT_PERFORMANCE_MEASUREMENT_SERVICE
386: + "," + COMPONENT_TYPE_KEY + "="
387: + SYSTEM_COMPONENT_TYPE_VALUE;
388: performanceMeasurementServiceMBeanObjectName = new ObjectName(
389: mbeanRegisteredName);
390: }
391: return performanceMeasurementServiceMBeanObjectName;
392:
393: }
394:
395: /**
396: * returns the ObjectName for the deployer Mbean.
397: *
398: * @return ObjectName for deployer mbean
399: * @throws MalformedObjectNameException
400: * if the object name is not formatted according to jmx object
401: * name
402: */
403: public static ObjectName getAdminServiceMBeanObjectName()
404: throws MalformedObjectNameException {
405: if (sAdminMBeanObjectName == null) {
406: String mbeanRegisteredName = getJbiJmxDomain() + ":"
407: + SERVICE_NAME_KEY + "=" + ADMIN_SERVICE + ","
408: + CONTROL_TYPE_KEY + "="
409: + ADMIN_SERVICE_CONTROL_TYPE_VALUE + ","
410: + COMPONENT_TYPE_KEY + "="
411: + SYSTEM_COMPONENT_TYPE_VALUE;
412: sAdminMBeanObjectName = new ObjectName(mbeanRegisteredName);
413: }
414: return sAdminMBeanObjectName;
415:
416: }
417:
418: /**
419: * returns the ObjectName Pattern for lifecycle mbeans.
420: *
421: * @param componentName
422: * id of a binding or engine component
423: * @return the ObjectName Pattern for the lifecycle Mbean.
424: * @throws MalformedObjectNameException
425: * if the object name is not formatted according to jmx object
426: * name
427: */
428: public static ObjectName getComponentLifeCycleMBeanObjectNamePattern(
429: String componentName) throws MalformedObjectNameException {
430: // TODO change the COMPONENT_ID_KEY to COMPONENT_NAME
431: String lifecycleObjectNamePatternString = getJbiJmxDomain()
432: + ":" + CONTROL_TYPE_KEY + "="
433: + LIFECYCLE_CONTROL_TYPE_VALUE + "," + COMPONENT_ID_KEY
434: + "=" + componentName + "," + "*";
435: ObjectName lifecycleObjectNamePattern = new ObjectName(
436: lifecycleObjectNamePatternString);
437:
438: return lifecycleObjectNamePattern;
439: }
440:
441: /**
442: * returns the ObjectName Pattern for lifecycle mbeans of the form:
443: * com.sun.jbi:Target=instance1,ServiceType=ComponentLifecycle,ComponentName=<componentName>,*
444: *
445: * @param componentName
446: * id of a binding or engine component
447: * @return the ObjectName Pattern for the lifecycle Mbean.
448: * @throws MalformedObjectNameException
449: * if the object name is not formatted according to jmx object
450: * name
451: *
452: */
453: public static ObjectName getComponentLifeCycleMBeanObjectNamePattern(
454: String componentName, String targetName)
455: throws MalformedObjectNameException {
456: // TODO change the COMPONENT_ID_KEY to COMPONENT_NAME
457: String lifecycleObjectNamePatternString = getJbiJmxDomain()
458: + ":" + TARGET_KEY + "=" + targetName + ","
459: + SERVICE_TYPE_KEY + "=" + COMPONENT_LIFECYCLE_KEY
460: + "," + COMPONENT_ID_KEY + "=" + componentName + ","
461: + "*";
462: ObjectName lifecycleObjectNamePattern = new ObjectName(
463: lifecycleObjectNamePatternString);
464:
465: return lifecycleObjectNamePattern;
466: }
467:
468: /**
469: * returns the ObjectName Pattern for deployer mbeans.
470: *
471: * @param componentName
472: * id of a binding or engine component
473: * @return the ObjectName Pattern for the deployer Mbean.
474: * @throws MalformedObjectNameException
475: * if the object name is not formatted according to jmx object
476: * name
477: */
478: public static ObjectName getComponentDeployerMBeanObjectNamePattern(
479: String componentName) throws MalformedObjectNameException {
480: // TODO change the COMPONENT_ID_KEY to COMPONENT_NAME
481: String lifecycleObjectNamePatternString = getJbiJmxDomain()
482: + ":" + CONTROL_TYPE_KEY + "="
483: + DEPLOYER_CONTROL_TYPE_VALUE + "," + COMPONENT_ID_KEY
484: + "=" + componentName + "," + "*";
485: ObjectName lifecycleObjectNamePattern = new ObjectName(
486: lifecycleObjectNamePatternString);
487:
488: return lifecycleObjectNamePattern;
489: }
490:
491: /**
492: * This method is used to get the ObjectName for the statistics MBean.
493: * @throws MalformedObjectNameException
494: * if the object name is not formatted according to jmx object name.
495: */
496: public static ObjectName getJbiStatisticsMBeanObjectName()
497: throws MalformedObjectNameException {
498: if (sStatisticsMBeanObjectName == null) {
499: String mbeanRegisteredName = getJbiJmxDomain() + ":"
500: + SERVICE_NAME_KEY + "=" + JBI_STATISTICS_SERVICE
501: + "," + COMPONENT_TYPE_KEY + "="
502: + SYSTEM_COMPONENT_TYPE_VALUE;
503: sStatisticsMBeanObjectName = new ObjectName(
504: mbeanRegisteredName);
505: }
506: return sStatisticsMBeanObjectName;
507:
508: }
509:
510: }
|