com.samebug.notifier

Class ConfigurationFactory

java.lang.Object

com.samebug.notifier.ConfigurationFactory

public class ConfigurationFactory
extends Object

Configuration parameters of samebug notifier. It contains the following parameters:

• appKey: the application key, mandatory
• version: application version, default is null
• serverURL: url of the recorder, default is http://recorder.samebug.io

Author:

poroszd

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEF_APP_KEY
static String	DEF_DEBUG
static String	DEF_DEVELOPER_KEY
static String	DEF_HELP_MODE
static String	DEF_QUEUE_CAPACITY
static String	DEF_RECORDER_URL
static String	DEF_UI_URL
static String	DEF_VERSION
static String	DEFAULT_PROPERTY_RESOURCE
static String	K_APP_KEY
static String	K_DEBUG
static String	K_DEVELOPER_KEY
static String	K_HELP_MODE
static String	K_QUEUE_CAPACITY
static String	K_RECORDER_URL
static String	K_UI_URL
static String	K_VERSION

Constructor Summary

Constructors

Constructor and Description
ConfigurationFactory()

Method Summary

Modifier and Type	Method and Description
static com.samebug.notifier.core.IConfiguration	fromAppKey(String appKey) Construct a configuration with the specified application key.
static com.samebug.notifier.core.IConfiguration	fromDefault() Factory method of the default configuration.
static com.samebug.notifier.core.IConfiguration	fromProperties(Properties props)
static com.samebug.notifier.core.IConfiguration	fromPropertyFile(String fileName) Factory method to create a configuration based on the content of a property file, given with its absolute path.
static com.samebug.notifier.core.IConfiguration	fromPropertyResource(String resourceName) Factory method to create a configuration based on the content of a resource property file.
static UUID	parseAppKey(String appKey)
static boolean	parseDebug(String debug)
static UUID	parseDeveloperKey(String userKey)
static int	parseHelpMode(String helpMode)
static int	parseQueueCapacity(String queueCapacity)
static URL	parseRecorderURL(String serverAddress)
static URL	parseUIURL(String serverAddress)
static String	parseVersion(String version)

Methods inherited from class java.lang.Object

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

Field Detail

K_APP_KEY

public static final String K_APP_KEY

See Also:

Constant Field Values

K_VERSION

public static final String K_VERSION

See Also:

Constant Field Values

K_RECORDER_URL

public static final String K_RECORDER_URL

See Also:

Constant Field Values

K_DEBUG

public static final String K_DEBUG

See Also:

Constant Field Values

K_UI_URL

public static final String K_UI_URL

See Also:

Constant Field Values

K_DEVELOPER_KEY

public static final String K_DEVELOPER_KEY

See Also:

Constant Field Values

K_HELP_MODE

public static final String K_HELP_MODE

See Also:

Constant Field Values

K_QUEUE_CAPACITY

public static final String K_QUEUE_CAPACITY

See Also:

Constant Field Values

DEF_APP_KEY

public static final String DEF_APP_KEY

DEF_VERSION

public static final String DEF_VERSION

DEF_RECORDER_URL

public static final String DEF_RECORDER_URL

See Also:

Constant Field Values

DEF_DEBUG

public static final String DEF_DEBUG

See Also:

Constant Field Values

DEF_UI_URL

public static final String DEF_UI_URL

See Also:

Constant Field Values

DEF_DEVELOPER_KEY

public static final String DEF_DEVELOPER_KEY

DEF_HELP_MODE

public static final String DEF_HELP_MODE

See Also:

Constant Field Values

DEF_QUEUE_CAPACITY

public static final String DEF_QUEUE_CAPACITY

See Also:

Constant Field Values

DEFAULT_PROPERTY_RESOURCE

public static final String DEFAULT_PROPERTY_RESOURCE

See Also:

Constant Field Values

Constructor Detail

ConfigurationFactory

public ConfigurationFactory()

Method Detail

parseAppKey

public static UUID parseAppKey(String appKey)
                        throws com.samebug.notifier.core.exceptions.BadAppKey

Throws:

com.samebug.notifier.core.exceptions.BadAppKey

parseVersion

public static String parseVersion(String version)

parseRecorderURL

public static URL parseRecorderURL(String serverAddress)
                            throws com.samebug.notifier.core.exceptions.BadServerAddress

Throws:

com.samebug.notifier.core.exceptions.BadServerAddress

parseUIURL

public static URL parseUIURL(String serverAddress)
                      throws com.samebug.notifier.core.exceptions.BadServerAddress

Throws:

com.samebug.notifier.core.exceptions.BadServerAddress

parseDebug

public static boolean parseDebug(String debug)

parseDeveloperKey

public static UUID parseDeveloperKey(String userKey)
                              throws com.samebug.notifier.core.exceptions.BadDeveloperKey

