com.mastfrog.acteur.OnBeforeEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acteur Show documentation
There is a newer version: 2.9.7
/*
 * The MIT License
 *
 * Copyright 2023 Mastfrog Technologies.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.mastfrog.acteur;

import io.netty.channel.Channel;

/**
 * Interface which, if present, will be invoked before entering request
 * scope
 * and can provide a set of objects to make available in the request scope,
 * which will be consistent regardless of the page/acteur chain which eventually
 * handles responding to the request (if any).
 * 
 * Binding an implementation of this interface is optional.
 * 
 *
 * @author Tim Boudreau
 */
public interface OnBeforeEvent {

    /**
     * Called before the event is processed to generate some additional objects
     * for injection.
     *
     * @param event The event (usually HttpEvent).
     * @param channel The Netty Channel in use
     * @param internalId An internal ID object used by the framework, which
     * must
     * be included in the returned array.
     * @return An array of objects for injection.
     */
    Object[] onBeforeEvent(final Event event, final Channel channel, Object internalId);
}