io.aeron

Class ChannelUri

java.lang.Object

io.aeron.ChannelUri

public class ChannelUri
extends java.lang.Object

Parser for Aeron channel URIs. The format is:

 aeron-uri = "aeron:" media [ "?" param *( "|" param ) ]
 media     = *( "[^?:]" )
 param     = key "=" value
 key       = *( "[^=]" )
 value     = *( "[^|]" )
 

Multiple params with the same key are allowed, the last value specified takes precedence.

See Also:

ChannelUriStringBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AERON_SCHEME URI Scheme for Aeron channels.
static java.lang.String	SPY_QUALIFIER Qualifier for spy subscriptions.

Constructor Summary

Constructors

Constructor and Description
ChannelUri(java.lang.String media, java.util.Map<java.lang.String,java.lang.String> params) Construct with the components provided to avoid parsing.
ChannelUri(java.lang.String prefix, java.lang.String media, java.util.Map<java.lang.String,java.lang.String> params) Construct with the components provided to avoid parsing.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Does the URI contain a value for the given key.
java.lang.String	get(java.lang.String key) Get a value for a given parameter key.
java.lang.String	get(java.lang.String key, java.lang.String defaultValue) Get the value for a given parameter key or the default value provided if the key does not exist.
java.lang.String	media() The media over which the channel operates.
static ChannelUri	parse(java.lang.CharSequence cs) Parse a CharSequence which contains an Aeron URI.
java.lang.String	prefix() The prefix for the channel.
java.lang.String	put(java.lang.String key, java.lang.String value) Put a key and value pair in the map of params.
java.lang.String	scheme() The scheme for the URI.
java.lang.String	toString() Generate a String representation of the URI that is valid for an Aeron channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AERON_SCHEME

public static final java.lang.String AERON_SCHEME

URI Scheme for Aeron channels.

See Also:

Constant Field Values

SPY_QUALIFIER

public static final java.lang.String SPY_QUALIFIER

Qualifier for spy subscriptions.

See Also:

Constant Field Values

Constructor Detail

ChannelUri

public ChannelUri(java.lang.String prefix,
                  java.lang.String media,
                  java.util.Map<java.lang.String,java.lang.String> params)

Construct with the components provided to avoid parsing.

Parameters:

prefix - empty if no prefix is required otherwise expected to be 'aeron-spy'

media - for the channel which is typically "udp" or "ipc".

params - for the query string as key value pairs.

ChannelUri

public ChannelUri(java.lang.String media,
                  java.util.Map<java.lang.String,java.lang.String> params)

Construct with the components provided to avoid parsing.

Parameters:

media - for the channel which is typically "udp" or "ipc".

params - for the query string as key value pairs.

Method Detail

prefix

public java.lang.String prefix()

The prefix for the channel.

Returns:

the prefix for the channel.

media

public java.lang.String media()

The media over which the channel operates.

Returns:

the media over which the channel operates.

scheme

public java.lang.String scheme()

The scheme for the URI. Must be "aeron".

Returns:

the scheme for the URI.

get

public java.lang.String get(java.lang.String key)

Get a value for a given parameter key.

Parameters:

key - to lookup.

Returns:

the value if set for the key otherwise null.

get

public java.lang.String get(java.lang.String key,
                            java.lang.String defaultValue)

Get the value for a given parameter key or the default value provided if the key does not exist.

Parameters:

key - to lookup.

defaultValue - to be returned if no key match is found.

Returns:

the value if set for the key otherwise the default value provided.

put

public java.lang.String put(java.lang.String key,
                            java.lang.String value)

Put a key and value pair in the map of params.

Parameters:

key - of the param to be put.

value - of the param to be put.

Returns:

the existing value otherwise null.

containsKey

public boolean containsKey(java.lang.String key)

Does the URI contain a value for the given key.

Parameters:

key - to be lookup.

Returns:

true if the key has a value otherwise false.

toString

public java.lang.String toString()

Generate a String representation of the URI that is valid for an Aeron channel.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the URI that is valid for an Aeron channel.

parse

public static ChannelUri parse(java.lang.CharSequence cs)

Parse a CharSequence which contains an Aeron URI.

Parameters:

cs - to be parsed.

Returns:

a new ChannelUri representing the URI string.