Examples of org.apache.qpid.qmf2.util.ConnectionHelper

org.apache.qpid.qmf2.common.SchemaClassId

.apache.org/qpid/url-format-proposal.html"> New URL format for AMQP + Qpid

AMQP 0-10 format

C++ uses the AMQP 0-10 format: section 9.1.2 as follows:

 amqp_url       = "amqp:" prot_addr_list prot_addr_list = [prot_addr ","]* prot_addr prot_addr      = tcp_prot_addr | tls_prot_addr tcp_prot_addr  = tcp_id tcp_addr tcp_id         = "tcp:" | "" tcp_addr       = [host [":" port] ] host           = <as per rfc3986> port           = number

The AMQP 0-10 format only provides protocol address information for a (list of) brokers.

Python tool BrokerURL format

The Python tools bundled with Qpid such as qpid-config use a "BrokerURL" format with the following Address syntax:

 [<user>/<pass>@]<hostname> | <ip-address>[:<port>]

Qpid M4 Java Connection URL format

The Qpid M4 Java format provides additional options for connection options (user, password, vhost etc.) Documentation for this format may be found here: Qpid M4 Java Connection URL Format

Java ConnectionURLs look like this:

 amqp://[<user>:<pass>@][<clientid>]/<virtualhost>[?<option>='<value>'[&<option>='<value>']]

This syntax is very powerful, but it can also be fairly complex to work with, especially when one realises that one of the options in the above syntax is brokerlist='<broker url>' where broker url is itself a URL of the format:

 <transport>://<host>[:<port>][?<option>='<value>'[&<option>='<value>']]

so one may see ConnectionURLs that look like:

 amqp://guest:guest@clientid/test?brokerlist='tcp://localhost:5672?retries='10'&connectdelay='1000''

Extended AMQP 0-10 URL format

There is a proposal to extend the AMQP 0-10 URL syntax to include user:pass@ style authentication information, virtual host and extensible name/value options. It also makes the implied extension points of the original grammar more explicit.

 amqp_url        = "amqp://" [ userinfo "@" ] addr_list [ vhost ] addr_list       = addr *( "," addr ) addr            = prot_addr [ options ] prot_addr       = tcp_prot_addr | other_prot_addr vhost           = "/" *pchar [ options ] tcp_prot_addr   = tcp_id tcp_addr tcp_id          = "tcp:" / ""	; tcp is the default tcp_addr        = [ host [ ":" port ] ] other_prot_addr = other_prot_id ":" *pchar other_prot_id   = scheme options         = "?" option *( ";" option ) option          = name "=" value name            = *pchar value           = *pchar

Incompatibility with AMQP 0-10 format

This syntax is backward compatible with AMQP 0-10 with one exception: AMQP 0-10 did not have an initial // after amqp: The justification was that that the // form is only used for URIs with hierarchical structure

However it's been pointed out that in fact the URL does already specify a 1-level hierarchy of address / vhost. In the future the hierarchy could be extended to address objects within a vhost such as queues, exchanges etc. So this proposal adopts amqp:// syntax.

It's easy to write a backward-compatible parser by relaxing the grammar as follows:

 amqp_url = "amqp:" [ "//" ] [ userinfo "@" ] addr_list [ vhost ]

Differences from Qpid M4 Java Connection URL format

Addresses are at the start of the URL rather than in the "brokerlist" option.

Option format is ?foo=bar;x=y rather than ?foo='bar'&x='y'. The use of "'" quotes is not common for URI query strings. The use of "&" as a separator creates problems

user, pass and clientid are options rather than having a special place at the front of the URL. clientid is a Qpid proprietary property and user/pass are not relevant in all authentication schemes.

Qpid M4 Java URLs requires the brokerlist option, so this is an easy way to detect a Qpid M4 URL vs. an Extended AMQP 0-10 URL and parse accordingly.

Options

Some of the URL forms are fairly limited in terms of options, so it is useful to be able to pass options as an additional string, though it's important to note that if multiple brokers are supplied in the AMQP 0.10 format the same options will be applied to all brokers.

