summaryrefslogtreecommitdiff
path: root/trunk/qpid/java/common/src/main/java/org/apache/qpid/BrokerDetails.java
blob: 63f67a78578024f206cb91930be30cd0c43d9498 (plain)
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/* 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;

import java.util.Map;

/**
 * This interface represents a broker and provides the basic information
 * required for opening a connection with a broker.
 */
public interface BrokerDetails
{
    /**
     * Those are the supported protocols
     */
    public static final String PROTOCOL_TCP = "tcp";
    public static final String PROTOCOL_TLS = "tls";
    
    public static final String VIRTUAL_HOST = "virtualhost";
    public static final String CLIENT_ID = "client_id";
    public static final String USERNAME = "username";
    public static final String PASSWORD = "password";

    /**
     * Get the broker host name.
     *
     * @return The broker host name.
     */
    public String getHost();

    /**
     * Get the broker port number.
     *
     * @return The broker port number.
     */
    public int getPort();

    /**
     * Get the virtual host to connect to.
     *
     * @return The virtual host of this broker.
     */
    public String getVirtualHost();

    /**
     * Get the user name.
     *
     * @return The user name
     */
    public String getUserName();

    /**
     * Get the user password
     *
     * @return The user password
     */
    public String getPassword();

    /**
     * Get the protocol used to connect to hise broker.
     *
     * @return the protocol used to connect to the broker.
     */
    public String getProtocol();

    /**
     * Set the broker host name.
     *
     * @param host The broker host name.
     */
    public void setHost(String host);

    /**
     * Set the broker port number.
     *
     * @param port The broker port number.
     */
    public void setPort(int port);

    /**
     * Set the virtual host to connect to.
     *
     * @param virtualHost The virtual host of this broker.
     */
    public void setVirtualHost(String virtualHost);

    /**
     * Set the user name.
     *
     * @param userName The user name
     */
    public void setUserName(String userName);

    /**
     * Set the user password
     *
     * @param password The user password
     */
    public void setPassword(String password);

    /**
     * Set the protocol used to connect to hise broker.
     *
     * @param protocol the protocol used to connect to the broker.
     */
    public void setProtocol(String protocol);
    
    /**
     * Ex: keystore path
     * 
     * @return the Properties associated with this connection.
     */
    public Map<String,String> getProperties();
    
    /**
     * Sets the properties associated with this connection
     * 
     * @param props the new p[roperties. 
     */
    public void setProperties(Map<String,String> props);
    
    public void setProperty(String key,String value);
}