com.communote.server.api.core.common

Class ClientAndChannelContextHolder

java.lang.Object

com.communote.server.api.core.common.ClientAndChannelContextHolder

public abstract class ClientAndChannelContextHolder
extends Object

Holder which associates the client and channel execution contexts with the current thread.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
ClientAndChannelContextHolder()

Method Summary

Modifier and Type	Method and Description
static void	clear() Remove the stored information for the current thread.
static ChannelType	getChannel()
static ChannelType	getChannel(ChannelType fallback) Return the channel associated with the current thread or the given fallback if no channel was set.
static ClientTO	getClient()
static void	setChannel(ChannelType channelType) Associate the channel with the current thread
static void	setClient(ClientTO client) Set the client on which the operations of the current thread should be run

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientAndChannelContextHolder

public ClientAndChannelContextHolder()

Method Detail

clear

public static void clear()

Remove the stored information for the current thread.

getChannel

public static ChannelType getChannel()

Returns:

the channel associated with the current thread. Can be null.

getChannel

public static ChannelType getChannel(ChannelType fallback)

Return the channel associated with the current thread or the given fallback if no channel was set.

Parameters:

fallback - the fallback to return if no channel is set

Returns:

the current channel or the fallback

getClient

public static ClientTO getClient()

Returns:

the client on which all operations of the current thread are run. A return value of null has to be treated as the global client execution context.

setChannel

public static void setChannel(ChannelType channelType)

Associate the channel with the current thread

Parameters:

channelType - the channel execution CONTEXT

setClient

public static void setClient(ClientTO client)

Set the client on which the operations of the current thread should be run

Parameters:

client - the client execution CONTEXT