io.helidon.microprofile.cdi.HelidonContainer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-microprofile-cdi Show documentation

Helidon extension of Weld to support ahead of time compilation

There is a newer version: 4.1.1

Show newest version

/*
 * Copyright (c) 2019, 2023 Oracle and/or its affiliates.
 *
 * 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 io.helidon.microprofile.cdi;

import io.helidon.common.context.Context;

import jakarta.enterprise.inject.se.SeContainer;

/**
 * Helidon CDI Container, separates initialization and runtime phases of the bootstrapping.
 * Initialization is static to support GraalVM native image, start is controlled by application.
 * @see io.helidon.microprofile.cdi.Main
 */
public interface HelidonContainer {
    /**
     * Start the container. This will finish the lifecycle of CDI implementation.
     * If already started, this method is a noop.
     *
     * @return the started container
     */
    SeContainer start();

    /**
     * The root context of MP.
     *
     * @return context
     */
    Context context();

    /**
     * Get the (initialized or started) container.
     * @return the singleton instance of container
     */
    static HelidonContainer instance() {
        return ContainerInstanceHolder.get();
    }

    /**
     * Shutdown the container (and CDI).
     */
    void shutdown();
}