com.stackmob.sdkapi
Class ConfigVarService

java.lang.Object
  com.stackmob.sdkapi.ConfigVarService

public abstract class ConfigVarService
extends Object

ConfigVarService allows you to access config vars, which are information from third party modules, usually authentication credentials, that let you interact with their services.

Constructor Summary

ConfigVarService()

Method Summary

abstract String	get(String key) Get the config var for the given key.
abstract String	get(String key, String moduleName) Get the config var for the given key and module.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigVarService

public ConfigVarService()

Method Detail

get

public abstract String get(String key)
                    throws ConfigVarServiceException

Get the config var for the given key. This method is only usable from module code, and gets config vars for the current module.

Parameters:

key - the key to lookup

Returns:

the value associated with that key or null

Throws:

ConfigVarServiceException - if the config vars can't be reached

get

public abstract String get(String key,
                           String moduleName)
                    throws ConfigVarServiceException

Get the config var for the given key and module. This method is only usable from app custom code, and can load config vars for any module. Use this to get the information you need to access third-party module services from your app's custom code to write custom logic or mashups.

Parameters:

key - the key to lookup. You can find the names of config vars in the dashboard page for each module.

moduleName - find the module name in the url of the dashboard page for each module

Returns:

the value associated with that key or null

Throws:

ConfigVarServiceException - if the config vars can't be reached