com.samebug.notifier

Class Samebug

java.lang.Object

com.samebug.notifier.Samebug

public class Samebug
extends Object

Static facilities of Samebug.

Author:

poroszd

Constructor Summary

Constructors

Constructor and Description
Samebug()

Method Summary

Modifier and Type	Method and Description
static void	handleUncaughtExceptions() Install a default exception handler on the current thread.
static void	handleUncaughtExceptions(com.samebug.notifier.core.IConfiguration config) Install a default exception handler on the current thread, with the given config
static void	handleUncaughtExceptions(String applicationKey) Install a default exception handler on the current thread, with the given application key.
static void	init() Initialize a singleton notifier instance.
static void	init(com.samebug.notifier.core.IConfiguration config) Initialize a singleton notifier instance.
static void	init(String applicationKey) Initialize a singleton notifier instance.
static com.samebug.notifier.core.IResponse	notify(String message, Throwable throwable) Notify Samebug about an exception
static com.samebug.notifier.core.IResponse	notify(String message, Throwable throwable, Date timestamp) Notify Samebug about an exception
static com.samebug.notifier.core.IResponse	notify(String message, com.samebug.notifier.core.proxy.ThrowableProxy throwableProxy) Notify Samebug about an exception
static com.samebug.notifier.core.IResponse	notify(String message, com.samebug.notifier.core.proxy.ThrowableProxy throwableProxy, Date timestamp) Notify Samebug about an exception

Methods inherited from class java.lang.Object

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

Constructor Detail

Samebug

public Samebug()

Method Detail

handleUncaughtExceptions

public static void handleUncaughtExceptions()
                                     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

Install a default exception handler on the current thread.

In case of any error (properties file not found, multiple file found, wrong format of properties, missing obligatory entries) the constructed notifier will not function as intended.

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

handleUncaughtExceptions

public static void handleUncaughtExceptions(String applicationKey)
                                     throws com.samebug.notifier.core.exceptions.BadHelpMode

Install a default exception handler on the current thread, with the given application key.

Parameters:

applicationKey - the application key

Throws:

com.samebug.notifier.core.exceptions.BadHelpMode

handleUncaughtExceptions

public static void handleUncaughtExceptions(com.samebug.notifier.core.IConfiguration config)

Install a default exception handler on the current thread, with the given config

Parameters:

config - the configuration

init

public static void init()
                 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

Initialize a singleton notifier instance.

Constructs a singleton Samebug Notifier instance using the default configuration.

You only need to use this initialization method if you want to use {Samebugnotify(String, Throwable) explicitly. Only the first call has effect, every consecutive call is practically ignored.

Using explicit notifications is discouraged, one should rather use uncaught exception handler or logger appenders.

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

init

public static void init(String applicationKey)
                 throws com.samebug.notifier.core.exceptions.BadHelpMode

Initialize a singleton notifier instance.

Constructs a singleton Samebug Notifier instance with the given application key.

You only need to use this initialization method if you want to use {Samebugnotify(String, Throwable) explicitly. Only the first call has effect, every consecutive call is practically ignored.

Using explicit notifications is discouraged, one should rather use uncaught exception handler or logger appenders.

Parameters:

applicationKey - the application key

Throws:

com.samebug.notifier.core.exceptions.BadHelpMode

init

public static void init(com.samebug.notifier.core.IConfiguration config)

Initialize a singleton notifier instance.

Constructs a singleton Samebug Notifier instance with the given config.

You only need to use this initialization method if you want to use {Samebugnotify(String, Throwable) explicitly. Only the first call has effect, every consecutive call is practically ignored.

Using explicit notifications is discouraged, one should rather use uncaught exception handler or logger appenders.

Parameters:

config - the configuration

notify

public static com.samebug.notifier.core.IResponse notify(String message,
                                                         Throwable throwable)
                                                  throws com.samebug.notifier.core.exceptions.NotifierException

Notify Samebug about an exception

Parameters:

message - custom message describing the event

throwable - the caught exception

Returns:

the response of Samebug

Throws:

com.samebug.notifier.core.exceptions.NotifierException - when the underlying notifier throws an exception

notify

public static com.samebug.notifier.core.IResponse notify(String message,
                                                         Throwable throwable,
                                                         Date timestamp)
                                                  throws com.samebug.notifier.core.exceptions.NotifierException

Notify Samebug about an exception

Parameters:

message - custom message describing the event

throwable - the caught exception

timestamp - the time of occurrence

Returns:

the response of Samebug

Throws:

com.samebug.notifier.core.exceptions.NotifierException - when the underlying notifier throws an exception

notify

public static com.samebug.notifier.core.IResponse notify(String message,
                                                         com.samebug.notifier.core.proxy.ThrowableProxy throwableProxy)
                                                  throws com.samebug.notifier.core.exceptions.NotifierException

Notify Samebug about an exception

Parameters:

message - custom message describing the event

throwableProxy - proxy for the caught exception

Returns:

the response of Samebug

Throws:

com.samebug.notifier.core.exceptions.NotifierException - when the underlying notifier throws an exception

notify

public static com.samebug.notifier.core.IResponse notify(String message,
                                                         com.samebug.notifier.core.proxy.ThrowableProxy throwableProxy,
                                                         Date timestamp)
                                                  throws com.samebug.notifier.core.exceptions.NotifierException

Notify Samebug about an exception

Parameters:

message - custom message describing the event

throwableProxy - proxy for the caught exception

timestamp - the time of occurrence

Returns:

the response of Samebug

Throws:

com.samebug.notifier.core.exceptions.NotifierException - when the underlying notifier throws an exception