io.smallrye.reactive.messaging.MediatorConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smallrye-reactive-messaging-api Show documentation
The newest version!
package io.smallrye.reactive.messaging;

import java.lang.reflect.Method;
import java.lang.reflect.Type;
import java.util.List;

import jakarta.enterprise.inject.spi.Bean;

import org.eclipse.microprofile.reactive.messaging.Acknowledgment;

import io.smallrye.reactive.messaging.annotations.Merge;
import io.smallrye.reactive.messaging.keyed.KeyValueExtractor;

public interface MediatorConfiguration {

    Shape shape();

    @Deprecated(since = "4.8.0")
    String getOutgoing();

    List getOutgoings();

    List getIncoming();

    String methodAsString();

    Method getMethod();

    Class getReturnType();

    Consumption consumption();

    Production production();

    boolean usesReactiveStreams();

    boolean usesBuilderTypes();

    Acknowledgment.Strategy getAcknowledgment();

    Merge.Mode getMerge();

    boolean getBroadcast();

    Bean getBean();

    int getNumberOfSubscriberBeforeConnecting();

    boolean isBlocking();

    String getWorkerPoolName();

    boolean isBlockingExecutionOrdered();

    /**
     * Implementation of the {@link Invoker} interface that can be used to invoke the method described by this configuration
     * The invoker class can either have a no-arg constructor in which case it's expected to be look up the bean
     * programmatically, or have a constructor that takes a single Object parameter - the bean to operate on
     */
    Class getInvokerClass();

    /**
     * @return the discovered ingested payload type. May be {@code null} if there is no consumption or the type cannot be
     *         extracted. Conversion is based on this type.
     */
    Type getIngestedPayloadType();

    /**
     * @return the key type when using the {@link KeyValueExtractor}, {@code null} otherwise.
     */
    Type getKeyType();

    /**
     * @return the value type when using the {@link KeyValueExtractor}, {@code null} otherwise.
     */
    Type getValueType();

    Class getKeyed();

    MethodParameterDescriptor getParameterDescriptor();

    boolean hasTargetedOutput();

    enum Production {
        STREAM_OF_MESSAGE,
        STREAM_OF_PAYLOAD,

        INDIVIDUAL_PAYLOAD,
        INDIVIDUAL_MESSAGE,
        COMPLETION_STAGE_OF_PAYLOAD,
        COMPLETION_STAGE_OF_MESSAGE,
        UNI_OF_PAYLOAD,
        UNI_OF_MESSAGE,
        SPLIT_MULTI_OF_PAYLOAD,
        SPLIT_MULTI_OF_MESSAGE,

        NONE;

        public boolean isMessageType() {
            return this == STREAM_OF_MESSAGE ||
                    this == INDIVIDUAL_MESSAGE ||
                    this == COMPLETION_STAGE_OF_MESSAGE ||
                    this == UNI_OF_MESSAGE ||
                    this == SPLIT_MULTI_OF_MESSAGE;
        }
    }

    enum Consumption {
        STREAM_OF_MESSAGE,
        STREAM_OF_PAYLOAD,
        KEYED_MULTI,
        KEYED_MULTI_MESSAGE,
        MESSAGE,
        PAYLOAD,

        NONE;

        public boolean isMessageType() {
            return this == STREAM_OF_MESSAGE ||
                    this == KEYED_MULTI_MESSAGE ||
                    this == MESSAGE;
        }
    }
}