org.dbrain.binder.app.App Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbrain-binder Show documentation

Guice-like facade to the unfriendly HK2 service locator.

There is a newer version: 0.13

/*
 * Copyright [2015] [Eric Poitras]
 *
 *     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.
 */

package org.dbrain.binder.app;

import org.dbrain.binder.directory.ServiceDirectory;
import org.dbrain.binder.system.app.AppImpl;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.hk2.api.ServiceLocatorFactory;
import org.jvnet.hk2.annotations.Contract;

/**
 * Base application class. Binds the service directory with capacity of
 * configuration and a shutdown hook.
 */
@Contract
public interface App extends AutoCloseable, ServiceDirectory {

    /**
     * @return Create an application with an auto-generated name.
     */
    static App create() {
        return new AppImpl();
    }

    /**
     * @return Get or create an application with a specific name.
     *
     * The application will be created only if it does not preexists.
     */
    static App getOrCreate( String name ) {
        App app = null;
        ServiceLocator serviceLocator = ServiceLocatorFactory.getInstance().find( name );
        if ( serviceLocator != null ) {
            app = serviceLocator.getService( App.class );
        }
        if ( app == null ) {
            app = new AppImpl( name );
        }
        return app;
    }

    /**
     * The instance name. Can be used to retrieve the application by name.
     */
    String getName();

    /**
     * Allows to configure services in the application.
     */
    void configure( Module module );

    /**
     * Allows to configure services in the application.
     */
    void configure( Class ... moduleClass );


}