jakarta.enterprise.event.Shutdown Maven / Gradle / Ivy
Show all versions of jakarta.enterprise.cdi-api Show documentation
/*
* Copyright 2021, Red Hat, Inc., and individual contributors
*
* 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 jakarta.enterprise.event;
/**
*
* A CDI event with payload of type {@link Shutdown} and qualifier {@link jakarta.enterprise.inject.Any} is
* synchronously fired by CDI container during application shutdown.
* Applications must never manually fire any events with {@link Shutdown} as payload.
*
*
*
* Implementations have to fire this event during CDI container shutdown, but not later than the event with qualifier
* {@code @BeforeDestroyed(ApplicationScoped.class)}.
*
*
*
* This event can be observed by integrators and libraries to perform any kind of pre-shutdown operation as well as by
* users as a reliable entry point for when the CDI container is about to shut down.
*
*
*
* Observers are encouraged to specify {@code @Priority} to determine ordering with lower priority numbers being
* recommended for user applications and higher numbers for platform/framework/library integration.
*
* See also {@link jakarta.interceptor.Interceptor.Priority}
*/
public class Shutdown {
}