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.util.Iterator;
020import java.util.concurrent.ThreadPoolExecutor;
021
022import org.apache.camel.CamelContext;
023import org.apache.camel.Component;
024import org.apache.camel.Consumer;
025import org.apache.camel.DelegateProcessor;
026import org.apache.camel.Endpoint;
027import org.apache.camel.ErrorHandlerFactory;
028import org.apache.camel.NamedNode;
029import org.apache.camel.Processor;
030import org.apache.camel.Producer;
031import org.apache.camel.Route;
032import org.apache.camel.Service;
033import org.apache.camel.cluster.CamelClusterService;
034import org.apache.camel.component.bean.BeanProcessor;
035import org.apache.camel.component.log.LogEndpoint;
036import org.apache.camel.management.mbean.ManagedAggregateProcessor;
037import org.apache.camel.management.mbean.ManagedBeanProcessor;
038import org.apache.camel.management.mbean.ManagedBrowsableEndpoint;
039import org.apache.camel.management.mbean.ManagedCamelContext;
040import org.apache.camel.management.mbean.ManagedCamelHealth;
041import org.apache.camel.management.mbean.ManagedChoice;
042import org.apache.camel.management.mbean.ManagedClaimCheck;
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.ManagedConvertBody;
047import org.apache.camel.management.mbean.ManagedCustomLoadBalancer;
048import org.apache.camel.management.mbean.ManagedDataFormat;
049import org.apache.camel.management.mbean.ManagedDelayer;
050import org.apache.camel.management.mbean.ManagedDynamicRouter;
051import org.apache.camel.management.mbean.ManagedEndpoint;
052import org.apache.camel.management.mbean.ManagedEnricher;
053import org.apache.camel.management.mbean.ManagedErrorHandler;
054import org.apache.camel.management.mbean.ManagedEventNotifier;
055import org.apache.camel.management.mbean.ManagedFailoverLoadBalancer;
056import org.apache.camel.management.mbean.ManagedFilter;
057import org.apache.camel.management.mbean.ManagedIdempotentConsumer;
058import org.apache.camel.management.mbean.ManagedLog;
059import org.apache.camel.management.mbean.ManagedLoop;
060import org.apache.camel.management.mbean.ManagedMarshal;
061import org.apache.camel.management.mbean.ManagedMulticast;
062import org.apache.camel.management.mbean.ManagedPollEnricher;
063import org.apache.camel.management.mbean.ManagedProcess;
064import org.apache.camel.management.mbean.ManagedProcessor;
065import org.apache.camel.management.mbean.ManagedProducer;
066import org.apache.camel.management.mbean.ManagedRandomLoadBalancer;
067import org.apache.camel.management.mbean.ManagedRecipientList;
068import org.apache.camel.management.mbean.ManagedRemoveHeader;
069import org.apache.camel.management.mbean.ManagedRemoveHeaders;
070import org.apache.camel.management.mbean.ManagedRemoveProperties;
071import org.apache.camel.management.mbean.ManagedRemoveProperty;
072import org.apache.camel.management.mbean.ManagedResequencer;
073import org.apache.camel.management.mbean.ManagedRollback;
074import org.apache.camel.management.mbean.ManagedRoundRobinLoadBalancer;
075import org.apache.camel.management.mbean.ManagedRoute;
076import org.apache.camel.management.mbean.ManagedRouteController;
077import org.apache.camel.management.mbean.ManagedRoutingSlip;
078import org.apache.camel.management.mbean.ManagedSamplingThrottler;
079import org.apache.camel.management.mbean.ManagedScheduledPollConsumer;
080import org.apache.camel.management.mbean.ManagedScript;
081import org.apache.camel.management.mbean.ManagedSendDynamicProcessor;
082import org.apache.camel.management.mbean.ManagedSendProcessor;
083import org.apache.camel.management.mbean.ManagedService;
084import org.apache.camel.management.mbean.ManagedSetBody;
085import org.apache.camel.management.mbean.ManagedSetExchangePattern;
086import org.apache.camel.management.mbean.ManagedSetHeader;
087import org.apache.camel.management.mbean.ManagedSetProperty;
088import org.apache.camel.management.mbean.ManagedSplitter;
089import org.apache.camel.management.mbean.ManagedStickyLoadBalancer;
090import org.apache.camel.management.mbean.ManagedStop;
091import org.apache.camel.management.mbean.ManagedSuspendableRoute;
092import org.apache.camel.management.mbean.ManagedThreadPool;
093import org.apache.camel.management.mbean.ManagedThreads;
094import org.apache.camel.management.mbean.ManagedThrottler;
095import org.apache.camel.management.mbean.ManagedThroughputLogger;
096import org.apache.camel.management.mbean.ManagedThrowException;
097import org.apache.camel.management.mbean.ManagedTopicLoadBalancer;
098import org.apache.camel.management.mbean.ManagedTransformer;
099import org.apache.camel.management.mbean.ManagedUnmarshal;
100import org.apache.camel.management.mbean.ManagedValidate;
101import org.apache.camel.management.mbean.ManagedWeightedLoadBalancer;
102import org.apache.camel.management.mbean.ManagedWireTapProcessor;
103import org.apache.camel.model.ExpressionNode;
104import org.apache.camel.model.LoadBalanceDefinition;
105import org.apache.camel.model.ModelCamelContext;
106import org.apache.camel.model.ProcessDefinition;
107import org.apache.camel.model.ProcessorDefinition;
108import org.apache.camel.model.RecipientListDefinition;
109import org.apache.camel.model.loadbalancer.CustomLoadBalancerDefinition;
110import org.apache.camel.processor.ChoiceProcessor;
111import org.apache.camel.processor.ClaimCheckProcessor;
112import org.apache.camel.processor.ConvertBodyProcessor;
113import org.apache.camel.processor.Delayer;
114import org.apache.camel.processor.DynamicRouter;
115import org.apache.camel.processor.Enricher;
116import org.apache.camel.processor.ErrorHandler;
117import org.apache.camel.processor.ExchangePatternProcessor;
118import org.apache.camel.processor.FilterProcessor;
119import org.apache.camel.processor.LogProcessor;
120import org.apache.camel.processor.LoopProcessor;
121import org.apache.camel.processor.MulticastProcessor;
122import org.apache.camel.processor.Pipeline;
123import org.apache.camel.processor.PollEnricher;
124import org.apache.camel.processor.RecipientList;
125import org.apache.camel.processor.RemoveHeaderProcessor;
126import org.apache.camel.processor.RemoveHeadersProcessor;
127import org.apache.camel.processor.RemovePropertiesProcessor;
128import org.apache.camel.processor.RemovePropertyProcessor;
129import org.apache.camel.processor.Resequencer;
130import org.apache.camel.processor.RollbackProcessor;
131import org.apache.camel.processor.RoutingSlip;
132import org.apache.camel.processor.SamplingThrottler;
133import org.apache.camel.processor.ScriptProcessor;
134import org.apache.camel.processor.SendDynamicProcessor;
135import org.apache.camel.processor.SendProcessor;
136import org.apache.camel.processor.SetBodyProcessor;
137import org.apache.camel.processor.SetHeaderProcessor;
138import org.apache.camel.processor.SetPropertyProcessor;
139import org.apache.camel.processor.Splitter;
140import org.apache.camel.processor.StopProcessor;
141import org.apache.camel.processor.StreamResequencer;
142import org.apache.camel.processor.ThreadsProcessor;
143import org.apache.camel.processor.Throttler;
144import org.apache.camel.processor.ThrowExceptionProcessor;
145import org.apache.camel.processor.TransformProcessor;
146import org.apache.camel.processor.WireTapProcessor;
147import org.apache.camel.processor.aggregate.AggregateProcessor;
148import org.apache.camel.processor.idempotent.IdempotentConsumer;
149import org.apache.camel.processor.loadbalancer.FailOverLoadBalancer;
150import org.apache.camel.processor.loadbalancer.LoadBalancer;
151import org.apache.camel.processor.loadbalancer.RandomLoadBalancer;
152import org.apache.camel.processor.loadbalancer.RoundRobinLoadBalancer;
153import org.apache.camel.processor.loadbalancer.StickyLoadBalancer;
154import org.apache.camel.processor.loadbalancer.TopicLoadBalancer;
155import org.apache.camel.processor.loadbalancer.WeightedLoadBalancer;
156import org.apache.camel.spi.BrowsableEndpoint;
157import org.apache.camel.spi.DataFormat;
158import org.apache.camel.spi.EventNotifier;
159import org.apache.camel.spi.ManagementObjectStrategy;
160import org.apache.camel.spi.RouteContext;
161import org.apache.camel.support.ScheduledPollConsumer;
162import org.apache.camel.support.processor.MarshalProcessor;
163import org.apache.camel.support.processor.ThroughputLogger;
164import org.apache.camel.support.processor.UnmarshalProcessor;
165import org.apache.camel.support.processor.validation.PredicateValidatingProcessor;
166
167/**
168 * Default {@link org.apache.camel.spi.ManagementObjectStrategy}.
169 */
170public class DefaultManagementObjectStrategy implements ManagementObjectStrategy {
171
172    public Object getManagedObjectForCamelContext(CamelContext context) {
173        ManagedCamelContext mc = new ManagedCamelContext((ModelCamelContext)context);
174        mc.init(context.getManagementStrategy());
175        return mc;
176    }
177
178    public Object getManagedObjectForCamelHealth(CamelContext context) {
179        ManagedCamelHealth mch = new ManagedCamelHealth(context);
180        mch.init(context.getManagementStrategy());
181        return mch;
182    }
183
184    @SuppressWarnings({"deprecation", "unchecked"})
185    public Object getManagedObjectForComponent(CamelContext context, Component component, String name) {
186        ManagedComponent mc = new ManagedComponent(name, component);
187        mc.init(context.getManagementStrategy());
188        return mc;
189    }
190
191    @SuppressWarnings({"deprecation", "unchecked"})
192    public Object getManagedObjectForDataFormat(CamelContext context, DataFormat dataFormat) {
193        ManagedDataFormat md = new ManagedDataFormat(context, dataFormat);
194        md.init(context.getManagementStrategy());
195        return md;
196    }
197
198    @SuppressWarnings({"deprecation", "unchecked"})
199    public Object getManagedObjectForEndpoint(CamelContext context, Endpoint endpoint) {
200        // we only want to manage singleton endpoints
201        if (!endpoint.isSingleton()) {
202            return null;
203        }
204
205        if (endpoint instanceof BrowsableEndpoint) {
206            ManagedBrowsableEndpoint me = new ManagedBrowsableEndpoint((BrowsableEndpoint) endpoint);
207            me.init(context.getManagementStrategy());
208            return me;
209        } else {
210            ManagedEndpoint me = new ManagedEndpoint(endpoint);
211            me.init(context.getManagementStrategy());
212            return me;
213        }
214    }
215
216    public Object getManagedObjectForErrorHandler(CamelContext context, RouteContext routeContext,
217                                                  Processor errorHandler, ErrorHandlerFactory errorHandlerBuilder) {
218        ManagedErrorHandler me = new ManagedErrorHandler(routeContext, errorHandler, errorHandlerBuilder);
219        me.init(context.getManagementStrategy());
220        return me;
221    }
222
223    public Object getManagedObjectForRouteController(CamelContext context) {
224        ManagedRouteController mrc = new ManagedRouteController((ModelCamelContext) context);
225        mrc.init(context.getManagementStrategy());
226        return mrc;
227    }
228
229    public Object getManagedObjectForRoute(CamelContext context, Route route) {
230        ManagedRoute mr;
231        if (route.supportsSuspension()) {
232            mr = new ManagedSuspendableRoute((ModelCamelContext)context, route);
233        } else {
234            mr = new ManagedRoute((ModelCamelContext)context, route);
235        }
236        mr.init(context.getManagementStrategy());
237        return mr;
238    }
239
240    public Object getManagedObjectForThreadPool(CamelContext context, ThreadPoolExecutor threadPool,
241                                                String id, String sourceId, String routeId, String threadPoolProfileId) {
242        ManagedThreadPool mtp = new ManagedThreadPool(context, threadPool, id, sourceId, routeId, threadPoolProfileId);
243        mtp.init(context.getManagementStrategy());
244        return mtp;
245    }
246
247    public Object getManagedObjectForEventNotifier(CamelContext context, EventNotifier eventNotifier) {
248        ManagedEventNotifier men = new ManagedEventNotifier(context, eventNotifier);
249        men.init(context.getManagementStrategy());
250        return men;
251    }
252
253    public Object getManagedObjectForConsumer(CamelContext context, Consumer consumer) {
254        ManagedConsumer mc;
255        if (consumer instanceof ScheduledPollConsumer) {
256            mc = new ManagedScheduledPollConsumer(context, (ScheduledPollConsumer) consumer);
257        } else {
258            mc = new ManagedConsumer(context, consumer);
259        }
260        mc.init(context.getManagementStrategy());
261        return mc;
262    }
263
264    public Object getManagedObjectForProducer(CamelContext context, Producer producer) {
265        ManagedProducer mp = new ManagedProducer(context, producer);
266        mp.init(context.getManagementStrategy());
267        return mp;
268    }
269
270    public Object getManagedObjectForService(CamelContext context, Service service) {
271        ManagedService mc = new ManagedService(context, service);
272        mc.init(context.getManagementStrategy());
273        return mc;
274    }
275
276    public Object getManagedObjectForClusterService(CamelContext context, CamelClusterService service) {
277        ManagedClusterService mcs = new ManagedClusterService(context, service);
278        mcs.init(context.getManagementStrategy());
279        return mcs;
280    }
281
282    @SuppressWarnings({"deprecation", "unchecked"})
283    public Object getManagedObjectForProcessor(CamelContext context, Processor processor,
284                                               NamedNode node, Route route) {
285        ManagedProcessor answer = null;
286
287        ProcessorDefinition<?> definition = (ProcessorDefinition<?>) node;
288
289        if (definition instanceof RecipientListDefinition) {
290            // special for RecipientListDefinition, as the processor is wrapped in a pipeline as last
291            Pipeline pipeline = (Pipeline) processor;
292            Iterator<Processor> it = pipeline.getProcessors().iterator();
293            while (it.hasNext()) {
294                processor = it.next();
295            }
296        }
297
298        // unwrap delegates as we want the real target processor
299        Processor target = processor;
300        while (target != null) {
301
302            // skip error handlers
303            if (target instanceof ErrorHandler) {
304                return false;
305            }
306
307            if (target instanceof ConvertBodyProcessor) {
308                answer = new ManagedConvertBody(context, (ConvertBodyProcessor) target, definition);
309            } else if (target instanceof ChoiceProcessor) {
310                answer = new ManagedChoice(context, (ChoiceProcessor) target, definition);
311            } else if (target instanceof ClaimCheckProcessor) {
312                answer = new ManagedClaimCheck(context, (ClaimCheckProcessor) target, definition);
313            } else if (target instanceof Delayer) {
314                answer = new ManagedDelayer(context, (Delayer) target, definition);
315            } else if (target instanceof Throttler) {
316                answer = new ManagedThrottler(context, (Throttler) target, definition);
317            } else if (target instanceof DynamicRouter) {
318                answer = new ManagedDynamicRouter(context, (DynamicRouter) target, (org.apache.camel.model.DynamicRouterDefinition) definition);
319            } else if (target instanceof RoutingSlip) {
320                answer = new ManagedRoutingSlip(context, (RoutingSlip) target, (org.apache.camel.model.RoutingSlipDefinition) definition);
321            } else if (target instanceof FilterProcessor) {
322                answer = new ManagedFilter(context, (FilterProcessor) target, (ExpressionNode)definition);
323            } else if (target instanceof LogProcessor) {
324                answer = new ManagedLog(context, (LogProcessor) target, definition);
325            } else if (target instanceof LoopProcessor) {
326                answer = new ManagedLoop(context, (LoopProcessor) target, (org.apache.camel.model.LoopDefinition) definition);
327            } else if (target instanceof MarshalProcessor) {
328                answer = new ManagedMarshal(context, (MarshalProcessor) target, (org.apache.camel.model.MarshalDefinition) definition);
329            } else if (target instanceof UnmarshalProcessor) {
330                answer = new ManagedUnmarshal(context, (UnmarshalProcessor) target, (org.apache.camel.model.UnmarshalDefinition) definition);
331            } else if (target instanceof FailOverLoadBalancer) {
332                answer = new ManagedFailoverLoadBalancer(context, (FailOverLoadBalancer) target, (org.apache.camel.model.LoadBalanceDefinition) definition);
333            } else if (target instanceof RandomLoadBalancer) {
334                answer = new ManagedRandomLoadBalancer(context, (RandomLoadBalancer) target, (org.apache.camel.model.LoadBalanceDefinition) definition);
335            } else if (target instanceof RoundRobinLoadBalancer) {
336                answer = new ManagedRoundRobinLoadBalancer(context, (RoundRobinLoadBalancer) target, (org.apache.camel.model.LoadBalanceDefinition) definition);
337            } else if (target instanceof StickyLoadBalancer) {
338                answer = new ManagedStickyLoadBalancer(context, (StickyLoadBalancer) target, (org.apache.camel.model.LoadBalanceDefinition) definition);
339            } else if (target instanceof TopicLoadBalancer) {
340                answer = new ManagedTopicLoadBalancer(context, (TopicLoadBalancer) target, (org.apache.camel.model.LoadBalanceDefinition) definition);
341            } else if (target instanceof WeightedLoadBalancer) {
342                answer = new ManagedWeightedLoadBalancer(context, (WeightedLoadBalancer) target, (org.apache.camel.model.LoadBalanceDefinition) definition);
343            } else if (target instanceof RecipientList) {
344                answer = new ManagedRecipientList(context, (RecipientList) target, (RecipientListDefinition) definition);
345            } else if (target instanceof Splitter) {
346                answer = new ManagedSplitter(context, (Splitter) target, (org.apache.camel.model.SplitDefinition) definition);
347            } else if (target instanceof MulticastProcessor) {
348                answer = new ManagedMulticast(context, (MulticastProcessor) target, definition);
349            } else if (target instanceof SamplingThrottler) {
350                answer = new ManagedSamplingThrottler(context, (SamplingThrottler) target, definition);
351            } else if (target instanceof Resequencer) {
352                answer = new ManagedResequencer(context, (Resequencer) target, definition);
353            } else if (target instanceof RollbackProcessor) {
354                answer = new ManagedRollback(context, (RollbackProcessor) target, definition);
355            } else if (target instanceof StreamResequencer) {
356                answer = new ManagedResequencer(context, (StreamResequencer) target, definition);
357            } else if (target instanceof SetBodyProcessor) {
358                answer = new ManagedSetBody(context, (SetBodyProcessor) target, (org.apache.camel.model.SetBodyDefinition) definition);
359            } else if (target instanceof RemoveHeaderProcessor) {
360                answer = new ManagedRemoveHeader(context, (RemoveHeaderProcessor) target, definition);
361            } else if (target instanceof RemoveHeadersProcessor) {
362                answer = new ManagedRemoveHeaders(context, (RemoveHeadersProcessor) target, definition);
363            } else if (target instanceof SetHeaderProcessor) {
364                answer = new ManagedSetHeader(context, (SetHeaderProcessor) target, (org.apache.camel.model.SetHeaderDefinition) definition);
365            } else if (target instanceof RemovePropertyProcessor) {
366                answer = new ManagedRemoveProperty(context, (RemovePropertyProcessor) target, definition);
367            } else if (target instanceof RemovePropertiesProcessor) {
368                answer = new ManagedRemoveProperties(context, (RemovePropertiesProcessor) target, definition);
369            } else if (target instanceof SetPropertyProcessor) {
370                answer = new ManagedSetProperty(context, (SetPropertyProcessor) target, (org.apache.camel.model.SetPropertyDefinition) definition);
371            } else if (target instanceof ExchangePatternProcessor) {
372                answer = new ManagedSetExchangePattern(context, (ExchangePatternProcessor) target, definition);
373            } else if (target instanceof ScriptProcessor) {
374                answer = new ManagedScript(context, (ScriptProcessor) target, (org.apache.camel.model.ScriptDefinition) definition);
375            } else if (target instanceof StopProcessor) {
376                answer = new ManagedStop(context, (StopProcessor) target, definition);
377            } else if (target instanceof ThreadsProcessor) {
378                answer = new ManagedThreads(context, (ThreadsProcessor) target, definition);
379            } else if (target instanceof ThrowExceptionProcessor) {
380                answer = new ManagedThrowException(context, (ThrowExceptionProcessor) target, definition);
381            } else if (target instanceof TransformProcessor) {
382                answer = new ManagedTransformer(context, (TransformProcessor) target, (org.apache.camel.model.TransformDefinition) definition);
383            } else if (target instanceof PredicateValidatingProcessor) {
384                answer = new ManagedValidate(context, (PredicateValidatingProcessor) target, (org.apache.camel.model.ValidateDefinition) definition);
385            } else if (target instanceof WireTapProcessor) {
386                answer = new ManagedWireTapProcessor(context, (WireTapProcessor) target, definition);
387            } else if (target instanceof SendDynamicProcessor) {
388                answer = new ManagedSendDynamicProcessor(context, (SendDynamicProcessor) target, definition);
389            } else if (target instanceof SendProcessor) {
390                SendProcessor sp = (SendProcessor) target;
391                // special for sending to throughput logger
392                if (sp.getDestination() instanceof LogEndpoint) {
393                    LogEndpoint le = (LogEndpoint) sp.getDestination();
394                    if (le.getLogger() instanceof ThroughputLogger) {
395                        ThroughputLogger tl = (ThroughputLogger) le.getLogger();
396                        answer = new ManagedThroughputLogger(context, tl, definition);
397                    }
398                }
399                // regular send processor
400                if (answer == null) {
401                    answer = new ManagedSendProcessor(context, (SendProcessor) target, definition);
402                }
403            } else if (target instanceof BeanProcessor) {
404                answer = new ManagedBeanProcessor(context, (BeanProcessor) target, definition);
405            } else if (target instanceof IdempotentConsumer) {
406                answer = new ManagedIdempotentConsumer(context, (IdempotentConsumer) target, (org.apache.camel.model.IdempotentConsumerDefinition) definition);
407            } else if (target instanceof AggregateProcessor) {
408                answer = new ManagedAggregateProcessor(context, (AggregateProcessor) target, (org.apache.camel.model.AggregateDefinition) definition);
409            } else if (target instanceof Enricher) {
410                answer = new ManagedEnricher(context, (Enricher) target, (org.apache.camel.model.EnrichDefinition) definition);
411            } else if (target instanceof PollEnricher) {
412                answer = new ManagedPollEnricher(context, (PollEnricher) target, (org.apache.camel.model.PollEnrichDefinition) definition);
413            }
414
415            // special for custom load balancer
416            if (definition instanceof LoadBalanceDefinition) {
417                LoadBalanceDefinition lb = (LoadBalanceDefinition) definition;
418                if (lb.getLoadBalancerType() instanceof CustomLoadBalancerDefinition) {
419                    answer = new ManagedCustomLoadBalancer(context, (LoadBalancer) target, (LoadBalanceDefinition) definition);
420                }
421            }
422
423            if (answer != null) {
424                // break out as we found an answer
425                break;
426            }
427
428            // no answer yet, so unwrap any delegates and try again
429            if (target instanceof DelegateProcessor) {
430                target = ((DelegateProcessor) target).getProcessor();
431            } else {
432                // no delegate so we dont have any target to try next
433                break;
434            }
435        }
436
437        if (answer == null && definition instanceof ProcessDefinition) {
438            answer = new ManagedProcess(context, target, (ProcessDefinition) definition);
439        } else if (answer == null) {
440            // fallback to a generic processor
441            answer = new ManagedProcessor(context, target, definition);
442        }
443
444        answer.setRoute(route);
445        answer.init(context.getManagementStrategy());
446        return answer;
447    }
448
449}