io.streamthoughts.azkarra.api.StreamsLifecycleInterceptor Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019-2020 StreamThoughts.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.streamthoughts.azkarra.api;

/**
 * An interface that allows to intercept a {@link org.apache.kafka.streams.KafkaStreams} instance before being
 * started or stopped.
 */
public interface StreamsLifecycleInterceptor {

    /**
     * Intercepts the streams instance before being started.
     *
     * @param chain the {@link StreamsLifecycleChain} instance.
     */
    default void onStart(final StreamsLifecycleContext context, final StreamsLifecycleChain chain) {
        chain.execute();
    }

    /**
     * Intercepts the streams instance before being stopped.
     *
     * @param chain the {@link StreamsLifecycleChain} instance.
     */
    default void onStop(final StreamsLifecycleContext context, final StreamsLifecycleChain chain) {
        chain.execute();
    }

    /**
     * The Interceptor name is mostly used for logging information.
     *
     * @return the name of this interceptor.
     */
    default String name() {
        return getClass().getSimpleName();
    }
}