ConfigInterface.php 934 Bytes
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Framework\MessageQueue\Publisher;

use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\MessageQueue\Publisher\Config\PublisherConfigItemInterface;

/**
 * Publisher config interface provides access data declared in etc/queue_publisher.xml
 *
 * @api
 * @since 102.0.1
 */
interface ConfigInterface
{
    /**
     * Get publisher configuration by topic.
     *
     * @param string $topic
     * @return PublisherConfigItemInterface
     * @throws LocalizedException
     * @throws \LogicException
     * @since 102.0.1
     */
    public function getPublisher($topic);

    /**
     * Get list of all publishers declared in the system.
     *
     * @return PublisherConfigItemInterface[]
     * @throws \LogicException
     * @since 102.0.1
     */
    public function getPublishers();
}