com.communote.server.persistence.user.client

Class ClientHelper

java.lang.Object

com.communote.server.persistence.user.client.ClientHelper

public final class ClientHelper
extends Object

The Class ClientHelper contains helper methods for the client id management.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GLOBAL_CLIENT_ID The Constant DEFAULT_GLOBAL_CLIENT_ID defines the default id for the global client.

Method Summary

Modifier and Type	Method and Description
static void	assertIsCurrentClientGlobal()
static String	createUniqueClientId() Creates a (worldwide) unique ID to be used as unique identifier for a client.
static ClientTO	getClient(String clientId) Get the details of a client that has the given ID.
static Timestamp	getCreationDate()
static ClientTO	getCurrentClient() Get the client that is associated with the current thread.
static String	getCurrentClientId() Get the ID of the client which is associated with the current thread.
static Locale	getDefaultLanguage() Return the default language defined in the client configuration properties
static String	getGlobalClientId() Return the ID of the global client.
static boolean	isClientGlobal(ClientTO client) Checks if the given client is the global client.
static boolean	isClientGlobal(String clientId) Checks if the given ID is the ID of the global client
static boolean	isCurrentClientGlobal() Checks if the current client is global.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GLOBAL_CLIENT_ID

public static final String DEFAULT_GLOBAL_CLIENT_ID

The Constant DEFAULT_GLOBAL_CLIENT_ID defines the default id for the global client.

See Also:

Constant Field Values

Method Detail

assertIsCurrentClientGlobal

public static void assertIsCurrentClientGlobal()
                                        throws AuthorizationException

Throws:

AuthorizationException - Thrown, when the current client is not the global client.

createUniqueClientId

public static String createUniqueClientId()

Creates a (worldwide) unique ID to be used as unique identifier for a client.

Returns:

the unique client ID

getClient

public static ClientTO getClient(String clientId)

Get the details of a client that has the given ID.

Parameters:

clientId - the ID of the client

Returns:

the client details or null if the application is not initialized, the clientId was null or the client does not exist

getCreationDate

public static Timestamp getCreationDate()

Returns:

Timestamp of the creation date of the current client.

getCurrentClient

public static ClientTO getCurrentClient()

Get the client that is associated with the current thread. If there is no client bound to the thread and the application is initialized, that is CommunoteRuntime#isInitialized() returns true, the global client will be returned. Otherwise null is returned.

Returns:

the current client, or null if no client is bound to this thread and the application is not initialized

getCurrentClientId

public static String getCurrentClientId()

Get the ID of the client which is associated with the current thread. If no client is associated with the current thread the ID of the global client is returned. The latter will lead to an exception if called before the start of the Communote runtime.

Returns:

the ID of the current client

getDefaultLanguage

public static Locale getDefaultLanguage()

Return the default language defined in the client configuration properties

Returns:

default locale

getGlobalClientId

public static String getGlobalClientId()

Return the ID of the global client. An exception will be thrown if called before the start of the Communote runtime.

Returns:

the ID of the global client

isClientGlobal

public static boolean isClientGlobal(ClientTO client)

Checks if the given client is the global client.

Parameters:

client - the client. Can be null.

Returns:

true if the client is the global client or the argument was null

isClientGlobal

public static boolean isClientGlobal(String clientId)

Checks if the given ID is the ID of the global client

Parameters:

clientId - the ID of the client to test. Can be null.

Returns:

true if the ID belongs to the global client or the argument was null

isCurrentClientGlobal

public static boolean isCurrentClientGlobal()

Checks if the current client is global.

Returns:

true, if the current client is global