org.apache.camel.guice.CamelModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-guice Show documentation
Using Camel with Guice
There is a newer version: 2.25.4
/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.guice;

import org.apache.camel.CamelContext;
import org.apache.camel.Consume;
import org.apache.camel.EndpointInject;
import org.apache.camel.Produce;
import org.apache.camel.guice.impl.ConsumerInjection;
import org.apache.camel.guice.impl.EndpointInjector;
import org.apache.camel.guice.impl.ProduceInjector;
import org.apache.camel.guice.jsr250.Jsr250Module;

/**
 * A base Guice module for creating a {@link CamelContext} leaving it up to the users module
 * to bind a Set for the routing rules.
 * 
 * To bind the routes you should create a provider method annotated with @Provides and returning Set such as
 * 
 * public class MyModule extends CamelModule {
 *   @Provides
 *   Set<Routes> routes(Injector injector) { ... }
 * }
 * 
 * If you wish to bind all of the bound {@link org.apache.camel.RoutesBuilder} implementations available - maybe with some filter applied - then
 * please use the {@link org.apache.camel.guice.CamelModuleWithMatchingRoutes}.
 * 
 * Otherwise if you wish to list all of the classes of the {@link org.apache.camel.RoutesBuilder} implementations then use the
 * {@link org.apache.camel.guice.CamelModuleWithRouteTypes} module instead.
 *
 * @version 
 */
public class CamelModule extends Jsr250Module {
    
    protected void configureCamelContext() {
        bind(CamelContext.class).to(GuiceCamelContext.class).asEagerSingleton();
    }

    protected void configure() {
        super.configure();
        
        configureCamelContext();
        
        bindAnnotationInjector(EndpointInject.class, EndpointInjector.class);
        bindAnnotationInjector(Produce.class, ProduceInjector.class);

        bindMethodHandler(Consume.class, ConsumerInjection.class);
    }

}