io.gravitee.gateway.reactive.api.hook.HttpHook Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-gateway-api Show documentation

There is a newer version: 3.9.0-alpha.26

/*
 * Copyright © 2015 The Gravitee team (http://gravitee.io)
 *
 * 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.gravitee.gateway.reactive.api.hook;

import io.gravitee.gateway.reactive.api.ExecutionFailure;
import io.gravitee.gateway.reactive.api.ExecutionPhase;
import io.gravitee.gateway.reactive.api.context.ExecutionContext;
import io.gravitee.gateway.reactive.api.context.http.HttpExecutionContext;
import io.reactivex.rxjava3.annotations.Nullable;
import io.reactivex.rxjava3.core.Completable;

/**
 * Interface that can be used to add generic behaviour
 *
 * @author Guillaume LAMIRAND (guillaume.lamirand at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface HttpHook {
    String id();

    default Completable pre(final String id, final HttpExecutionContext ctx, @Nullable final ExecutionPhase executionPhase) {
        return Completable.complete();
    }

    default Completable post(final String id, final HttpExecutionContext ctx, @Nullable final ExecutionPhase executionPhase) {
        return Completable.complete();
    }

    default Completable error(
        final String id,
        final HttpExecutionContext ctx,
        @Nullable final ExecutionPhase executionPhase,
        final Throwable throwable
    ) {
        return Completable.complete();
    }

    default Completable interrupt(final String id, final HttpExecutionContext ctx, @Nullable final ExecutionPhase executionPhase) {
        return Completable.complete();
    }

    default Completable interruptWith(
        final String id,
        final HttpExecutionContext ctx,
        @Nullable final ExecutionPhase executionPhase,
        final ExecutionFailure failure
    ) {
        return Completable.complete();
    }

    default void cancel(final String id, final HttpExecutionContext ctx, @Nullable final ExecutionPhase executionPhase) {
        // Nothing to do by default
    }
}