io.axoniq.axonserver.connector.InstructionHandler Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2020. AxonIQ
 *
 * 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 io.axoniq.axonserver.connector;

/**
 * Interface describing a component that is capable of handling instructions coming from AxonServer.
 *
 * @param  the type of the instruction handled by this handler
 * @param  the type of response used by {@link #handle(Object, ReplyChannel)}'s {@link ReplyChannel}
 */
@FunctionalInterface
public interface InstructionHandler {

    /**
     * Handle the given {@code instruction}, using {@code replyChannel} to acknowledge the instruction and reply to
     * AxonServer.
     *
     * @param instruction  the instruction to handle
     * @param replyChannel the channel onto which replies and acknowledgements to send
     */
    void handle(I instruction, ReplyChannel replyChannel);
}