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 long	INVALID_TAG
static java.lang.String	SPY_QUALIFIER Qualifier for spy subscriptions which spy on outgoing network destined traffic efficiently.

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
static java.lang.String	addSessionId(java.lang.String channel, int sessionId) Add a sessionId to a given channel.
java.lang.String	channelTag() Get the channel tag, if it exists, that refers to an another channel.
boolean	containsKey(java.lang.String key) Does the URI contain a value for the given key.
java.lang.String	entityTag() Get the entity tag, if it exists, that refers to an entity such as subscription or publication.
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.
static long	getTag(java.lang.String paramValue) Get the value of the tag from a given parameter value.
void	initialPosition(long position, int initialTermId, int termLength) Initialise a channel for restarting a publication at a given position.
static boolean	isTagged(java.lang.String paramValue) Is the param value tagged? (starts with the "tag:" prefix)
java.lang.String	media() The media over which the channel operates.
ChannelUri	media(java.lang.String media) Set 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.
ChannelUri	prefix(java.lang.String prefix) Change the prefix from what has been parsed.
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	remove(java.lang.String key) Remove a key 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 which spy on outgoing network destined traffic efficiently.

See Also:

Constant Field Values

INVALID_TAG

public static final long INVALID_TAG

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.

prefix

public ChannelUri prefix(java.lang.String prefix)

Change the prefix from what has been parsed.

Parameters:

prefix - to replace the existing prefix.

Returns:

this for a fluent API.

media

public java.lang.String media()

The media over which the channel operates.

Returns:

the media over which the channel operates.

media

public ChannelUri media(java.lang.String media)

Set the media over which the channel operates.

Parameters:

media - to replace the parsed value.

Returns:

this for a fluent API.

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.

remove

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

Remove a key pair in the map of params.

Parameters:

key - of the param to be removed.

Returns:

the previous value of the param or 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.

channelTag

public java.lang.String channelTag()

Get the channel tag, if it exists, that refers to an another channel.

Returns:

channel tag if it exists or null if not in this URI.

See Also:

CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX

entityTag

public java.lang.String entityTag()

Get the entity tag, if it exists, that refers to an entity such as subscription or publication.

Returns:

entity tag if it exists or null if not in this URI.

See Also:

CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX

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.

initialPosition

public void initialPosition(long position,
                            int initialTermId,
                            int termLength)

Initialise a channel for restarting a publication at a given position.

Parameters:

position - at which the publication should be started.

initialTermId - what which the stream would start.

termLength - for the stream.

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.

addSessionId

public static java.lang.String addSessionId(java.lang.String channel,
                                            int sessionId)

Add a sessionId to a given channel.

Parameters:

channel - to add sessionId to.

sessionId - to add to channel.

Returns:

new string that represents channel with sessionId added.

isTagged

public static boolean isTagged(java.lang.String paramValue)

Is the param value tagged? (starts with the "tag:" prefix)

Parameters:

paramValue - to check if tagged.

Returns:

true if tagged or false if not.

See Also:

CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX

getTag

public static long getTag(java.lang.String paramValue)

Get the value of the tag from a given parameter value.

Parameters:

paramValue - to extract the tag value from.

Returns:

the value of the tag or INVALID_TAG if not tagged.

See Also:

CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX