Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.management;
018
019import java.net.UnknownHostException;
020import java.util.concurrent.ThreadPoolExecutor;
021
022import javax.management.MalformedObjectNameException;
023import javax.management.ObjectName;
024
025import org.apache.camel.CamelContext;
026import org.apache.camel.CamelContextAware;
027import org.apache.camel.Component;
028import org.apache.camel.Consumer;
029import org.apache.camel.Endpoint;
030import org.apache.camel.ErrorHandlerFactory;
031import org.apache.camel.NamedNode;
032import org.apache.camel.Processor;
033import org.apache.camel.Producer;
034import org.apache.camel.Route;
035import org.apache.camel.Service;
036import org.apache.camel.StaticService;
037import org.apache.camel.builder.ErrorHandlerBuilderRef;
038import org.apache.camel.cluster.CamelClusterService;
039import org.apache.camel.management.mbean.ManagedBacklogDebugger;
040import org.apache.camel.management.mbean.ManagedBacklogTracer;
041import org.apache.camel.management.mbean.ManagedCamelContext;
042import org.apache.camel.management.mbean.ManagedCamelHealth;
043import org.apache.camel.management.mbean.ManagedClusterService;
044import org.apache.camel.management.mbean.ManagedComponent;
045import org.apache.camel.management.mbean.ManagedConsumer;
046import org.apache.camel.management.mbean.ManagedDataFormat;
047import org.apache.camel.management.mbean.ManagedEndpoint;
048import org.apache.camel.management.mbean.ManagedErrorHandler;
049import org.apache.camel.management.mbean.ManagedEventNotifier;
050import org.apache.camel.management.mbean.ManagedProcessor;
051import org.apache.camel.management.mbean.ManagedProducer;
052import org.apache.camel.management.mbean.ManagedRoute;
053import org.apache.camel.management.mbean.ManagedRouteController;
054import org.apache.camel.management.mbean.ManagedService;
055import org.apache.camel.management.mbean.ManagedStep;
056import org.apache.camel.management.mbean.ManagedSupervisingRouteController;
057import org.apache.camel.management.mbean.ManagedThreadPool;
058import org.apache.camel.management.mbean.ManagedTracer;
059import org.apache.camel.reifier.errorhandler.ErrorHandlerReifier;
060import org.apache.camel.spi.DataFormat;
061import org.apache.camel.spi.EventNotifier;
062import org.apache.camel.spi.ManagementObjectNameStrategy;
063import org.apache.camel.spi.RouteController;
064import org.apache.camel.util.InetAddressUtil;
065import org.apache.camel.util.ObjectHelper;
066import org.apache.camel.util.URISupport;
067
068/**
069 * Naming strategy used when registering MBeans.
070 */
071public class DefaultManagementObjectNameStrategy implements ManagementObjectNameStrategy, CamelContextAware {
072    public static final String VALUE_UNKNOWN = "unknown";
073    public static final String KEY_NAME = "name";
074    public static final String KEY_TYPE = "type";
075    public static final String KEY_CONTEXT = "context";
076    public static final String TYPE_CONTEXT = "context";
077    public static final String TYPE_ROUTE_CONTROLLER = "routecontrollers";
078    public static final String TYPE_HEALTH = "health";
079    public static final String TYPE_ENDPOINT = "endpoints";
080    public static final String TYPE_DATAFORMAT = "dataformats";
081    public static final String TYPE_PROCESSOR = "processors";
082    public static final String TYPE_CONSUMER = "consumers";
083    public static final String TYPE_PRODUCER = "producers";
084    public static final String TYPE_ROUTE = "routes";
085    public static final String TYPE_COMPONENT = "components";
086    public static final String TYPE_STEP = "steps";
087    public static final String TYPE_TRACER = "tracer";
088    public static final String TYPE_EVENT_NOTIFIER = "eventnotifiers";
089    public static final String TYPE_ERRORHANDLER = "errorhandlers";
090    public static final String TYPE_THREAD_POOL = "threadpools";
091    public static final String TYPE_SERVICE = "services";
092    public static final String TYPE_HA = "clusterservices";
093
094    protected String domainName;
095    protected String hostName = "localhost";
096    protected CamelContext camelContext;
097
098    public DefaultManagementObjectNameStrategy() {
099        this(null);
100        // default constructor needed for <bean> style configuration
101    }
102
103    public DefaultManagementObjectNameStrategy(String domainName) {
104        this.domainName = domainName != null ? domainName : "org.apache.camel";
105        try {
106            hostName = InetAddressUtil.getLocalHostName();
107        } catch (UnknownHostException ex) {
108            // ignore, use the default "localhost"
109        }
110    }
111
112    @Override
113    public CamelContext getCamelContext() {
114        return camelContext;
115    }
116
117    @Override
118    public void setCamelContext(CamelContext camelContext) {
119        this.camelContext = camelContext;
120    }
121
122    @Override
123    public ObjectName getObjectName(Object managedObject) throws MalformedObjectNameException {
124        if (managedObject == null) {
125            return null;
126        }
127        ObjectName objectName = null;
128        if (managedObject instanceof ManagedCamelContext) {
129            ManagedCamelContext mcc = (ManagedCamelContext) managedObject;
130            objectName = getObjectNameForCamelContext(mcc.getContext());
131        } else if (managedObject instanceof ManagedCamelHealth) {
132            ManagedCamelHealth mch = (ManagedCamelHealth) managedObject;
133            objectName = getObjectNameForCamelHealth(mch.getContext());
134        } else if (managedObject instanceof ManagedRouteController) {
135            ManagedRouteController mrc = (ManagedRouteController) managedObject;
136            objectName = getObjectNameForRouteController(mrc.getContext(), mrc.getRouteController());
137        } else if (managedObject instanceof ManagedSupervisingRouteController) {
138            ManagedSupervisingRouteController mrc = (ManagedSupervisingRouteController) managedObject;
139            objectName = getObjectNameForRouteController(mrc.getContext(), mrc.getRouteController());
140        } else if (managedObject instanceof ManagedComponent) {
141            ManagedComponent mc = (ManagedComponent) managedObject;
142            objectName = getObjectNameForComponent(mc.getComponent(), mc.getComponentName());
143        } else if (managedObject instanceof ManagedDataFormat) {
144            ManagedDataFormat md = (ManagedDataFormat) managedObject;
145            objectName = getObjectNameForDataFormat(md.getContext(), md.getDataFormat());
146        } else if (managedObject instanceof ManagedEndpoint) {
147            ManagedEndpoint me = (ManagedEndpoint) managedObject;
148            objectName = getObjectNameForEndpoint(me.getEndpoint());
149        } else if (managedObject instanceof Endpoint) {
150            objectName = getObjectNameForEndpoint((Endpoint) managedObject);
151        } else if (managedObject instanceof ManagedRoute) {
152            ManagedRoute mr = (ManagedRoute) managedObject;
153            objectName = getObjectNameForRoute(mr.getRoute());
154        } else if (managedObject instanceof ManagedErrorHandler) {
155            ManagedErrorHandler meh = (ManagedErrorHandler) managedObject;
156            objectName = getObjectNameForErrorHandler(meh.getRoute(), meh.getErrorHandler(), meh.getErrorHandlerBuilder());
157        } else if (managedObject instanceof ManagedStep) {
158            ManagedStep mp = (ManagedStep) managedObject;
159            objectName = getObjectNameForStep(mp.getContext(), mp.getProcessor(), mp.getDefinition());
160        } else if (managedObject instanceof ManagedProcessor) {
161            ManagedProcessor mp = (ManagedProcessor) managedObject;
162            objectName = getObjectNameForProcessor(mp.getContext(), mp.getProcessor(), mp.getDefinition());
163        } else if (managedObject instanceof ManagedConsumer) {
164            ManagedConsumer ms = (ManagedConsumer) managedObject;
165            objectName = getObjectNameForConsumer(ms.getContext(), ms.getConsumer());
166        } else if (managedObject instanceof ManagedProducer) {
167            ManagedProducer ms = (ManagedProducer) managedObject;
168            objectName = getObjectNameForProducer(ms.getContext(), ms.getProducer());
169        } else if (managedObject instanceof ManagedBacklogTracer) {
170            ManagedBacklogTracer mt = (ManagedBacklogTracer) managedObject;
171            objectName = getObjectNameForTracer(mt.getContext(), mt.getBacklogTracer());
172        } else if (managedObject instanceof ManagedBacklogDebugger) {
173            ManagedBacklogDebugger md = (ManagedBacklogDebugger) managedObject;
174            objectName = getObjectNameForTracer(md.getContext(), md.getBacklogDebugger());
175        } else if (managedObject instanceof ManagedEventNotifier) {
176            ManagedEventNotifier men = (ManagedEventNotifier) managedObject;
177            objectName = getObjectNameForEventNotifier(men.getContext(), men.getEventNotifier());
178        } else if (managedObject instanceof ManagedTracer) {
179            ManagedTracer mt = (ManagedTracer) managedObject;
180            objectName = getObjectNameForTracer(mt.getContext(), mt.getTracer());
181        } else if (managedObject instanceof ManagedThreadPool) {
182            ManagedThreadPool mes = (ManagedThreadPool) managedObject;
183            objectName = getObjectNameForThreadPool(mes.getContext(), mes.getThreadPool(), mes.getId(), mes.getSourceId());
184        } else if (managedObject instanceof ManagedClusterService) {
185            ManagedClusterService mcs = (ManagedClusterService) managedObject;
186            objectName = getObjectNameForClusterService(mcs.getContext(), mcs.getService());
187        } else if (managedObject instanceof ManagedService) {
188            // check for managed service should be last
189            ManagedService ms = (ManagedService) managedObject;
190            // skip endpoints as they are already managed
191            if (ms.getService() instanceof Endpoint) {
192                return null;
193            }
194            objectName = getObjectNameForService(ms.getContext(), ms.getService());
195        }
196
197        return objectName;
198    }
199
200    @Override
201    public ObjectName getObjectNameForCamelContext(String managementName, String name) throws MalformedObjectNameException {
202        StringBuilder buffer = new StringBuilder();
203        buffer.append(domainName).append(":");
204        buffer.append(KEY_CONTEXT + "=").append(getContextId(managementName)).append(",");
205        buffer.append(KEY_TYPE + "=" + TYPE_CONTEXT + ",");
206        buffer.append(KEY_NAME + "=").append(ObjectName.quote(name));
207        return createObjectName(buffer);
208    }
209
210    @Override
211    public ObjectName getObjectNameForCamelContext(CamelContext context) throws MalformedObjectNameException {
212        // prefer to use the given management name if previously assigned
213        String managementName = context.getManagementName();
214        if (managementName == null) {
215            managementName = context.getManagementNameStrategy().getName();
216        }
217        String name = context.getName();
218        return getObjectNameForCamelContext(managementName, name);
219    }
220
221    @Override
222    public ObjectName getObjectNameForCamelHealth(CamelContext context) throws MalformedObjectNameException {
223        // prefer to use the given management name if previously assigned
224        String managementName = context.getManagementName();
225        if (managementName == null) {
226            managementName = context.getManagementNameStrategy().getName();
227        }
228
229        StringBuilder buffer = new StringBuilder();
230        buffer.append(domainName).append(":");
231        buffer.append(KEY_CONTEXT + "=").append(getContextId(managementName)).append(",");
232        buffer.append(KEY_TYPE + "=" + TYPE_HEALTH + ",");
233        buffer.append(KEY_NAME + "=").append("DefaultHealthCheck");
234
235        return createObjectName(buffer);
236    }
237
238    @Override
239    public ObjectName getObjectNameForRouteController(CamelContext context, RouteController routeController) throws MalformedObjectNameException {
240        // prefer to use the given management name if previously assigned
241        String managementName = context.getManagementName();
242        if (managementName == null) {
243            managementName = context.getManagementNameStrategy().getName();
244        }
245
246        StringBuilder buffer = new StringBuilder();
247        buffer.append(domainName).append(":");
248        buffer.append(KEY_CONTEXT + "=").append(getContextId(managementName)).append(",");
249        buffer.append(KEY_TYPE + "=" + TYPE_ROUTE_CONTROLLER + ",");
250        buffer.append(KEY_NAME + "=").append(routeController.getClass().getSimpleName());
251
252        return createObjectName(buffer);
253    }
254
255    @Override
256    public ObjectName getObjectNameForEndpoint(Endpoint endpoint) throws MalformedObjectNameException {
257        StringBuilder buffer = new StringBuilder();
258        buffer.append(domainName).append(":");
259        buffer.append(KEY_CONTEXT + "=").append(getContextId(endpoint.getCamelContext())).append(",");
260        buffer.append(KEY_TYPE + "=" + TYPE_ENDPOINT + ",");
261        buffer.append(KEY_NAME + "=").append(ObjectName.quote(getEndpointId(endpoint)));
262        return createObjectName(buffer);
263    }
264
265    @Override
266    public ObjectName getObjectNameForDataFormat(CamelContext context, DataFormat dataFormat) throws MalformedObjectNameException {
267        StringBuilder buffer = new StringBuilder();
268        buffer.append(domainName).append(":");
269        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
270        buffer.append(KEY_TYPE + "=" + TYPE_DATAFORMAT + ",");
271        buffer.append(KEY_NAME + "=").append(dataFormat.getClass().getSimpleName());
272        if (!(dataFormat instanceof StaticService)) {
273            buffer.append("(").append(ObjectHelper.getIdentityHashCode(dataFormat)).append(")");
274        }
275        return createObjectName(buffer);
276    }
277
278    @Override
279    public ObjectName getObjectNameForComponent(Component component, String name) throws MalformedObjectNameException {
280        StringBuilder buffer = new StringBuilder();
281        buffer.append(domainName).append(":");
282        buffer.append(KEY_CONTEXT + "=").append(getContextId(component.getCamelContext())).append(",");
283        buffer.append(KEY_TYPE + "=" + TYPE_COMPONENT + ",");
284        buffer.append(KEY_NAME + "=").append(ObjectName.quote(name));
285        return createObjectName(buffer);
286    }
287
288    @Override
289    public ObjectName getObjectNameForProcessor(CamelContext context, Processor processor, NamedNode definition) throws MalformedObjectNameException {
290        StringBuilder buffer = new StringBuilder();
291        buffer.append(domainName).append(":");
292        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
293        buffer.append(KEY_TYPE + "=").append(TYPE_PROCESSOR).append(",");
294        buffer.append(KEY_NAME + "=").append(ObjectName.quote(definition.getId()));
295        return createObjectName(buffer);
296    }
297
298    @Override
299    public ObjectName getObjectNameForStep(CamelContext context, Processor processor, NamedNode definition) throws MalformedObjectNameException {
300        StringBuilder buffer = new StringBuilder();
301        buffer.append(domainName).append(":");
302        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
303        buffer.append(KEY_TYPE + "=").append(TYPE_STEP).append(",");
304        buffer.append(KEY_NAME + "=").append(ObjectName.quote(definition.getId()));
305        return createObjectName(buffer);
306    }
307
308    @Override
309    public ObjectName getObjectNameForErrorHandler(Route route, Processor errorHandler, ErrorHandlerFactory builder) throws MalformedObjectNameException {
310        StringBuilder buffer = new StringBuilder();
311        buffer.append(domainName).append(":");
312        buffer.append(KEY_CONTEXT + "=").append(getContextId(route.getCamelContext())).append(",");
313        buffer.append(KEY_TYPE + "=").append(TYPE_ERRORHANDLER + ",");
314
315        // we want to only register one instance of the various error handler types and thus do some lookup
316        // if its a ErrorHandlerBuildRef. We need a bit of work to do that as there are potential indirection.
317        String ref = null;
318        if (builder instanceof ErrorHandlerBuilderRef) {
319            ErrorHandlerBuilderRef builderRef = (ErrorHandlerBuilderRef) builder;
320
321            // it has not then its an indirection and we should do some work to lookup the real builder
322            ref = builderRef.getRef();
323            ErrorHandlerFactory refBuilder = ErrorHandlerReifier.lookupErrorHandlerFactory(route, builderRef.getRef(), false);
324            if (refBuilder != null) {
325                builder = refBuilder;
326            }
327
328            // must do a 2nd lookup in case this is also a reference
329            // (this happens with spring DSL using errorHandlerRef on <route> as it gets a bit
330            // complex with indirections for error handler references
331            if (builder instanceof ErrorHandlerBuilderRef) {
332                builderRef = (ErrorHandlerBuilderRef) builder;
333                // does it refer to a non default error handler then do a 2nd lookup
334                if (!builderRef.getRef().equals(ErrorHandlerBuilderRef.DEFAULT_ERROR_HANDLER_BUILDER)) {
335                    refBuilder = ErrorHandlerReifier.lookupErrorHandlerFactory(route, builderRef.getRef(), false);
336                    if (refBuilder != null) {
337                        ref = builderRef.getRef();
338                        builder = refBuilder;
339                    }
340                }
341            }
342        }
343
344        if (ref != null) {
345            String name = builder.getClass().getSimpleName() + "(ref:" + ref + ")";
346            buffer.append(KEY_NAME + "=").append(ObjectName.quote(name));
347        } else {
348            // create a name based on its instance
349            buffer.append(KEY_NAME + "=")
350                .append(builder.getClass().getSimpleName())
351                .append("(").append(ObjectHelper.getIdentityHashCode(builder)).append(")");
352        }
353
354        return createObjectName(buffer);
355    }
356
357    @Override
358    public ObjectName getObjectNameForConsumer(CamelContext context, Consumer consumer) throws MalformedObjectNameException {
359        StringBuilder buffer = new StringBuilder();
360        buffer.append(domainName).append(":");
361        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
362        buffer.append(KEY_TYPE + "=").append(TYPE_CONSUMER).append(",");
363
364        String name = consumer.getClass().getSimpleName();
365        if (ObjectHelper.isEmpty(name)) {
366            name = "Consumer";
367        }
368        buffer.append(KEY_NAME + "=")
369            .append(name)
370            .append("(").append(ObjectHelper.getIdentityHashCode(consumer)).append(")");
371        return createObjectName(buffer);
372    }
373
374    @Override
375    public ObjectName getObjectNameForProducer(CamelContext context, Producer producer) throws MalformedObjectNameException {
376        StringBuilder buffer = new StringBuilder();
377        buffer.append(domainName).append(":");
378        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
379        buffer.append(KEY_TYPE + "=").append(TYPE_PRODUCER).append(",");
380
381        String name = producer.getClass().getSimpleName();
382        if (ObjectHelper.isEmpty(name)) {
383            name = "Producer";
384        }
385        buffer.append(KEY_NAME + "=")
386            .append(name)
387            .append("(").append(ObjectHelper.getIdentityHashCode(producer)).append(")");
388        return createObjectName(buffer);
389    }
390
391    @Override
392    public ObjectName getObjectNameForTracer(CamelContext context, Service tracer) throws MalformedObjectNameException {
393        // use the simple name of the class as the mbean name (eg Tracer, BacklogTracer, BacklogDebugger)
394        String name = tracer.getClass().getSimpleName();
395
396        StringBuilder buffer = new StringBuilder();
397        buffer.append(domainName).append(":");
398        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
399        buffer.append(KEY_TYPE + "=" + TYPE_TRACER + ",");
400        buffer.append(KEY_NAME + "=").append(name);
401        return createObjectName(buffer);
402    }
403
404    @Override
405    public ObjectName getObjectNameForEventNotifier(CamelContext context, EventNotifier eventNotifier) throws MalformedObjectNameException {
406        StringBuilder buffer = new StringBuilder();
407        buffer.append(domainName).append(":");
408        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
409        buffer.append(KEY_TYPE + "=" + TYPE_EVENT_NOTIFIER + ",");
410
411        if (eventNotifier instanceof JmxNotificationEventNotifier) {
412            // JMX notifier shall have an easy to use name
413            buffer.append(KEY_NAME + "=").append("JmxEventNotifier");
414        } else {
415            // others can be per instance
416            buffer.append(KEY_NAME + "=")
417                .append("EventNotifier")
418                .append("(").append(ObjectHelper.getIdentityHashCode(eventNotifier)).append(")");
419        }
420        return createObjectName(buffer);
421    }
422
423    @Override
424    public ObjectName getObjectNameForRoute(org.apache.camel.Route route) throws MalformedObjectNameException {
425        Endpoint ep = route.getEndpoint();
426        String id = route.getId();
427
428        StringBuilder buffer = new StringBuilder();
429        buffer.append(domainName).append(":");
430        buffer.append(KEY_CONTEXT + "=").append(getContextId(ep.getCamelContext())).append(",");
431        buffer.append(KEY_TYPE + "=" + TYPE_ROUTE + ",");
432        buffer.append(KEY_NAME + "=").append(ObjectName.quote(id));
433        return createObjectName(buffer);
434    }
435
436    @Override
437    public ObjectName getObjectNameForService(CamelContext context, Service service) throws MalformedObjectNameException {
438        StringBuilder buffer = new StringBuilder();
439        buffer.append(domainName).append(":");
440        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
441        buffer.append(KEY_TYPE + "=" + TYPE_SERVICE + ",");
442        buffer.append(KEY_NAME + "=").append(service.getClass().getSimpleName());
443        if (!(service instanceof StaticService)) {
444            buffer.append("(").append(ObjectHelper.getIdentityHashCode(service)).append(")");
445        }
446        return createObjectName(buffer);
447    }
448
449    @Override
450    public ObjectName getObjectNameForClusterService(CamelContext context, CamelClusterService service) throws MalformedObjectNameException {
451        StringBuilder buffer = new StringBuilder();
452        buffer.append(domainName).append(":");
453        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
454        buffer.append(KEY_TYPE + "=" + TYPE_HA + ",");
455        buffer.append(KEY_NAME + "=").append(service.getClass().getSimpleName());
456        if (!(service instanceof StaticService)) {
457            buffer.append("(").append(ObjectHelper.getIdentityHashCode(service)).append(")");
458        }
459        return createObjectName(buffer);
460    }
461
462    @Override
463    public ObjectName getObjectNameForThreadPool(CamelContext context, ThreadPoolExecutor threadPool, String id, String sourceId) throws MalformedObjectNameException {
464        StringBuilder buffer = new StringBuilder();
465        buffer.append(domainName).append(":");
466        buffer.append(KEY_CONTEXT + "=").append(getContextId(context)).append(",");
467        buffer.append(KEY_TYPE + "=" + TYPE_THREAD_POOL + ",");
468
469        String name = id;
470        if (sourceId != null) {
471            // provide source id if we know it, this helps end user to know where the pool is used
472            name = name + "(" + sourceId + ")";
473        }
474        buffer.append(KEY_NAME + "=").append(ObjectName.quote(name));
475        return createObjectName(buffer);
476    }
477
478    public String getDomainName() {
479        return domainName;
480    }
481
482    public void setDomainName(String domainName) {
483        this.domainName = domainName;
484    }
485
486    public String getHostName() {
487        return hostName;
488    }
489
490    public void setHostName(String hostName) {
491        this.hostName = hostName;
492    }
493
494    protected String getContextId(CamelContext context) {
495        if (context == null) {
496            return getContextId(VALUE_UNKNOWN);
497        } else {
498            String name = context.getManagementName() != null ? context.getManagementName() : context.getName();
499            return getContextId(name);
500        }
501    }
502
503    protected String getContextId(String name) {
504        boolean includeHostName = camelContext != null && camelContext.getManagementStrategy().getManagementAgent().getIncludeHostName();
505        if (includeHostName) {
506            return hostName + "/" + (name != null ? name : VALUE_UNKNOWN);
507        } else {
508            return name != null ? name : VALUE_UNKNOWN;
509        }
510    }
511
512    protected String getEndpointId(Endpoint ep) {
513        String answer = doGetEndpointId(ep);
514        boolean sanitize = camelContext != null && camelContext.getManagementStrategy().getManagementAgent().getMask();
515        if (sanitize) {
516            // use xxxxxx as replacements as * has to be quoted for MBean names
517            answer = URISupport.sanitizeUri(answer);
518        }
519        return answer;
520    }
521
522    private String doGetEndpointId(Endpoint ep) {
523        if (ep.isSingleton()) {
524            return ep.getEndpointKey();
525        } else {
526            // non singleton then add hashcoded id
527            String uri = ep.getEndpointKey();
528            int pos = uri.indexOf('?');
529            String id = (pos == -1) ? uri : uri.substring(0, pos);
530            id += "?id=" + ObjectHelper.getIdentityHashCode(ep);
531            return id;
532        }
533    }
534
535    /**
536     * Factory method to create an ObjectName escaping any required characters
537     */
538    protected ObjectName createObjectName(StringBuilder buffer) throws MalformedObjectNameException {
539        String text = buffer.toString();
540        try {
541            return new ObjectName(text);
542        } catch (MalformedObjectNameException e) {
543            throw new MalformedObjectNameException("Could not create ObjectName from: " + text + ". Reason: " + e);
544        }
545    }
546}