deltaspike/cdictrl/api/src/main/java/org/apache/deltaspike/cdise/api/ContextControl.java

/*
 * 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.deltaspike.cdise.api;

import java.lang.annotation.Annotation;

/**
 * Control native CDI Container Contexts.
 * Just inject this interface and you gain manual access over built-in Contexts.
 * The respective integration code will provide a &064;Dependent scoped instance
 * which itself is stateless.
 *
 * The {@link #startContext(Class)} and {@link #stopContext(Class)} only affect
 * the current Thread. When leaving a Thread each started context needs to get
 * stopped as well (best practice is to do that in a <i>finally</i> block.
 *
 * If a container supports controlling the Session Context then each Thread will
 * get a new 'dummy' storage assigned. It is not intended to 'attach' to a real
 * Session but to allow the re-use of existing beans.
 *
 * Many containers make heavy use of ThreadLocals. Thus it might be necessary to
 * call
 * <pre>
 *     contextControl.startContext(ApplicationScoped.class);
 * </pre>
 * to 'attach' or 'activate' the ApplicationContext within your current Thread.
 */
public interface ContextControl
{
    /**
     * This will start all container built-in Contexts
     */
    void startContexts();

    /**
     * Stop all container built-in Contexts and destroy all beans properly
     */
    void stopContexts();

    /**
     * Start the specified scope. This only works for scopes which are handled
     * by the CDI container itself. Custom scoped of 3rd party
     * Context implementations shall be started directly (they are portable anyway).
     *
     * @param scopeClass e.g. RequestScoped.class
     */
    void startContext(Class<? extends Annotation> scopeClass);

    /**
     * Stop the specified scope. This only works for scopes which are handled
     * by the CDI container itself. Custom scoped of 3rd party
     * Context implementations shall be stopped directly (they are portable anyway).
     *
     * @param scopeClass e.g. RequestScoped.class
     */
    void stopContext(Class<? extends Annotation> scopeClass);


}