The option format is the same as that of the C++ qpid::messaging Connection class. for example: "{reconnect: true, tcp-nodelay: true}":

option name	value type	semantics
`maxprefetch`	integer	The maximum number of pre-fetched messages per destination.
`sync_publish`	{'persistent' \| 'all'}	A sync command is sent after every persistent message to guarantee that it has been received; if the value is 'persistent', this is done only for persistent messages.
`sync_ack`	boolean	A sync command is sent after every acknowledgement to guarantee that it has been received.
`use_legacy_map_msg_format`	boolean	If you are using JMS Map messages and deploying a new client with any JMS client older than 0.8 release, you must set this to true to ensure the older clients can understand the map message encoding.
`failover`	{'roundrobin' \| 'singlebroker' \| 'nofailover' \| 'failover_exchange'}	If roundrobin is selected it will try each broker given in the broker list. If failover_exchange is selected it connects to the initial broker given in the broker URL and will receive membership updates via the failover exchange.
`cyclecount`	integer	For roundrobin failover cyclecount is the number of times to loop through the list of available brokers before failure.
`username`	string	The username to use when authenticating to the broker.
`password`	string	The password to use when authenticating to the broker.
`sasl_mechanisms`	string	The specific SASL mechanisms to use when authenticating to the broker. The value is a space separated list.
`sasl_mechs`	string	The specific SASL mechanisms to use when authenticating to the broker. The value is a space separated is a space separated list. This is simply a synonym for sasl_mechanisms above
`sasl_encryption`	boolean	If `sasl_encryption='true'`, the JMS client attempts to negotiate a security layer with the broker using GSSAPI to encrypt the connection. Note that for this to happen, GSSAPI must be selected as the sasl_mech.
`ssl`	boolean	If `ssl='true'`, the JMS client will encrypt the connection using SSL.
`reconnect`	boolean	Transparently reconnect if the connection is lost.
`reconnect_timeout`	integer	Total number of seconds to continue reconnection attempts before giving up and raising an exception.
`reconnect_limit`	integer	Maximum number of reconnection attempts before giving up and raising an exception.
`reconnect_interval_min`	integer representing time in seconds	Minimum number of seconds between reconnection attempts. The first reconnection attempt is made immediately; if that fails, the first reconnection delay is set to the value of `reconnect_interval_min`; if that attempt fails, the reconnect interval increases exponentially until a reconnection attempt succeeds or `reconnect_interval_max` is reached.
`reconnect_interval_max`	integer representing time in seconds	Maximum reconnect interval.
`reconnect_interval`	integer representing time in seconds	Sets both `reconnection_interval_min` and `reconnection_interval_max` to the same value. The default value is 5 seconds
`heartbeat`	integer representing time in seconds	Requests that heartbeats be sent every N seconds. If two successive heartbeats are missed the connection is considered to be lost.
`protocol`	string	Sets the underlying protocol used. The default option is 'tcp'. To enable ssl, set to 'ssl'. The C++ client additionally supports 'rdma'.
`tcp-nodelay`	boolean	Set tcp no-delay, i.e. disable Nagle algorithm.
`sasl_protocol`	string	Used only for Kerberos. `sasl_protocol` must be set to the principal for the qpidd broker, e.g. `qpidd/`
`sasl_server`	string	For Kerberos, sasl_mechs must be set to GSSAPI, `sasl_server` must be set to the host for the SASL server, e.g. `sasl.com.`
`trust_store`	string	path to Keberos trust store
`trust_store_password`	string	Kerberos trust store password
`key_store_password`	string	Kerberos key store password
`ssl_cert_alias`	string	If multiple certificates are present in the keystore, the alias will be used to extract the correct certificate.

Other features of this class

