com.bloomberg.bmq

Class Uri

java.lang.Object

com.bloomberg.bmq.Uri

@Immutable
public class Uri
extends Object

Provides value-semantic type and utilities for a BlazingMQ queue URI.

This class provides a value-semantic type, representing a URI for a BlazingMQ queue. A Uri can be built by parsing from a string representation provided to the class constructor.

URI format

In a nutshell, a URI representing an application queue managed by a BlazingMQ broker on a given machine looks like one of the following:

  bmq://ts.trades.myapp/my.queue
  bmq://ts.trades.myapp.~bt/my.queue
  bmq://ts.trades.myapp/my.queue?id=foo
 

where:

• The URI scheme is always "bmq".
• The URI authority is the name of BlazingMQ domain (such as "ts.trades.myapp") as registered with the BlazingMQ infrastructure. The domain name may contain alphanumeric characters, dots and dashes (it has to match the following regular expression: [-a-zA-Z0-9\\._]+'. The domain may be followed by an optional tier, introduced by the ".~" sequence and consisting of alphanumeric characters and dashes. The ".~" sequence is not part of the tier.
• The URI path is the name of the queue ("my.queue" above) and may contain alphanumeric characters, dashes, underscores and tild (it has to match the following regular expression: [-a-zA-Z0-9_~\\.]+).
• The name of the queue (my.queue above) may contain alphanumeric characters and dots.
• The URI may contain an optional query with a key-value pair, where key is always id, and corresponding value represents a name that will be used by BlazingMQ broker to uniquely identify the client.
• The URI fragment part is currently unused.

Usage Example

Instantiate a Uri object with a string representation of the URI:

  Uri uri = new Uri("bmq://my.domain/queue");
  assert uri.scheme() == "bmq";
  assert uri.domain() == "my.domain";
  assert uri.queue()  == "queue";
 

Thread Safety

Once created Uri object is immutable and thread safe.

Constructor Summary

Constructors

Constructor and Description
Uri(String uriStr) Constructs this object from the specified uri string.

Method Summary

Modifier and Type	Method and Description
String	authority() Returns authority part of the URI in terms of the URI RFC terminology.
String	canonical() Returns the canonical form of the URI.
String	domain() Returns domain part of the URI in terms of the BlazingMQ terminology.
boolean	equals(Object obj) Returns true if this Uri is equal to the specified obj, false otherwise.
int	hashCode() Returns a hash code value for this Uri object.
String	id() Returns id part of the URI in terms of the BlazingMQ terminology.
String	path() Returns path part of the URI in terms of the URI RFC terminology.
String	qualifiedDomain() Returns qualifiedDomain part of the URI in terms of the BlazingMQ terminology.
String	queue() Returns queue part of the URI in terms of the BlazingMQ terminology.
String	scheme() Returns scheme part of the URI in terms of the URI RFC terminology.
String	tier() Returns tier part of the URI in terms of the BlazingMQ terminology.
String	toString() Returns a string representation of the URI.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Uri

public Uri(String uriStr)

Constructs this object from the specified uri string. If the uri input string doesn't represent a valid URI, this object won't be created.

Parameters:

uriStr - string representation of the URI

Throws:

RuntimeException - if the specified string is not a valid URI

Method Detail

scheme

public String scheme()

Returns scheme part of the URI in terms of the URI RFC terminology.

Returns:

String scheme part of the URI

authority

public String authority()

Returns authority part of the URI in terms of the URI RFC terminology.

Returns:

String authority part of the URI

path

public String path()

Returns path part of the URI in terms of the URI RFC terminology.

Returns:

String path part of the URI

qualifiedDomain

public String qualifiedDomain()

Returns qualifiedDomain part of the URI in terms of the BlazingMQ terminology.

Returns:

String qualifiedDomain part of the URI

domain

public String domain()

Returns domain part of the URI in terms of the BlazingMQ terminology.

Returns:

String domain part of the URI

tier

public String tier()

Returns tier part of the URI in terms of the BlazingMQ terminology.

Returns:

String tier part of the URI

queue

public String queue()

Returns queue part of the URI in terms of the BlazingMQ terminology.

Returns:

String queue part of the URI

id

public String id()

Returns id part of the URI in terms of the BlazingMQ terminology.

Returns:

String id part of the URI

canonical

public String canonical()

Returns the canonical form of the URI.

Note that canonical form includes everything except the query part of the URI.

Returns:

String canonical form of the URI except query part

toString

public String toString()

Returns a string representation of the URI.

Overrides:

toString in class Object

Returns:

String string representation of the URI

equals

public boolean equals(Object obj)

Returns true if this Uri is equal to the specified obj, false otherwise.

Overrides:

equals in class Object

Parameters:

obj - Uri object to compare with

Returns:

boolean true if Uri are equal, false otherwise

hashCode

public int hashCode()

Returns a hash code value for this Uri object.

Overrides:

hashCode in class Object

Returns:

int a hash code value for this object.