CDILoader.java

/*
 * Copyright (C) 2013,2014 The Cat Hive Developers.
 *
 * 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 com.cathive.fx.cdi.spi;

/**
 * This service provider interface can be used to plug in different CDI provider
 * implementations into the {@link com.cathive.fx.cdi.CdiApplication} class.
 * @author Benjamin P. Jung
 */
public interface CDILoader {

    /**
     * Initializes the CDI provider instance.
     * <p>This method will be called upon initialization of CDI-based JavaFX applications.
     * After this method has been executed successfully we assume that a working CDI provider
     * instance can be obtained via a call to {@link javax.enterprise.inject.spi.CDI#current()}.</p>
     * @throws Exception
     */
    void initialize() throws Exception;

    /**
     * Shuts down the CDI provider instance.
     * @throws Exception
     */
    void shutdown() throws Exception;

}