com.aliyun.mns.client.MNSClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aliyun-sdk-mns Show documentation
There is a newer version: 1.3.1
/*
 * 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 com.aliyun.mns.client;

import com.aliyun.mns.common.ClientException;
import com.aliyun.mns.common.ServiceException;
import com.aliyun.mns.model.AccountAttributes;
import com.aliyun.mns.model.PagingListResult;
import com.aliyun.mns.model.QueueMeta;
import com.aliyun.mns.model.TopicMeta;
import com.aliyun.mns.model.response.commonbuy.OpenServiceResponse;
import java.util.Vector;

public interface MNSClient {
    /**
     * 关闭 client, close之后这个client的资源可能随时被释放
     */
    public void close();

    /**
     * 检查client是否为打开状态
     *
     * @return is open or not
     */
    public boolean isOpen();

    /**
     * 设置当前用户的账号级别属性
     *
     * @param accountAttributes object
     * @throws ServiceException exception
     * @throws ClientException  exception
     */
    public void SetAccountAttributes(AccountAttributes accountAttributes) throws ServiceException, ClientException;

    /**
     * 获取当前用户的账号级别属性
     *
     * @return AccountAttributes object
     * @throws ServiceException exception
     * @throws ClientException  exception
     */
    public AccountAttributes GetAccountAttributes() throws ServiceException, ClientException;

    /**
     * 根据队列的URL创建CloudQueue对象，后于后续对改对象的创建、查询等
     *
     * @param queueName exception
     * @return CloudQueue object
     */
    public CloudQueue getQueueRef(String queueName);

    /**
     * 创建队列
     *
     * @param queue 队列属性
     * @return CloudQueue object
     * @throws ClientException  exception
     * @throws ServiceException exception
     */
    public CloudQueue createQueue(QueueMeta queue) throws ClientException,
        ServiceException;

    /**
     * Get reference to a transaction queue object by given queue name.
     * note: it will not do create queue operation and assumes the queue
     * has already be create properly.
     *
     * @param queueName queueName
     * @param checker   TransactionChecker to check the transaction message status.
     * @return TransactionQueue object
     *
     * The product no longer supports this function
     */
    @Deprecated
    public TransactionQueue getTransQueueRef(String queueName, TransactionChecker checker);

    /**
     * Creates transaction queue.
     * 
     * delayTime should be bigger than lifetime to make sure that that message will not be visible to consumer by default.
     *
     * @param queueMeta queue properties.
     * @param checker   TransactionChecker to check the transaction message status.
     * @param lifeTime  message life time in seconds
     * @param delayTime message delay time in seconds
     * @return transaction queue
     * @throws ClientException  exception
     * @throws ServiceException exception
     *
     * The product no longer supports this function
     */
    @Deprecated
    public TransactionQueue createTransQueue(QueueMeta queueMeta, TransactionChecker checker, long lifeTime,
        long delayTime) throws ClientException,
        ServiceException;

    /**
     * Creates transaction queue with default message life time and delayTime
     *
     * @param queueMeta queue properties.
     * @param checker   TransactionChecker to check the transaction message status.
     * @return transaction queue
     * @throws ClientException  exception
     * @throws ServiceException exception
     *
     * The product no longer supports this function
     */
    @Deprecated
    public TransactionQueue createTransQueue(QueueMeta queueMeta,
        TransactionChecker checker) throws ClientException, ServiceException;

    /**
     * Creates cloud pull topic.
     *
     * @param topicMeta         topic properties.
     * @param queueNameList     the queue name list which are going to be endpoint of new created topic.
     * @param needCreateQueue   flag to indicate that if we need to create the queue in the queueNameList.
     * @param queueMetaTemplate the queueMeta template used to create queues in queueNamelist if need.
     * @return cloud pull topic
     * @throws ClientException  exception
     * @throws ServiceException exception
     */
    public CloudPullTopic createPullTopic(TopicMeta topicMeta, Vector queueNameList, boolean needCreateQueue,
        QueueMeta queueMetaTemplate) throws ClientException, ServiceException;

    /**
     * Creates cloud pull topic.
     *
     * @param topicMeta         topic properties.
     * @param queueNameList     the queue name list which are going to be endpoint of new created topic.
     * @param needCreateQueue   flag to indicate that if we need to create the queue in the queueNameList.
     * @param queueMetaTemplate the queueMeta template used to create queues in queueNamelist if need.
     * @param tagList           the filter tag list for each consumer queue.
     * @return cloud pull topic
     * @throws ClientException  exception
     * @throws ServiceException exception
     */
    public CloudPullTopic createPullTopic(TopicMeta topicMeta, Vector queueNameList, boolean needCreateQueue,
        QueueMeta queueMetaTemplate, Vector tagList) throws ClientException, ServiceException;

    /**
     * Creates cloud pull topic.
     *
     * @param topicMeta     topic properties.
     * @param queueNameList the queue name list which are going to be endpoint of new created topic.
     * @return cloud pull topic
     * @throws ClientException  exception
     * @throws ServiceException exception
     */
    public CloudPullTopic createPullTopic(TopicMeta topicMeta,
        Vector queueNameList) throws ClientException, ServiceException;

    /**
     * Creates transaction queue with default message life time and delayTime
     *
     * @param queueMeta queue properties.
     * @return transaction queue
     * @throws ClientException  exception
     * @throws ServiceException exception
     *
     * The product no longer supports this function
     */
    @Deprecated
    public TransactionQueue createTransQueue(QueueMeta queueMeta) throws ClientException, ServiceException;

    /**
     * 列举队列
     *
     * @param prefix    队列名前缀
     * @param marker    列举的起始位置，""表示从第一个开始，也可以是前一次列举返回的marker
     * @param retNumber 最多返回的个数
     * @return 返回队列属性列表及marker
     * @throws ClientException  exception
     * @throws ServiceException exception
     */
    PagingListResult listQueue(String prefix, String marker,
        Integer retNumber) throws ClientException, ServiceException;

    /**
     * 列举队列
     *
     * @param prefix    队列名前缀
     * @param marker    列举的起始位置，""表示从第一个开始，也可以是前一次列举返回的marker
     * @param retNumber 最多返回的个数
     * @return 返回队列URL列表及marker
     * @throws ClientException  exception
     * @throws ServiceException exception
     */
    PagingListResult listQueueURL(String prefix, String marker,
        Integer retNumber) throws ClientException, ServiceException;

    /**
     * 根据Tpoic的URL创建CloudTopic对象，后于后续对改对象的创建、查询等
     *
     * @param topicName topic name
     * @return CloudTopic
     */
    public CloudTopic getTopicRef(String topicName);

    /**
     * 根据Topic的meta数据，创建CloudTopic对象，用于后续的消息发送等
     *
     * @param meta CloudTpoic的meta数据
     * @return CloudTpoic对象
     */
    public CloudTopic createTopic(TopicMeta meta) throws ServiceException;

    /**
     * @param prefix    topic name前缀
     * @param marker    topic的起始位置，""表示从第一个开始，也可以是前一次列举返回的marker
     * @param retNumber 最多返回的个数
     * @return topic meta列表及marker数据
     * @throws ClientException  exception
     * @throws ServiceException exception
     */
    public PagingListResult listTopic(String prefix, String marker,
        Integer retNumber) throws ClientException, ServiceException;

    /**
     * @param prefix    topic name前缀
     * @param marker    topic的起始位置，""表示从第一个开始，也可以是前一次列举返回的marker
     * @param retNumber 最多返回的个数
     * @return topic url列表及marker数据
     * @throws ClientException  exception
     * @throws ServiceException exception
     */
    public PagingListResult listTopicURL(String prefix, String marker,
        Integer retNumber) throws ClientException, ServiceException;

    /**
     * 开通 mns
     *
     * @return response
     */
    public OpenServiceResponse openService() throws ServiceException;
}