Whilst it is generally the norm to use JNDI to specify Connections, Destinations etc. it is also often quite useful to specify Connections programmatically, for example when writing a tool one may wish to specify the broker via the command line to enable the tool to connect to different broker instances. To facilitate this this class provides a basic createConnection() method that takes a URL and returns a JMS Connection. @author Fraser Adams

     * <p>
     * I <i>believe</i> that there should only be one entry in the list returned when looking up a specific chema by classId.
     */
    public List<SchemaClass> getSchema(final SchemaClassId classId)
    {
        SchemaClass schema = _schemaCache.get(classId);
        if (schema == SchemaClass.EMPTY_SCHEMA)
        {
            return Collections.emptyList();
        }

View Full Code Here

    }


    public void addObject(QmfAgentData object) throws QmfException
    {
        SchemaClassId classId = object.getSchemaClassId();
        SchemaClass schema = _schemaCache.get(classId);


        // Try to create an objectName using the set of property names that have been specified as idNames in the schema
        StringBuilder buf = new StringBuilder();
        if (schema != null && schema instanceof SchemaObjectClass)
        {

View Full Code Here

                {
                    List<Map> mapResults = AMQPMessage.getList(response);
                    for (Map content : mapResults)
                    {
//new SchemaClassId(content).listValues();
                        results.add(new SchemaClassId(content));
                    }
                }
                else if (AMQPMessage.isAMQPMap(response))
                {
                    // Error responses are returned as MapMessages, though they are being ignored here.

View Full Code Here

     * @param className the schema class name we're looking up objects for.
     * @return a List of QMF Objects describing that class.
     */
    public List<QmfConsoleData> getObjects(final String className)
    {
        return getObjects(new SchemaClassId(className));
    }

View Full Code Here

     * @param timeout overrides the default replyTimeout.
     * @return a List of QMF Objects describing that class.
     */
    public List<QmfConsoleData> getObjects(final String className, final int timeout)
    {
        return getObjects(new SchemaClassId(className), timeout);
    }

View Full Code Here

     * @param agentList if this parameter is supplied then the query is sent to only those Agents.
     * @return a List of QMF Objects describing that class.
     */
    public List<QmfConsoleData> getObjects(final String className, final List<Agent> agentList)
    {
        return getObjects(new SchemaClassId(className), agentList);
    }

View Full Code Here

     * @param agentList if this parameter is supplied then the query is sent to only those Agents.
     * @return a List of QMF Objects describing that class.
     */
    public List<QmfConsoleData> getObjects(final String className, final int timeout, final List<Agent> agentList)
    {
        return getObjects(new SchemaClassId(className), timeout, agentList);
    }

View Full Code Here

     * @param className the schema class name we're looking up objects for.
     * @return a List of QMF Objects describing that class
     */
    public List<QmfConsoleData> getObjects(final String packageName, final String className)
    {
        return getObjects(new SchemaClassId(packageName, className));
    }

View Full Code Here

     * @param timeout overrides the default replyTimeout.
     * @return a List of QMF Objects describing that class.
     */
    public List<QmfConsoleData> getObjects(final String packageName, final String className, final int timeout)
    {
        return getObjects(new SchemaClassId(packageName, className), timeout);
    }

View Full Code Here

     * @param agentList if this parameter is supplied then the query is sent to only those Agents.
     * @return a List of QMF Objects describing that class.
     */
    public List<QmfConsoleData> getObjects(final String packageName, final String className, final List<Agent> agentList)
    {
        return getObjects(new SchemaClassId(packageName, className), agentList);
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.qpid.qmf2.util.ConnectionHelper

org.apache.qpid.messaging.util.AddressParser

org.apache.qpid.qmf2.agent.Agent

org.apache.qpid.qmf2.agent.AgentExternal

org.apache.qpid.qmf2.agent.MethodCallParams

org.apache.qpid.qmf2.agent.MethodCallWorkItem

org.apache.qpid.qmf2.agent.QmfAgentData

org.apache.qpid.qmf2.agent.SubscriptionParams

org.apache.qpid.qmf2.common.Handle

org.apache.qpid.qmf2.common.NotifierWrapper

org.apache.qpid.qmf2.common.NullQmfEventListener

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.