com.samebug.notifier

Class Configuration

java.lang.Object

com.samebug.notifier.Configuration

public class Configuration
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	DEFAULT_DEBUG
static String	DEFAULT_PROPERTY_RESOURCE
static String	DEFAULT_SERVER

Constructor Summary

Constructors

Constructor and Description
Configuration(String appKey) Construct a configuration with the specified application key.

Method Summary

Methods

Modifier and Type	Method and Description
static Configuration	fromDefault() Factory method to create a configuration with the default values.
static Configuration	fromProperties() Factory method of the default configuration.
static Configuration	fromPropertyFile(String fileName) Factory method to create a configuration based on the content of a property file, given with its absolute path.
static Configuration	fromPropertyResource(String resourceName) Factory method to create a configuration based on the content of a resource property file.
UUID	getAppKey()
boolean	getDebug()
URL	getServerURL()
String	getVersion()
protected static InputStream	openResource(String resourceName)
void	setDebug(String debug) Set if samebug notifier should print debug messages.
void	setServer(String serverAddress) Set your samebug API endpoint.
void	setVersion(String version) Set your application version.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROPERTY_RESOURCE

public static final String DEFAULT_PROPERTY_RESOURCE

See Also:

Constant Field Values

DEFAULT_SERVER

public static final String DEFAULT_SERVER

See Also:

Constant Field Values

DEFAULT_DEBUG

public static final String DEFAULT_DEBUG

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration(String appKey)
              throws 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

Throws:

BadAppKey - when appKey is not parseable as a UUID

Method Detail

setVersion

public void setVersion(String version)

Set your application version.

null means an unspecified version.

Parameters:

version - arbitrary string

setServer

public void setServer(String serverAddress)
               throws BadServerAddress

Set your samebug API endpoint.

Parameters:

serverAddress - an URL string of a samebug server

Throws:

BadServerAddress - when serverAddress is not a valid URL

setDebug

public void setDebug(String debug)

Set if samebug notifier should print debug messages.

Parameters:

debug - "false" disables debug messages, any else string enables it.

getAppKey

public UUID getAppKey()

getVersion

public String getVersion()

getServerURL

public URL getServerURL()

getDebug

public boolean getDebug()

fromProperties

public static Configuration fromProperties()
                                    throws NoConfigFileException,
                                           MultipleConfigFileException,
                                           BadAppKey,
                                           BadServerAddress

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)
3. content of the default samebug property resource (i.e. samebug.properties in the classpath)
4. the default value of the property, if not mandatory

Returns:

a configuration

Throws:

NoConfigFileException

MultipleConfigFileException

BadAppKey

BadServerAddress

fromDefault

public static Configuration fromDefault()
                                 throws NoConfigFileException,
                                        MultipleConfigFileException,
                                        BadAppKey,
                                        BadServerAddress

Factory method to create a configuration with the default values.

Throws:

NoConfigFileException

MultipleConfigFileException

BadAppKey

BadServerAddress

fromPropertyResource

public static Configuration fromPropertyResource(String resourceName)
                                          throws NoConfigFileException,
                                                 MultipleConfigFileException,
                                                 BadServerAddress,
                                                 BadAppKey

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:

NoConfigFileException

MultipleConfigFileException

BadServerAddress

BadAppKey

fromPropertyFile

public static Configuration fromPropertyFile(String fileName)
                                      throws NoConfigFileException,
                                             MultipleConfigFileException,
                                             BadServerAddress,
                                             BadAppKey

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:

NoConfigFileException

MultipleConfigFileException

BadServerAddress

BadAppKey

openResource

protected static InputStream openResource(String resourceName)
                                   throws NoConfigFileException,
                                          MultipleConfigFileException,
                                          IOException

Throws:

NoConfigFileException

MultipleConfigFileException

IOException

toString

public String toString()

Overrides:

toString in class Object