io.hekate.messaging.intercept.MessageInterceptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hekate-core Show documentation

Java library for cluster communications and computing.

There is a newer version: 4.1.3

/*
 * Copyright 2020 The Hekate Project
 *
 * The Hekate Project 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 io.hekate.messaging.intercept;

import io.hekate.messaging.MessagingChannelConfig;
import java.util.List;

/**
 * « start hereMessage interceptor.
 *
 * 
 * This is a marker interface for {@link ClientMessageInterceptor} and {@link ServerMessageInterceptor}.
 * 
 *
 * 
 * Instances of this interface can be {@link MessagingChannelConfig#setInterceptors(List) registered} to a messaging channel in order to
 * intercept and transform messages on the client side (via {@link ClientMessageInterceptor}), on the server side
 * (via {@link ServerMessageInterceptor}) or on both sides (via {@link AllMessageInterceptor}).
 * 
 *
 * {@code
 *              Client Node                                             Server Node
 *       (ClientMessageInterceptor)                               (ServerMessageInterceptor)
 * +-------------------------------------+       request       +-----------------------------+
 * | interceptClientSend(...)            + ------------------> + interceptServerReceive(...) |
 * +-------------------------------------+                     +-------------+---------------+
 *                                                                    process request
 * +-------------------------------------+       response      +-------------v---------------+
 * | interceptClientReceiveResponse(...) + <------------------ + interceptServerSend(...)    |
 * +-------------------------------------+                     +-----------------------------+
 * }
 *
 * @see MessagingChannelConfig#setInterceptors(List)
 */
public interface MessageInterceptor {
    // No-op.
}