/*
 * (C) 2007-2012 Alibaba Group Holding Limited.
 * 
 * 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.
 * Authors:
 *   wuhua <wq163@163.com> , boyan <killme2008@gmail.com>
 */
package com.taobao.metamorphosis.client.producer;

import javax.transaction.xa.XAResource;

import com.taobao.metamorphosis.exception.MetaClientException;


/**
 * ֧��XA�������Ϣ������
 * 
 * @author boyan
 * 
 */
public interface XAMessageProducer extends MessageProducer {
    public static final String DEFAULT_UNIQUE_QUALIFIER_PREFIX = "XAMessageProducer";


    /**
     * ����һ��XAResource���������������ʹ�øö���������XAMessageProducer���뵽һ���ֲ�ʽ�����С�
     * 
     * @return
     */
    public XAResource getXAResource() throws MetaClientException;


    /**
     * Returns the unique qualifier for this XA producer.The default is
     * "XAMessageProducer-[hostname]".
     * 
     * @return
     */
    public String getUniqueQualifier();


    /**
     * Set the unique qualifier for this producer,it must be unique in global
     * and is not changed after be set.
     */
    public void setUniqueQualifier(String uniqueQualifier);


    /**
     * Set unique qualifier prefix for this message producer,Then the unique
     * qualifier will be "[prefix]-[hostname]".The default prefix is
     * "XAMessageProducer",but recommend you to set an unique qualifier prefix
     * for this producer,such as your application name.
     * 
     * @param prefix
     *            Prefix string for unique qualifier,it will be added in front
     *            of hostname.
     */
    public void setUniqueQualifierPrefix(String prefix);
}