info.textgrid.lab.conf.client

Class ConfClient

java.lang.Object

info.textgrid.lab.conf.client.ConfClient

public class ConfClient
extends Object

Client for the configuration service. In order to

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENDPOINT The default value for the endpoint preference.
protected static String	ENV_ENDPOINT_VAR Environment variable to override the endpoint (e.g, for automatted tests).
static String	EXPECTED_API_VERSION
static String	PREF_ENDPOINT The preference string for the configuration endpoint
static String	REAL_DEFAULT_ENDPOINT The default value for the endpoint preference that is actually used.

Method Summary

Modifier and Type	Method and Description
static void	addApiChangedListener(Listener l)
static String	computePreferredEndpoint() Returns the preferred EPR for the configuration service.
String	getEndpoint() The EndPoint currently in use.
static ConfClient	getInstance()
String	getValue(String key) Returns the value for the given configuration variable
String	getValue(String key, Boolean force) Deprecated.
protected void	notifyApiChangedListeners(Event event)
void	refresh()
static void	removeApiChangedListener(Listener l)
static void	setProxySelector()

Methods inherited from class java.lang.Object

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

Field Detail

EXPECTED_API_VERSION

public static String EXPECTED_API_VERSION

PREF_ENDPOINT

public static final String PREF_ENDPOINT

The preference string for the configuration endpoint

See Also:

Constant Field Values

DEFAULT_ENDPOINT

public static final String DEFAULT_ENDPOINT

The default value for the endpoint preference. Users can override this (also persistently) via the preferences dialog.

See Also:

Constant Field Values

REAL_DEFAULT_ENDPOINT

public static final String REAL_DEFAULT_ENDPOINT

The default value for the endpoint preference that is actually used. Normally, this is equal to DEFAULT_ENDPOINT, but for testing purposes and experimental versions this can be changed. There will be a warning message in the welcome screen.

See Also:

Constant Field Values

ENV_ENDPOINT_VAR

protected static final String ENV_ENDPOINT_VAR

Environment variable to override the endpoint (e.g, for automatted tests). If this environment variable is set, its value will be used as an endpoint and the value of the preference as well as the DEFAULT_ENDPOINT will be ignored.

See Also:

Constant Field Values

Method Detail

computePreferredEndpoint

public static String computePreferredEndpoint()

Returns the preferred EPR for the configuration service. Tries

1. the environment variable "TEXTGRIDLAB_CONFSERV"
2. the preference setting "endpoint" in
3. A default value.

until it finds something not "" or null. This does not invalidate something or need network access.

getEndpoint

public String getEndpoint()

The EndPoint currently in use. Might be "" if not yet determined.

getInstance

public static ConfClient getInstance()
                              throws OfflineException

Throws:

OfflineException

getValue

public String getValue(String key)
                throws OfflineException

Returns the value for the given configuration variable

Parameters:

key - the variable name, see ConfservClientConstants

Returns:

the value

Throws:

OfflineException

getValue

@Deprecated
public String getValue(String key,
                                   Boolean force)
                            throws OfflineException

Deprecated.

Returns the value for the given configuration variable

Parameters:

key - the variable name, see ConfservClientConstants

force - if true, the value is retrieved from the server, otherwise we may use a cached value

Returns:

the value

Throws:

OfflineException

refresh

public void refresh()
             throws OfflineException

Throws:

OfflineException

addApiChangedListener

public static void addApiChangedListener(Listener l)

removeApiChangedListener

public static void removeApiChangedListener(Listener l)

notifyApiChangedListeners

protected void notifyApiChangedListeners(Event event)

setProxySelector

public static void setProxySelector()