com.neeve.toa.service
Class ToaServiceChannel

java.lang.Object
  com.neeve.toa.service.ToaServiceChannel

public class ToaServiceChannel
extends Object

Models a Toa Service Channel.

Constructor Summary

ToaServiceChannel(ToaService service, String busName, String name, String key)
Create a new ToaServiceChannel

Method Summary

String	getBusName() Gets the bus name.
Properties	getInitialKRT() Gets the initial key resolution table for this channel.
String	getInitiallyResolvedKey() Gets the key as resolved by initial key resolution.
String	getKey() Gets the channel key.
String	getName() Gets the channel name possibly qualified by prepending the service name in lowercase.
ToaService	getService()
String	getSimpleName() Gets the channel name without it's service name prefix.
void	setBusName(String busName) Sets the busName for this channel.
void	setInitialKRT(Properties initialKRT) Sets the initial key resolution table for this service channel.
void	setInitiallyResolvedKey(String resolvedKey) Sets the key as resolved by the initial key resolution.
void	setKey(String key) Sets the channel key.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToaServiceChannel

public ToaServiceChannel(ToaService service,
                         String busName,
                         String name,
                         String key)

Create a new ToaServiceChannel

Parameters:

name - The channel name.

key - The channel key.

Method Detail

setBusName

public void setBusName(String busName)

Sets the busName for this channel.

Parameters:

busName - The busName.

getBusName

public final String getBusName()

Gets the bus name.

Returns:

The bus name.

getService

public ToaService getService()

Returns:

The service that defined this channel.

getSimpleName

public final String getSimpleName()

Gets the channel name without it's service name prefix.

Returns:

The channel name without the service name prefix.

getName

public final String getName()

Gets the channel name possibly qualified by prepending the service name in lowercase.

For example if the service is 'OrderProcessingService' and the channel name is 'Orders', and the service is set to prefix its channel name, then return 'orderprocessingservice-Orders', otherwise return 'Orders'.

Returns:

The channel name.

getKey

public final String getKey()

Gets the channel key. After a

Returns:

The channel key.

setKey

public final void setKey(String key)

Sets the channel key.

setInitialKRT

public final void setInitialKRT(Properties initialKRT)

Sets the initial key resolution table for this service channel.

An initial KRT can be used to substitute in variable key portions of the channel key.

Parameters:

initialKRT - The Initial KRT.

getInitialKRT

public final Properties getInitialKRT()

Gets the initial key resolution table for this channel.

Gets the initial KRT that was resolved for this channel (if one has been resolved).

Returns:

The initialKRT.

setInitiallyResolvedKey

public void setInitiallyResolvedKey(String resolvedKey)

Sets the key as resolved by the initial key resolution.

This is the key that is used to create the channel with AepEngine which is done after initial key resolution.

This key may still have variable components if initial key resolution didn't resolve all of the variable components.

It may also be the same as the getKey() if initial key resolution didn't result in any variable key component resolution.

Parameters:

resolvedKey - The initial key resolution table resolved key.

getInitiallyResolvedKey

public String getInitiallyResolvedKey()

Gets the key as resolved by initial key resolution.

This is the key that is used to create the channel with AepEngine which is done after initial key resolution. This values can be derived by taking getInitialKRT() and applying it against getKey()

This key may still have variable components if initial key resolution didn't resolve all of the variable components.

It may also be the same as the getKey() if initial key resolution didn't result in any variable key component resolution.

Returns:

The key with initial channel key resolution substitutions.