Throws:

com.samebug.notifier.core.exceptions.BadDeveloperKey

parseHelpMode

public static int parseHelpMode(String helpMode)
                         throws com.samebug.notifier.core.exceptions.BadHelpMode

Throws:

com.samebug.notifier.core.exceptions.BadHelpMode

parseQueueCapacity

public static int parseQueueCapacity(String queueCapacity)
                              throws com.samebug.notifier.core.exceptions.BadQueueCapacity

Throws:

com.samebug.notifier.core.exceptions.BadQueueCapacity

fromDefault

public static com.samebug.notifier.core.IConfiguration fromDefault()
                                                            throws com.samebug.notifier.core.exceptions.NoConfigFileException,
                                                                   com.samebug.notifier.core.exceptions.MultipleConfigFileException,
                                                                   com.samebug.notifier.core.exceptions.BadConfigFile,
                                                                   com.samebug.notifier.core.exceptions.BadHelpMode,
                                                                   com.samebug.notifier.core.exceptions.BadServerAddress,
                                                                   com.samebug.notifier.core.exceptions.BadDeveloperKey

Factory method of the default configuration.

This method will build a configuration based on values taken from many location. Each value is assigned in this order:

1. command line property parameter (e.g. -Dsamebug.key=0092029d-6f46-46a8-a65c-3e2dc22e5f0a)
2. content of the file or resource specified on command line (-Dsamebug.config.file=/home/poroszd/my_app/samebug.properties or -Dsamebug.config.resource=my_app.properties), or lack of these, the content of the default samebug property resource (i.e. samebug.properties in the classpath)
3. the default value of the property, if not mandatory

Returns:

a configuration

Throws:

com.samebug.notifier.core.exceptions.NoConfigFileException

com.samebug.notifier.core.exceptions.MultipleConfigFileException

com.samebug.notifier.core.exceptions.BadConfigFile

com.samebug.notifier.core.exceptions.BadHelpMode

com.samebug.notifier.core.exceptions.BadServerAddress

com.samebug.notifier.core.exceptions.BadDeveloperKey

fromPropertyResource

public static com.samebug.notifier.core.IConfiguration fromPropertyResource(String resourceName)
                                                                     throws com.samebug.notifier.core.exceptions.NoConfigFileException,
                                                                            com.samebug.notifier.core.exceptions.MultipleConfigFileException,
                                                                            com.samebug.notifier.core.exceptions.BadConfigFile,
                                                                            com.samebug.notifier.core.exceptions.BadServerAddress,
                                                                            com.samebug.notifier.core.exceptions.BadHelpMode

Factory method to create a configuration based on the content of a resource property file.

Parameters:

resourceName - the name of the resource

Returns:

a configuration

Throws:

com.samebug.notifier.core.exceptions.NoConfigFileException

com.samebug.notifier.core.exceptions.MultipleConfigFileException

com.samebug.notifier.core.exceptions.BadConfigFile

com.samebug.notifier.core.exceptions.BadServerAddress

com.samebug.notifier.core.exceptions.BadHelpMode

fromPropertyFile

public static com.samebug.notifier.core.IConfiguration fromPropertyFile(String fileName)
                                                                 throws com.samebug.notifier.core.exceptions.NoConfigFileException,
                                                                        com.samebug.notifier.core.exceptions.MultipleConfigFileException,
                                                                        com.samebug.notifier.core.exceptions.BadConfigFile,
                                                                        com.samebug.notifier.core.exceptions.BadServerAddress,
                                                                        com.samebug.notifier.core.exceptions.BadHelpMode

Factory method to create a configuration based on the content of a property file, given with its absolute path.

Parameters:

fileName - the name of the file

Returns:

a configuration

Throws:

com.samebug.notifier.core.exceptions.NoConfigFileException

com.samebug.notifier.core.exceptions.MultipleConfigFileException

com.samebug.notifier.core.exceptions.BadConfigFile

com.samebug.notifier.core.exceptions.BadServerAddress

com.samebug.notifier.core.exceptions.BadHelpMode

fromAppKey

public static com.samebug.notifier.core.IConfiguration fromAppKey(String appKey)
                                                           throws com.samebug.notifier.core.exceptions.BadAppKey

Construct a configuration with the specified application key. The other parameters are left on default.

Parameters:

appKey - the key of your registered Samebug application, as found on the documentation site of your app. Must not be null

Returns:

the constructed configuration

Throws:

com.samebug.notifier.core.exceptions.BadHelpMode - when appKey is not parsable as a UUID, or is null

com.samebug.notifier.core.exceptions.BadAppKey

fromProperties

public static com.samebug.notifier.core.IConfiguration fromProperties(Properties props)