io.joynr.runtime.JoynrApplicationModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of messaging-common Show documentation
The newest version!
/*
 * #%L
 * %%
 * Copyright (C) 2011 - 2017 BMW Car IT GmbH
 * %%
 * Licensed 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.
 * #L%
 */
package io.joynr.runtime;

import java.util.Properties;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.inject.Provides;
import com.google.inject.name.Named;

import io.joynr.guice.ApplicationModule;

/**
 * This class uses joynr specific properties to configure the Guice InjectorFactory when creating
 * joynr applications. This module binds the unique identifier of the application as well as the subclass of IApplication
 * which is binded for instantiaton.
 */
public class JoynrApplicationModule extends ApplicationModule {
    Logger logger = LoggerFactory.getLogger(JoynrApplicationModule.class);

    static final String PATTERN_STARTS_WITH_JOYNAPP = "^(joynrapp).*$";
    public static final String KEY_JOYNR_APPLICATION_PROPERTIES = "joynr.application.properties";

    @Provides
    @Named(KEY_JOYNR_APPLICATION_PROPERTIES)
    Properties joynrApplcationProperties() {
        return properties;
    }

    /**
     * @param applicationClass the class used for application instantiation
     */
    public JoynrApplicationModule(Class applicationClass) {
        this(applicationClass.getName(), applicationClass);
    }

    /**
     * @param applicationClass the class used for application instantiation
     * @param properties application specific properties to be binded via this module
     */
    public JoynrApplicationModule(Class applicationClass, Properties properties) {
        this(applicationClass.getName(), applicationClass, properties);
    }

    /**
     * @param appId the unique identified of the application to be generated
     * @param applicationClass the class used for application instantiation
     */
    public JoynrApplicationModule(String appId, Class applicationClass) {
        this(appId, applicationClass, new Properties());
    }

    /**
     * @param appId the unique identified of the applicaiton to be generated
     * @param applicationClass the class used for application instantiation
     * @param properties application specific properties to be binded via this module
     */
    public JoynrApplicationModule(String appId,
                                  Class applicationClass,
                                  Properties properties) {
        super(appId, applicationClass, combineProperties(properties));

    }

    /**
     * @param applicationSpecificProperties properties to be combined with the joynr specific
     *        system properties
     * @return new Properties object containing a combined set of submitted properties and joynr
     *        specific system properties
     */
    private static Properties combineProperties(Properties applicationSpecificProperties) {
        // System properties ()set on java startup using -Djoynrapp.propertykey=propertyvalue
        if (applicationSpecificProperties == null) {
            applicationSpecificProperties = new Properties();
        }
        applicationSpecificProperties.putAll(PropertyLoader.getPropertiesWithPattern(System.getProperties(),
                                                                                     PATTERN_STARTS_WITH_JOYNAPP));
        return applicationSpecificProperties;
    }

}