org.fabric3.spi.container.channel.ChannelResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation
Fabric3
There is a newer version: 3.1.0
/*
 * Fabric3
 * Copyright (c) 2009-2015 Metaform Systems
 *
 * 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 org.fabric3.spi.container.channel;

import java.util.function.Consumer;

import org.fabric3.api.host.Fabric3Exception;

/**
 * Resolves channels and returns connection proxies.
 */
public interface ChannelResolver {

    /**
     * Creates a producer proxy to a channel using the default topic.
     *
     * @param interfaze the producer interface
     * @param name      the channel name
     * @return the connection proxy
     * @throws Fabric3Exception if there is a resolution exception
     */
     T getProducer(Class interfaze, String name) throws Fabric3Exception;

    /**
     * Creates a producer proxy to a channel using the specified topic.
     *
     * @param interfaze the producer interface
     * @param name      the channel name
     * @param topic     the topic name
     * @return the connection proxy
     * @throws Fabric3Exception if there is a resolution exception
     */
     T getProducer(Class interfaze, String name, String topic) throws Fabric3Exception;

    /**
     * Creates a consumer proxy to a channel using the specified topic.
     *
     * @param interfaze the consumer interface
     * @param name      the channel name
     * @return the connection proxy
     * @throws Fabric3Exception if there is a resolution exception
     */
     T getConsumer(Class interfaze, String name);

    /**
     * Creates a consumer proxy to a channel using the default topic.
     *
     * @param interfaze the consumer interface
     * @param name      the channel name
     * @param topic     the topic name
     * @return the connection proxy
     * @throws Fabric3Exception if there is a resolution exception
     */
     T getConsumer(Class interfaze, String name, String topic);

    /**
     * Subscribes to a channel.
     *
     * @param type     the event type to receive
     * @param name     the channel name
     * @param id       the subscription id
     * @param topic    the topic
     * @param consumer the consumer to pass messages to
     * @return the subscription handle
     */
    Object subscribe(Class type, String name, String id, String topic, Consumer consumer);
}