| /* |
| * |
| * 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 org.apache.qpid.jms; |
| |
| import java.util.List; |
| |
| import org.apache.qpid.client.BrokerDetails; |
| |
| /** |
| Connection URL format |
| {@literal amqp://[user:pass@][clientid]/virtualhost?brokerlist='tcp://host:port?option=\'value\'&option=\'value\';tcp://host:port/virtualpath?option=\'value\''&failover='method?option=\'value\'&option='value''" } |
| Options are of course optional except for requiring a single broker in the broker list. |
| The option seperator is defined to be either {@literal '&' or ','} |
| */ |
| public interface ConnectionURL |
| { |
| String AMQ_PROTOCOL = "amqp"; |
| String OPTIONS_SYNC_PERSISTENCE = "sync_persistence"; |
| String OPTIONS_MAXPREFETCH = "maxprefetch"; |
| String OPTIONS_SYNC_ACK = "sync_ack"; |
| String OPTIONS_SYNC_CLIENT_ACK = "sync_client_ack"; |
| String OPTIONS_SYNC_PUBLISH = "sync_publish"; |
| String OPTIONS_USE_LEGACY_MAP_MESSAGE_FORMAT = "use_legacy_map_msg_format"; |
| String OPTIONS_USE_LEGACY_STREAM_MESSAGE_FORMAT = "use_legacy_stream_msg_format"; |
| String OPTIONS_BROKERLIST = "brokerlist"; |
| String OPTIONS_FAILOVER = "failover"; |
| String OPTIONS_FAILOVER_CYCLE = "cyclecount"; |
| |
| /** |
| * This option is used to apply a connection level override of |
| * the {@value BrokerDetails#OPTIONS_SSL} option values in the |
| * {@value ConnectionURL#OPTIONS_BROKERLIST}; |
| */ |
| String OPTIONS_SSL = "ssl"; |
| |
| /** |
| * This option is only applicable for 0-8/0-9/0-9-1 protocols connection |
| * <p> |
| * It tells the client to delegate the requeue/DLQ decision to the |
| * server .If this option is not specified, the messages won't be moved to |
| * the DLQ (or dropped) when delivery count exceeds the maximum. |
| */ |
| String OPTIONS_REJECT_BEHAVIOUR = "rejectbehaviour"; |
| |
| /** |
| * <p> |
| * This option is only applicable for 0-8/0-9/0-9-1 protocol connections. |
| * </p> |
| * <p> |
| * It tells the client to request whether the broker should close the |
| * connection when a mandatory message isn't routable, rather than return |
| * the message to the client as it normally would. |
| * </p> |
| */ |
| String OPTIONS_CLOSE_WHEN_NO_ROUTE = "closeWhenNoRoute"; |
| |
| |
| String OPTIONS_COMPRESS_MESSAGES = "compressMessages"; |
| String OPTIONS_MESSAGES_COMPRESSION_THRESHOLD_SIZE = "messageCompressionThresholdSize"; |
| |
| |
| String OPTIONS_DEFAULT_TOPIC_EXCHANGE = "defaultTopicExchange"; |
| String OPTIONS_DEFAULT_QUEUE_EXCHANGE = "defaultQueueExchange"; |
| String OPTIONS_TEMPORARY_TOPIC_EXCHANGE = "temporaryTopicExchange"; |
| String OPTIONS_TEMPORARY_QUEUE_EXCHANGE = "temporaryQueueExchange"; |
| String OPTIONS_VERIFY_QUEUE_ON_SEND = "verifyQueueOnSend"; |
| String OPTIONS_OBJECT_MESSAGE_CLASS_HIERARCHY_WHITE_LIST = "objectMessageClassHierarchyWhiteList"; |
| String OPTIONS_OBJECT_MESSAGE_CLASS_HIERARCHY_BLACK_LIST = "objectMessageClassHierarchyBlackList"; |
| |
| /** |
| * This option specifies whether User-ID should be attached to each message sent over the connection |
| */ |
| String OPTIONS_POPULATE_USER_ID = "populateJMSXUserID"; |
| byte URL_0_8 = 1; |
| byte URL_0_10 = 2; |
| |
| String getURL(); |
| |
| String getFailoverMethod(); |
| |
| String getFailoverOption(String key); |
| |
| int getBrokerCount(); |
| |
| BrokerDetails getBrokerDetails(int index); |
| |
| void addBrokerDetails(BrokerDetails broker); |
| |
| void setBrokerDetails(List<BrokerDetails> brokers); |
| |
| List<BrokerDetails> getAllBrokerDetails(); |
| |
| String getClientName(); |
| |
| void setClientName(String clientName); |
| |
| String getUsername(); |
| |
| void setUsername(String username); |
| |
| String getPassword(); |
| |
| void setPassword(String password); |
| |
| String getVirtualHost(); |
| |
| void setVirtualHost(String virtualHost); |
| |
| String getOption(String key); |
| |
| void setOption(String key, String value); |
| |
| String getDefaultQueueExchangeName(); |
| |
| String getDefaultTopicExchangeName(); |
| |
| String getTemporaryQueueExchangeName(); |
| |
| String getTemporaryTopicExchangeName(); |
| |
| } |