jakarta.enterprise.inject.build.compatible.spi.SyntheticObserver Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2021 Red Hat and others
 *
 * This program and the accompanying materials are made available under the
 * Apache Software License 2.0 which is available at:
 * https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package jakarta.enterprise.inject.build.compatible.spi;

import jakarta.enterprise.event.ObserverException;
import jakarta.enterprise.inject.spi.EventContext;

/**
 * The event notification function for a synthetic observer defined by {@link SyntheticObserverBuilder}.
 * CDI container will create an instance of the event notification function every time when it needs
 * to notify the synthetic observer. Implementations must be {@code public} classes with a {@code public}
 * zero-parameter constructor; they must not be beans.
 *
 * @param  the observed event type of the synthetic observer
 * @since 4.0
 */
public interface SyntheticObserver {
    /**
     * Consumes an event. The {@link EventContext} provides access to the event payload,
     * as well as the {@link jakarta.enterprise.inject.spi.EventMetadata EventMetadata}.
     * 
     * The parameter map contains the same values that were passed to
     * the {@link SyntheticObserverBuilder} that defined the synthetic observer.
     *
     * @param event the event context, never {@code null}
     * @param params the parameter map, never {@code null}
     * @throws Exception checked exception will be wrapped and rethrown as an {@link ObserverException}
     */
    void observe(EventContext event, Parameters params) throws Exception;
}