org.diirt.pods.common

Class ChannelTranslator

java.lang.Object

org.diirt.pods.common.ChannelTranslator

public abstract class ChannelTranslator
extends Object

Given a channel name, it translates it to a channel or formula. This allows the server to provide aliases for actual channels or formulas.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ChannelTranslator()

Method Summary

Modifier and Type	Method and Description
static ChannelTranslator	compositeTranslator(List<ChannelTranslator> translators) Creates a channel translator that returns the first successful match from the list of give translators.
static ChannelTranslator	loadTranslator(InputStream input)
static ChannelTranslator	regexTranslator(String regex, String substitution, ChannelTranslation.Permission permission) Creates a channel translator that uses the regex to match the channel and the optional substitution string to perform the translation.
static ChannelTranslator	regexTranslator(String regex, String substitution, ChannelTranslation.Permission permission, Collection<String> allowedUsers) Creates a channel translator that uses the regex to match the channel and the optional substitution string to perform the translation.
abstract ChannelTranslation	translate(ChannelRequest request) Translates the channel request to the actual channel or formula to connect.
ChannelTranslation	translate(String channel) Translates the channel name to the actual channel or formula to connect.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelTranslator

public ChannelTranslator()

Method Detail

translate

public ChannelTranslation translate(String channel)

Translates the channel name to the actual channel or formula to connect.

Parameters:

channel - the incoming channel name

Returns:

the translation; null if the translator can't provide one

translate

public abstract ChannelTranslation translate(ChannelRequest request)

Translates the channel request to the actual channel or formula to connect.

Parameters:

request - the incoming channel request

Returns:

the translation; null if the translator can't provide one

regexTranslator

public static ChannelTranslator regexTranslator(String regex,
                                                String substitution,
                                                ChannelTranslation.Permission permission)

Creates a channel translator that uses the regex to match the channel and the optional substitution string to perform the translation.

Parameters:

regex - a regular expression

substitution - the substitution string; can be null

permission - the permission to enforce on the channel

Returns:

the translator

regexTranslator

public static ChannelTranslator regexTranslator(String regex,
                                                String substitution,
                                                ChannelTranslation.Permission permission,
                                                Collection<String> allowedUsers)

Creates a channel translator that uses the regex to match the channel and the optional substitution string to perform the translation.

Parameters:

regex - a regular expression

substitution - the substitution string; can be null

permission - the permission to enforce on the channel

allowedUsers - the users allowed to access the channel

Returns:

the translator

compositeTranslator

public static ChannelTranslator compositeTranslator(List<ChannelTranslator> translators)

Creates a channel translator that returns the first successful match from the list of give translators.

Parameters:

translators - a list of translators

Returns:

the combined translator

loadTranslator

public static ChannelTranslator loadTranslator(InputStream input)