com.communote.server.core.common.velocity.tools

Class ClientTool

java.lang.Object

com.communote.server.core.common.velocity.tools.ClientTool

public class ClientTool
extends Object

Tool for clients.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ClientTool()

Method Summary

Modifier and Type	Method and Description
String	getClientName(String clientId) Get the name of a client.
String	getProperty(String property)
boolean	getProperty(String property, Boolean fallback)
String	getProperty(String property, String fallback)
String	getServerId()
boolean	isGlobalClient()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientTool

public ClientTool()

Method Detail

getClientName

public String getClientName(String clientId)

Get the name of a client.

Parameters:

clientId - the ID of the client whose name should be returned. Can be null get the name of the current client.

Returns:

the name of the client or null if the client does not exist

getProperty

public String getProperty(String property)

Parameters:

property - The property.

Returns:

The property or null if not set.

getProperty

public boolean getProperty(String property,
                           Boolean fallback)

Parameters:

property - The property.

fallback - The fallback.

Returns:

The property as boolean, with the given fallback.

getProperty

public String getProperty(String property,
                          String fallback)

Parameters:

property - The property.

fallback - The fallback.

Returns:

The property as string, with the given fallback.

getServerId

public String getServerId()

Returns:

The current server id.

isGlobalClient

public boolean isGlobalClient()

Returns:

True, if the current client is the global client.